Updated imported docs with ./update-imported-docs.sh

This commit is contained in:
Maciej Szulik
2016-10-24 19:02:37 +02:00
parent de27c5c194
commit b506e647f3
101 changed files with 20638 additions and 3296 deletions
+1 -1
View File
@@ -82,7 +82,7 @@ kubectl
* [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable
* [kubectl version](kubectl_version.md) - Print the client and server version information
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+27 -6
View File
@@ -16,11 +16,32 @@ It is intended to store non-identifying auxiliary data, especially data manipula
If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error.
If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
Possible resources include (case insensitive):
pod (po), service (svc), replicationcontroller (rc),
node (no), event (ev), componentstatuse (cs),
limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc),
horizontalpodautoscaler (hpa), resourcequota (quota), secret
Valid resource types include:
* clusters (valid only for federation apiservers)
* componentstatuses (aka 'cs')
* configmaps (aka 'cm')
* daemonsets (aka 'ds')
* deployments (aka 'deploy')
* events (aka 'ev')
* endpoints (aka 'ep')
* horizontalpodautoscalers (aka 'hpa')
* ingress (aka 'ing')
* jobs
* limitranges (aka 'limits')
* nodes (aka 'no')
* namespaces (aka 'ns')
* petsets (alpha feature, may be unstable)
* pods (aka 'po')
* persistentvolumes (aka 'pv')
* persistentvolumeclaims (aka 'pvc')
* quota
* resourcequotas (aka 'quota')
* replicasets (aka 'rs')
* replicationcontrollers (aka 'rc')
* secrets
* serviceaccounts (aka 'sa')
* services (aka 'svc')
```
kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
@@ -100,7 +121,7 @@ kubectl annotate pods foo description-
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl api-versions
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -72,7 +72,7 @@ cat pod.json | kubectl apply -f -
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -66,7 +66,7 @@ kubectl attach 123456-7890 -c ruby-container -i -t
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -1
View File
@@ -21,6 +21,7 @@ kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MA
### Examples
```
# Auto scale a deployment "foo", with the number of pods between 2 and 10, target CPU utilization specified so a default autoscaling policy will be used:
kubectl autoscale deployment foo --min=2 --max=10
@@ -80,7 +81,7 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -50,7 +50,7 @@ kubectl cluster-info
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -75,7 +75,7 @@ kubectl cluster-info dump --namespaces default,kube-system --output-directory=/p
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -68,7 +68,7 @@ $ source <(kubectl completion zsh)
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -54,7 +54,7 @@ kubectl config SUBCOMMAND
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -52,7 +52,7 @@ kubectl config current-context
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl config delete-cluster NAME
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl config delete-context NAME
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl config get-clusters
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -60,7 +60,7 @@ kubectl config get-contexts my-context
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -66,7 +66,7 @@ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -58,7 +58,7 @@ kubectl config set-context gce --user=cluster-admin
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -89,7 +89,7 @@ kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provide
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -52,7 +52,7 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -45,7 +45,7 @@ kubectl config unset PROPERTY_NAME
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl config use-context CONTEXT_NAME
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -73,7 +73,7 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -87,7 +87,7 @@ kubectl convert -f . | kubectl create -f -
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -54,7 +54,7 @@ kubectl cordon foo
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -70,7 +70,7 @@ cat pod.json | kubectl create -f -
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -87,7 +87,7 @@ kubectl create configmap my-config --from-literal=key1=config1 --from-literal=ke
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -70,7 +70,7 @@ kubectl create deployment my-dep --image=busybox
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -69,7 +69,7 @@ kubectl create namespace my-namespace
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -73,7 +73,7 @@ kubectl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scop
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl create secret
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -85,7 +85,7 @@ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -88,7 +88,7 @@ kubectl create secret generic my-secret --from-literal=key1=supersecret --from-l
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -73,7 +73,7 @@ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.k
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -43,7 +43,7 @@ kubectl create service
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -74,7 +74,7 @@ kubectl create service clusterip my-cs --clusterip="None"
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -70,7 +70,7 @@ kubectl create service loadbalancer my-lbs --tcp=5678:8080
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -70,7 +70,7 @@ kubectl create service nodeport my-ns --tcp=5678:8080
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -70,7 +70,7 @@ $ kubectl create serviceaccount my-service-account
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -2
View File
@@ -62,7 +62,7 @@ kubectl delete pods --all
-o, --output string Output mode. Use "-o name" for shorter output (resource/name).
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
-l, --selector string Selector (label query) to filter on.
--timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
--timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object (default 0s)
```
### Options inherited from parent commands
@@ -94,7 +94,7 @@ kubectl delete pods --all
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -113,7 +113,7 @@ kubectl describe pods frontend
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+4 -4
View File
@@ -12,13 +12,13 @@ Drain node in preparation for maintenance
Drain node in preparation for maintenance.
The given node will be marked unschedulable to prevent new pods from arriving.
The `drain` deletes all pods except mirror pods (which cannot be deleted through
Then drain deletes all pods except mirror pods (which cannot be deleted through
the API server). If there are DaemonSet-managed pods, drain will not proceed
without --ignore-daemonsets, and regardless it will not delete any
DaemonSet-managed pods, because those pods would be immediately replaced by the
DaemonSet controller, which ignores unschedulable markings. If there are any
pods that are neither mirror pods nor managed by ReplicationController,
ReplicaSet, DaemonSet or Job, then drain will not delete any pods unless you
pods that are neither mirror pods nor managed--by ReplicationController,
ReplicaSet, DaemonSet or Job--, then drain will not delete any pods unless you
use --force.
When you are ready to put the node back into service, use kubectl uncordon, which
@@ -81,7 +81,7 @@ $ kubectl drain foo --grace-period=900
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -91,7 +91,7 @@ kubectl edit svc/docker-registry --output-version=v1 -o json
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -67,7 +67,7 @@ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -89,7 +89,7 @@ kubectl explain pods.spec.containers
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -2
View File
@@ -20,7 +20,7 @@ labels are specified, the new service will re-use the labels from the resource i
Possible resources include (case insensitive):
pod (po), service (svc), replicationcontroller (rc),
deployment, replicaset (rs)
deployment (deploy), replicaset (rs)
```
@@ -112,7 +112,7 @@ kubectl expose deployment nginx --port=80 --target-port=8000
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -4
View File
@@ -12,7 +12,6 @@ Display one or many resources
Display one or many resources.
Valid resource types include:
* clusters (valid only for federation apiservers)
* componentstatuses (aka 'cs')
* configmaps (aka 'cm')
@@ -69,9 +68,7 @@ kubectl get -o json pod web-pod-13je7
kubectl get -f pod.yaml -o json
# Return only the phase value of the specified pod.
{% raw %}
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
{% endraw %}
# List all replication controllers and services together in ps output format.
kubectl get rc,services
@@ -132,7 +129,7 @@ kubectl get rc/web service/frontend pods/web-pod-13je7
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -93,7 +93,7 @@ kubectl label pods foo bar-
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -2
View File
@@ -42,7 +42,7 @@ kubectl logs --since=1h nginx
--include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
--limit-bytes int Maximum bytes of logs to return. Defaults to no limit.
-p, --previous If true, print the logs for the previous instance of the container in a pod if it exists.
--since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used.
--since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. (default 0s)
--since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
--tail int Lines of recent log file to display. Defaults to -1, showing all log lines. (default -1)
--timestamps Include timestamps on each line in the log output
@@ -77,7 +77,7 @@ kubectl logs --since=1h nginx
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -43,7 +43,7 @@ kubectl namespace [namespace]
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -43,7 +43,7 @@ kubectl options
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -85,7 +85,7 @@ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -66,7 +66,7 @@ kubectl port-forward mypod 0:5000
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -91,7 +91,7 @@ kubectl proxy --api-prefix=/k8s-api
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -2
View File
@@ -51,7 +51,7 @@ kubectl replace --force -f ./pod.json
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
--schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
--timeout duration Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
--timeout duration Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). (default 0s)
--validate If true, use a schema to validate the input before sending it (default true)
```
@@ -84,7 +84,7 @@ kubectl replace --force -f ./pod.json
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -15,6 +15,9 @@ Replaces the specified replication controller with a new replication controller
new PodTemplate. The new-controller.json must specify the same namespace as the
existing replication controller and overwrite at least one (common) label in its replicaSelector.
![Workflow](http://kubernetes.io/images/docs/kubectl_rollingupdate.svg)
```
kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)
```
@@ -95,7 +98,7 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -52,7 +52,7 @@ kubectl rollout undo deployment/abc
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -63,7 +63,7 @@ kubectl rollout history deployment/abc --revision=3
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -65,7 +65,7 @@ kubectl rollout pause deployment/nginx
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -63,7 +63,7 @@ kubectl rollout resume deployment/nginx
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -59,7 +59,7 @@ kubectl rollout status deployment/nginx
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
@@ -63,7 +63,7 @@ kubectl rollout undo deployment/abc --to-revision=3
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -122,7 +122,7 @@ kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -2
View File
@@ -51,7 +51,7 @@ kubectl scale --replicas=3 job/cron
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--replicas int The new desired number of replicas. Required. (default -1)
--resource-version string Precondition for resource version. Requires that the current resource version match this value in order to scale.
--timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
--timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). (default 0s)
```
### Options inherited from parent commands
@@ -83,7 +83,7 @@ kubectl scale --replicas=3 job/cron
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -46,7 +46,7 @@ kubectl set SUBCOMMAND
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+2 -2
View File
@@ -12,7 +12,7 @@ Update image of a pod template
Update existing container image(s) of resources.
Possible resources include (case insensitive):
pod (po), replicationcontroller (rc), deployment, daemonset (ds), job, replicaset (rs)
pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)
```
kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N
@@ -82,7 +82,7 @@ kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -83,7 +83,7 @@ kubectl taint nodes foo dedicated-
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -46,7 +46,7 @@ kubectl top
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -63,7 +63,7 @@ kubectl top node NODE_NAME
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -74,7 +74,7 @@ kubectl top pod -l name=myLabel
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -54,7 +54,7 @@ $ kubectl uncordon foo
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016
+1 -1
View File
@@ -49,7 +49,7 @@ kubectl version
###### Auto generated by spf13/cobra on 2-Sep-2016
###### Auto generated by spf13/cobra on 24-Oct-2016