diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index 58a7a597e1..f78d83e0fe 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 96ff1dba87..15dbc758f8 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index ba6c6d132c..9f985b2709 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index e0e98b429a..c7202db697 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index a4b0e5d098..2526f40a01 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -1,31 +1,5 @@ - - - - -WARNING -WARNING -WARNING -WARNING -WARNING - -

PLEASE NOTE: This document applies to the HEAD of the source tree

- -If you are using a released version of Kubernetes, you should -refer to the docs that go with that version. - -Documentation for other releases can be found at -[releases.k8s.io](http://releases.k8s.io). - --- - - - - +--- +--- ## kubelet diff --git a/docs/api-reference/extensions/v1beta1/definitions.md b/docs/api-reference/extensions/v1beta1/definitions.md index 11c1979822..8811f7dfb0 100644 --- a/docs/api-reference/extensions/v1beta1/definitions.md +++ b/docs/api-reference/extensions/v1beta1/definitions.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/api-reference/extensions/v1beta1/operations.md b/docs/api-reference/extensions/v1beta1/operations.md index 2dcbfcc11e..fdd4c98e8b 100644 --- a/docs/api-reference/extensions/v1beta1/operations.md +++ b/docs/api-reference/extensions/v1beta1/operations.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/api-reference/v1/definitions.md b/docs/api-reference/v1/definitions.md index edd3b92e62..639bcee984 100644 --- a/docs/api-reference/v1/definitions.md +++ b/docs/api-reference/v1/definitions.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/api-reference/v1/operations.md b/docs/api-reference/v1/operations.md index 4318964a18..619116336b 100644 --- a/docs/api-reference/v1/operations.md +++ b/docs/api-reference/v1/operations.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl copy/.files_generated b/docs/user-guide/kubectl copy/.files_generated new file mode 100644 index 0000000000..dc33265971 --- /dev/null +++ b/docs/user-guide/kubectl copy/.files_generated @@ -0,0 +1,35 @@ +kubectl.md +kubectl_apply.md +kubectl_annotate.md +kubectl_api-versions.md +kubectl_attach.md +kubectl_cluster-info.md +kubectl_config.md +kubectl_config_set-cluster.md +kubectl_config_set-context.md +kubectl_config_set-credentials.md +kubectl_config_set.md +kubectl_config_unset.md +kubectl_config_use-context.md +kubectl_config_view.md +kubectl_convert.md +kubectl_create.md +kubectl_delete.md +kubectl_describe.md +kubectl_edit.md +kubectl_exec.md +kubectl_explain.md +kubectl_expose.md +kubectl_get.md +kubectl_label.md +kubectl_logs.md +kubectl_namespace.md +kubectl_patch.md +kubectl_port-forward.md +kubectl_proxy.md +kubectl_replace.md +kubectl_rolling-update.md +kubectl_run.md +kubectl_scale.md +kubectl_stop.md +kubectl_version.md diff --git a/docs/user-guide/kubectl copy/kubectl.md b/docs/user-guide/kubectl copy/kubectl.md new file mode 100644 index 0000000000..03b00d62cf --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl.md @@ -0,0 +1,94 @@ + + + + + +## kubectl + +kubectl controls the Kubernetes cluster manager + +### Synopsis + + +kubectl controls the Kubernetes cluster manager. + +Find more information at https://github.com/kubernetes/kubernetes. + +``` +kubectl +``` + +### Options + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl annotate](kubectl_annotate.md) - Update the annotations on a resource +* [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version". +* [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin +* [kubectl attach](kubectl_attach.md) - Attach to a running container. +* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a deployment or replication controller +* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl convert](kubectl_convert.md) - Convert config files between different API versions +* [kubectl cordon](kubectl_cordon.md) - Mark node as unschedulable +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin +* [kubectl delete](kubectl_delete.md) - Delete resources by filenames, stdin, resources and names, or by resources and label selector. +* [kubectl describe](kubectl_describe.md) - Show details of a specific resource or group of resources +* [kubectl drain](kubectl_drain.md) - Drain node in preparation for maintenance +* [kubectl edit](kubectl_edit.md) - Edit a resource on the server +* [kubectl exec](kubectl_exec.md) - Execute a command in a container. +* [kubectl explain](kubectl_explain.md) - Documentation of resources. +* [kubectl expose](kubectl_expose.md) - Take a replication controller, service or pod and expose it as a new Kubernetes Service +* [kubectl get](kubectl_get.md) - Display one or many resources +* [kubectl label](kubectl_label.md) - Update the labels on a resource +* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod. +* [kubectl namespace](kubectl_namespace.md) - SUPERSEDED: Set and view the current Kubernetes namespace +* [kubectl patch](kubectl_patch.md) - Update field(s) of a resource using strategic merge patch. +* [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod. +* [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server +* [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin. +* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController. +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment +* [kubectl run](kubectl_run.md) - Run a particular image on the cluster. +* [kubectl scale](kubectl_scale.md) - Set a new size for a Replication Controller, Job, or Deployment. +* [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 19-Jan-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_annotate.md b/docs/user-guide/kubectl copy/kubectl_annotate.md new file mode 100644 index 0000000000..aefb0ce00d --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_annotate.md @@ -0,0 +1,114 @@ + + + + + +## kubectl annotate + +Update the annotations on a resource + +### Synopsis + + +Update the annotations on one or more resources. + +An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data. +It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions. +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): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +horizontalpodautoscalers (hpa), resourcequotas (quota) or secrets. + +``` +kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version] +``` + +### Examples + +``` +# Update pod 'foo' with the annotation 'description' and the value 'my frontend'. +# If the same annotation is set multiple times, only the last value will be applied +kubectl annotate pods foo description='my frontend' + +# Update a pod identified by type and name in "pod.json" +kubectl annotate -f pod.json description='my frontend' + +# Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value. +kubectl annotate --overwrite pods foo description='my frontend running nginx' + +# Update all pods in the namespace +kubectl annotate pods --all description='my frontend running nginx' + +# Update pod 'foo' only if the resource is unchanged from version 1. +kubectl annotate pods foo description='my frontend running nginx' --resource-version=1 + +# Update pod 'foo' by removing an annotation named 'description' if it exists. +# Does not require the --overwrite flag. +kubectl annotate pods foo description- +``` + +### Options + +``` + --all[=false]: select all resources in the namespace of the specified resource types + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the annotation + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --overwrite[=false]: If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. + --record[=false]: Record current kubectl command in the resource annotation. + --resource-version="": If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. + -l, --selector="": Selector (label query) to filter on + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_annotate.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_api-versions.md b/docs/user-guide/kubectl copy/kubectl_api-versions.md new file mode 100644 index 0000000000..3e7843d81f --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_api-versions.md @@ -0,0 +1,62 @@ + + + + + +## kubectl api-versions + +Print the supported API versions on the server, in the form of "group/version". + +### Synopsis + + +Print the supported API versions on the server, in the form of "group/version". + +``` +kubectl api-versions +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_api-versions.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_apply.md b/docs/user-guide/kubectl copy/kubectl_apply.md new file mode 100644 index 0000000000..a422fed5dd --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_apply.md @@ -0,0 +1,85 @@ + + + + + +## kubectl apply + +Apply a configuration to a resource by filename or stdin + +### Synopsis + + +Apply a configuration to a resource by filename or stdin. +The resource will be created if it doesn't exist yet. + +JSON and YAML formats are accepted. + +``` +kubectl apply -f FILENAME +``` + +### Examples + +``` +# Apply the configuration in pod.json to a pod. +kubectl apply -f ./pod.json + +# Apply the JSON passed into stdin to a pod. +cat pod.json | kubectl apply -f - +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to file that contains the configuration to apply + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + --record[=false]: Record current kubectl command in the resource annotation. + --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_apply.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_attach.md b/docs/user-guide/kubectl copy/kubectl_attach.md new file mode 100644 index 0000000000..5ca5f15e06 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_attach.md @@ -0,0 +1,84 @@ + + + + + +## kubectl attach + +Attach to a running container. + +### Synopsis + + +Attach to a process that is already running inside an existing container. + +``` +kubectl attach POD -c CONTAINER +``` + +### Examples + +``` +# Get output from running pod 123456-7890, using the first container by default +kubectl attach 123456-7890 + +# Get output from ruby-container from pod 123456-7890 +kubectl attach 123456-7890 -c ruby-container + +# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 +# and sends stdout/stderr from 'bash' back to the client +kubectl attach 123456-7890 -c ruby-container -i -t +``` + +### Options + +``` + -c, --container="": Container name. If omitted, the first container in the pod will be chosen + -i, --stdin[=false]: Pass stdin to the container + -t, --tty[=false]: Stdin is a TTY +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_attach.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_autoscale.md b/docs/user-guide/kubectl copy/kubectl_autoscale.md new file mode 100644 index 0000000000..d8d6746c85 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_autoscale.md @@ -0,0 +1,96 @@ + + + + + +## kubectl autoscale + +Auto-scale a deployment or replication controller + +### Synopsis + + +Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. + +Looks up a deployment or replication controller by name and creates an autoscaler that uses this deployment or replication controller as a reference. +An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. + +``` +kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags] +``` + +### Examples + +``` +# Auto scale a deployment "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: +kubectl autoscale deployment foo --min=2 --max=10 + +# Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80%: +kubectl autoscale rc foo --max=5 --cpu-percent=80 +``` + +### Options + +``` + --cpu-percent=-1: The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, the server will apply a default value. + --dry-run[=false]: If true, only print the object that would be sent, without creating it. + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to autoscale. + --generator="horizontalpodautoscaler/v1beta1": The name of the API generator to use. Currently there is only 1 generator. + --max=-1: The upper limit for the number of pods that can be set by the autoscaler. Required. + --min=-1: The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. + --name="": The name for the newly created object. If not specified, the name of the input resource will be used. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --record[=false]: Record current kubectl command in the resource annotation. + --save-config[=false]: 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. + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_autoscale.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_cluster-info.md b/docs/user-guide/kubectl copy/kubectl_cluster-info.md new file mode 100644 index 0000000000..f96f3f5651 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_cluster-info.md @@ -0,0 +1,62 @@ + + + + + +## kubectl cluster-info + +Display cluster info + +### Synopsis + + +Display addresses of the master and services with label kubernetes.io/cluster-service=true + +``` +kubectl cluster-info +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config.md b/docs/user-guide/kubectl copy/kubectl_config.md new file mode 100644 index 0000000000..c93c02c21e --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config.md @@ -0,0 +1,81 @@ + + + + + +## kubectl config + +config modifies kubeconfig files + +### Synopsis + + +config modifies kubeconfig files using subcommands like "kubectl config set current-context my-context" + +The loading order follows these rules: + 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. + 2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged together. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. + 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place. + + +``` +kubectl config SUBCOMMAND +``` + +### Options + +``` + --kubeconfig="": use a particular kubeconfig file +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl config current-context](kubectl_config_current-context.md) - Displays the current-context +* [kubectl config set](kubectl_config_set.md) - Sets an individual value in a kubeconfig file +* [kubectl config set-cluster](kubectl_config_set-cluster.md) - Sets a cluster entry in kubeconfig +* [kubectl config set-context](kubectl_config_set-context.md) - Sets a context entry in kubeconfig +* [kubectl config set-credentials](kubectl_config_set-credentials.md) - Sets a user entry in kubeconfig +* [kubectl config unset](kubectl_config_unset.md) - Unsets an individual value in a kubeconfig file +* [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file +* [kubectl config view](kubectl_config_view.md) - Displays merged kubeconfig settings or a specified kubeconfig file. + +###### Auto generated by spf13/cobra on 9-Jan-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_current-context.md b/docs/user-guide/kubectl copy/kubectl_config_current-context.md new file mode 100644 index 0000000000..24d14ec0b5 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_current-context.md @@ -0,0 +1,69 @@ + + + + + +## kubectl config current-context + +Displays the current-context + +### Synopsis + + +Displays the current-context + +``` +kubectl config current-context +``` + +### Examples + +``` +# Display the current-context +kubectl config current-context +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_current-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_set-cluster.md b/docs/user-guide/kubectl copy/kubectl_config_set-cluster.md new file mode 100644 index 0000000000..70a0998f1b --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_set-cluster.md @@ -0,0 +1,82 @@ + + + + + +## kubectl config set-cluster + +Sets a cluster entry in kubeconfig + +### Synopsis + + +Sets a cluster entry in kubeconfig. +Specifying a name that already exists will merge new fields on top of existing values for those fields. + +``` +kubectl config set-cluster NAME [--server=server] [--certificate-authority=path/to/certficate/authority] [--api-version=apiversion] [--insecure-skip-tls-verify=true] +``` + +### Examples + +``` +# Set only the server field on the e2e cluster entry without touching other values. +kubectl config set-cluster e2e --server=https://1.2.3.4 + +# Embed certificate authority data for the e2e cluster entry +kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt + +# Disable cert checking for the dev cluster entry +kubectl config set-cluster e2e --insecure-skip-tls-verify=true +``` + +### Options + +``` + --api-version="": api-version for the cluster entry in kubeconfig + --certificate-authority="": path to certificate-authority for the cluster entry in kubeconfig + --embed-certs[=false]: embed-certs for the cluster entry in kubeconfig + --insecure-skip-tls-verify[=false]: insecure-skip-tls-verify for the cluster entry in kubeconfig + --server="": server for the cluster entry in kubeconfig +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-cluster.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_set-context.md b/docs/user-guide/kubectl copy/kubectl_config_set-context.md new file mode 100644 index 0000000000..c122465657 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_set-context.md @@ -0,0 +1,75 @@ + + + + + +## kubectl config set-context + +Sets a context entry in kubeconfig + +### Synopsis + + +Sets a context entry in kubeconfig +Specifying a name that already exists will merge new fields on top of existing values for those fields. + +``` +kubectl config set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace] +``` + +### Examples + +``` +# Set the user field on the gce context entry without touching other values +kubectl config set-context gce --user=cluster-admin +``` + +### Options + +``` + --cluster="": cluster for the context entry in kubeconfig + --namespace="": namespace for the context entry in kubeconfig + --user="": user for the context entry in kubeconfig +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_set-credentials.md b/docs/user-guide/kubectl copy/kubectl_config_set-credentials.md new file mode 100644 index 0000000000..0c4985af90 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_set-credentials.md @@ -0,0 +1,95 @@ + + + + + +## kubectl config set-credentials + +Sets a user entry in kubeconfig + +### Synopsis + + +Sets a user entry in kubeconfig +Specifying a name that already exists will merge new fields on top of existing values. + + Client-certificate flags: + --client-certificate=certfile --client-key=keyfile + + Bearer token flags: + --token=bearer_token + + Basic auth flags: + --username=basic_user --password=basic_password + + Bearer token and basic auth are mutually exclusive. + + +``` +kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] +``` + +### Examples + +``` +# Set only the "client-key" field on the "cluster-admin" +# entry, without touching other values: +kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key + +# Set basic auth for the "cluster-admin" entry +kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif + +# Embed client certificate data in the "cluster-admin" entry +kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true +``` + +### Options + +``` + --client-certificate="": path to client-certificate for the user entry in kubeconfig + --client-key="": path to client-key for the user entry in kubeconfig + --embed-certs[=false]: embed client cert/key for the user entry in kubeconfig + --password="": password for the user entry in kubeconfig + --token="": token for the user entry in kubeconfig + --username="": username for the user entry in kubeconfig +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --user="": The name of the kubeconfig user to use + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-credentials.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_set.md b/docs/user-guide/kubectl copy/kubectl_config_set.md new file mode 100644 index 0000000000..165a4dcd1e --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_set.md @@ -0,0 +1,64 @@ + + + + + +## kubectl config set + +Sets an individual value in a kubeconfig file + +### Synopsis + + +Sets an individual value in a kubeconfig file +PROPERTY_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. +PROPERTY_VALUE is the new value you wish to set. + +``` +kubectl config set PROPERTY_NAME PROPERTY_VALUE +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_unset.md b/docs/user-guide/kubectl copy/kubectl_config_unset.md new file mode 100644 index 0000000000..9bbf3d9f5e --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_unset.md @@ -0,0 +1,63 @@ + + + + + +## kubectl config unset + +Unsets an individual value in a kubeconfig file + +### Synopsis + + +Unsets an individual value in a kubeconfig file +PROPERTY_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. + +``` +kubectl config unset PROPERTY_NAME +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_unset.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_use-context.md b/docs/user-guide/kubectl copy/kubectl_config_use-context.md new file mode 100644 index 0000000000..ce35581a0e --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_use-context.md @@ -0,0 +1,62 @@ + + + + + +## kubectl config use-context + +Sets the current-context in a kubeconfig file + +### Synopsis + + +Sets the current-context in a kubeconfig file + +``` +kubectl config use-context CONTEXT_NAME +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_use-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_config_view.md b/docs/user-guide/kubectl copy/kubectl_config_view.md new file mode 100644 index 0000000000..829a45f79f --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_config_view.md @@ -0,0 +1,90 @@ + + + + + +## kubectl config view + +Displays merged kubeconfig settings or a specified kubeconfig file. + +### Synopsis + + +Displays merged kubeconfig settings or a specified kubeconfig file. + +You can use --output jsonpath={...} to extract specific values using a jsonpath expression. + +``` +kubectl config view +``` + +### Examples + +``` +# Show Merged kubeconfig settings. +kubectl config view + +# Get the password for the e2e user +kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' +``` + +### Options + +``` + --flatten[=false]: flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files) + --merge[=true]: merge together the full hierarchy of kubeconfig files + --minify[=false]: remove all information not used by current-context from the output + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --raw[=false]: display raw byte data + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": use a particular kubeconfig file + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_view.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_convert.md b/docs/user-guide/kubectl copy/kubectl_convert.md new file mode 100644 index 0000000000..d4a6d0bf9a --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_convert.md @@ -0,0 +1,102 @@ + + + + + +## kubectl convert + +Convert config files between different API versions + +### Synopsis + + +Convert config files between different API versions. Both YAML +and JSON formats are accepted. + +The command takes filename, directory, or URL as input, and convert it into format +of version specified by --output-version flag. If target version is not specified or +not supported, convert to latest version. + +The default output will be printed to stdout in YAML format. One can use -o option +to change to output destination. + + +``` +kubectl convert -f FILENAME +``` + +### Examples + +``` +# Convert 'pod.yaml' to latest version and print to stdout. +kubectl convert -f pod.yaml + +# Convert the live state of the resource specified by 'pod.yaml' to the latest version +# and print to stdout in json format. +kubectl convert -f pod.yaml --local -o json + +# Convert all files under current directory to latest version and create them all. +kubectl convert -f . | kubectl create -f - + +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to file to need to get converted. + --local[=true]: If true, convert will NOT try to contact api-server but run locally. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_convert.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_cordon.md b/docs/user-guide/kubectl copy/kubectl_cordon.md new file mode 100644 index 0000000000..4b610189c2 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_cordon.md @@ -0,0 +1,71 @@ + + + + + +## kubectl cordon + +Mark node as unschedulable + +### Synopsis + + +Mark node as unschedulable. + + +``` +kubectl cordon NODE +``` + +### Examples + +``` +# Mark node "foo" as unschedulable. +kubectl cordon foo + +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cordon.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create.md b/docs/user-guide/kubectl copy/kubectl_create.md new file mode 100644 index 0000000000..6a7a677285 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create.md @@ -0,0 +1,89 @@ + + + + + +## kubectl create + +Create a resource by filename or stdin + +### Synopsis + + +Create a resource by filename or stdin. + +JSON and YAML formats are accepted. + +``` +kubectl create -f FILENAME +``` + +### Examples + +``` +# Create a pod using the data in pod.json. +kubectl create -f ./pod.json + +# Create a pod based on the JSON passed into stdin. +cat pod.json | kubectl create -f - +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to file to use to create the resource + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + --record[=false]: Record current kubectl command in the resource annotation. + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl create configmap](kubectl_create_configmap.md) - Create a configMap from a local file, directory or literal value. +* [kubectl create namespace](kubectl_create_namespace.md) - Create a namespace with the specified name. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. +* [kubectl create serviceaccount](kubectl_create_serviceaccount.md) - Create a service account with the specified name. + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create_configmap.md b/docs/user-guide/kubectl copy/kubectl_create_configmap.md new file mode 100644 index 0000000000..abee69541f --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create_configmap.md @@ -0,0 +1,104 @@ + + + + + +## kubectl create configmap + +Create a configMap from a local file, directory or literal value. + +### Synopsis + + +Create a configmap based on a file, directory, or specified literal value. + +A single configmap may package one or more key/value pairs. + +When creating a configmap based on a file, the key will default to the basename of the file, and the value will +default to the file content. If the basename is an invalid key, you may specify an alternate key. + +When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be +packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, +symlinks, devices, pipes, etc). + + +``` +kubectl create configmap NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run] +``` + +### Examples + +``` + # Create a new configmap named my-config with keys for each file in folder bar + kubectl create configmap generic my-config --from-file=path/to/bar + + # Create a new configmap named my-config with specified keys instead of names on disk + kubectl create configmap generic my-config --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub + + # Create a new configMap named my-config with key1=config1 and key2=config2 + kubectl create configmap generic my-config --from-literal=key1=config1 --from-literal=key2=config2 +``` + +### Options + +``` + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --from-file=[]: Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. + --from-literal=[]: Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) + --generator="configmap/v1": The name of the API generator to use. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_configmap.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create_namespace.md b/docs/user-guide/kubectl copy/kubectl_create_namespace.md new file mode 100644 index 0000000000..e4b6f8a0db --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create_namespace.md @@ -0,0 +1,87 @@ + + + + + +## kubectl create namespace + +Create a namespace with the specified name. + +### Synopsis + + + +Create a namespace with the specified name. + +``` +kubectl create namespace NAME [--dry-run] +``` + +### Examples + +``` + # Create a new namespace named my-namespace + kubectl create namespace my-namespace +``` + +### Options + +``` + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --generator="namespace/v1": The name of the API generator to use. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_namespace.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create_secret.md b/docs/user-guide/kubectl copy/kubectl_create_secret.md new file mode 100644 index 0000000000..e6f768032d --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create_secret.md @@ -0,0 +1,64 @@ + + + + + +## kubectl create secret + +Create a secret using specified subcommand. + +### Synopsis + + +Create a secret using specified subcommand. + +``` +kubectl create secret +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin +* [kubectl create secret docker-registry](kubectl_create_secret_docker-registry.md) - Create a secret for use with a Docker registry. +* [kubectl create secret generic](kubectl_create_secret_generic.md) - Create a secret from a local file, directory or literal value. + +###### Auto generated by spf13/cobra on 14-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create_secret_docker-registry.md b/docs/user-guide/kubectl copy/kubectl_create_secret_docker-registry.md new file mode 100644 index 0000000000..439f9c4635 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create_secret_docker-registry.md @@ -0,0 +1,102 @@ + + + + + +## kubectl create secret docker-registry + +Create a secret for use with a Docker registry. + +### Synopsis + + + +Create a new secret for use with Docker registries. + +Dockercfg secrets are used to authenticate against Docker registries. + +When using the Docker command line to push images, you can authenticate to a given registry by running + 'docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'. +That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to +authenticate to the registry. + +When creating applications, you may have a Docker registry that requires authentication. In order for the +nodes to pull images on your behalf, they have to have the credentials. You can provide this information +by creating a dockercfg secret and attaching it to your service account. + +``` +kubectl create secret docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run] +``` + +### Examples + +``` + # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: + $ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL +``` + +### Options + +``` + --docker-email="": Email for Docker registry + --docker-password="": Password for Docker registry authentication + --docker-server="https://index.docker.io/v1/": Server location for Docker registry + --docker-username="": Username for Docker registry authentication + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --generator="secret-for-docker-registry/v1": The name of the API generator to use. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. + +###### Auto generated by spf13/cobra on 14-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create_secret_generic.md b/docs/user-guide/kubectl copy/kubectl_create_secret_generic.md new file mode 100644 index 0000000000..8e421d67e0 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create_secret_generic.md @@ -0,0 +1,106 @@ + + + + + +## kubectl create secret generic + +Create a secret from a local file, directory or literal value. + +### Synopsis + + + +Create a secret based on a file, directory, or specified literal value. + +A single secret may package one or more key/value pairs. + +When creating a secret based on a file, the key will default to the basename of the file, and the value will +default to the file content. If the basename is an invalid key, you may specify an alternate key. + +When creating a secret based on a directory, each file whose basename is a valid key in the directory will be +packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, +symlinks, devices, pipes, etc). + + +``` +kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run] +``` + +### Examples + +``` + # Create a new secret named my-secret with keys for each file in folder bar + kubectl create secret generic my-secret --from-file=path/to/bar + + # Create a new secret named my-secret with specified keys instead of names on disk + kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub + + # Create a new secret named my-secret with key1=supersecret and key2=topsecret + kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret +``` + +### Options + +``` + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --from-file=[]: Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. + --from-literal=[]: Specify a key and literal value to insert in secret (i.e. mykey=somevalue) + --generator="secret/v1": The name of the API generator to use. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --type="": The type of secret to create + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_generic.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl copy/kubectl_create_serviceaccount.md new file mode 100644 index 0000000000..35d21408a2 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_create_serviceaccount.md @@ -0,0 +1,87 @@ + + + + + +## kubectl create serviceaccount + +Create a service account with the specified name. + +### Synopsis + + + +Create a service account with the specified name. + +``` +kubectl create serviceaccount NAME [--dry-run] +``` + +### Examples + +``` + # Create a new service account named my-service-account + $ kubectl create serviceaccount my-service-account +``` + +### Options + +``` + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --generator="serviceaccount/v1": The name of the API generator to use. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin + +###### Auto generated by spf13/cobra on 17-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_serviceaccount.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_delete.md b/docs/user-guide/kubectl copy/kubectl_delete.md new file mode 100644 index 0000000000..781ea49e1c --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_delete.md @@ -0,0 +1,105 @@ + + + + + +## kubectl delete + +Delete resources by filenames, stdin, resources and names, or by resources and label selector. + +### Synopsis + + +Delete resources by filenames, stdin, resources and names, or by resources and label selector. + +JSON and YAML formats are accepted. + +Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector + +Note that the delete command does NOT do resource version checks, so if someone +submits an update to a resource right when you submit a delete, their update +will be lost along with the rest of the resource. + +``` +kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)]) +``` + +### Examples + +``` +# Delete a pod using the type and name specified in pod.json. +kubectl delete -f ./pod.json + +# Delete a pod based on the type and name in the JSON passed into stdin. +cat pod.json | kubectl delete -f - + +# Delete pods and services with same names "baz" and "foo" +kubectl delete pod,service baz foo + +# Delete pods and services with label name=myLabel. +kubectl delete pods,services -l name=myLabel + +# Delete a pod with UID 1234-56-7890-234234-456456. +kubectl delete pod 1234-56-7890-234234-456456 + +# Delete all pods +kubectl delete pods --all +``` + +### Options + +``` + --all[=false]: [-all] to select all the specified resources. + --cascade[=true]: If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. + -f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete. + --grace-period=-1: Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. + --ignore-not-found[=false]: Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + -l, --selector="": Selector (label query) to filter on. + --timeout=0: The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_delete.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_describe.md b/docs/user-guide/kubectl copy/kubectl_describe.md new file mode 100644 index 0000000000..cedbe63c5f --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_describe.md @@ -0,0 +1,106 @@ + + + + + +## kubectl describe + +Show details of a specific resource or group of resources + +### Synopsis + + +Show details of a specific resource or group of resources. + +This command joins many API calls together to form a detailed description of a +given resource or group of resources. + +$ kubectl describe TYPE NAME_PREFIX + +will first check for an exact match on TYPE and NAME_PREFIX. If no such resource +exists, it will output details for every resource that has a name prefixed with NAME_PREFIX + +Possible resource types include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), +persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), +namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa), +endpoints (ep) or secrets. + +``` +kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) +``` + +### Examples + +``` +# Describe a node +kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal + +# Describe a pod +kubectl describe pods/nginx + +# Describe a pod identified by type and name in "pod.json" +kubectl describe -f pod.json + +# Describe all pods +kubectl describe pods + +# Describe pods by label name=myLabel +kubectl describe po -l name=myLabel + +# Describe all pods managed by the 'frontend' replication controller (rc-created pods +# get the name of the rc as a prefix in the pod the name). +kubectl describe pods frontend +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe + -l, --selector="": Selector (label query) to filter on +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_drain.md b/docs/user-guide/kubectl copy/kubectl_drain.md new file mode 100644 index 0000000000..d2fecd7df5 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_drain.md @@ -0,0 +1,94 @@ + + + + + +## kubectl drain + +Drain node in preparation for maintenance + +### Synopsis + + +Drain node in preparation for maintenance. + +The given node will be marked unschedulable to prevent new pods from arriving. +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 marknigs. If there are any +pods that are neither mirror pods nor managed--by ReplicationController, +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 +will make the node schedulable again. + + +``` +kubectl drain NODE +``` + +### Examples + +``` +# Drain node "foo", even if there are pods not managed by a ReplicationController, Job, or DaemonSet on it. +$ kubectl drain foo --force + +# As above, but abort if there are pods not managed by a ReplicationController, Job, or DaemonSet, and use a grace period of 15 minutes. +$ kubectl drain foo --grace-period=900 + +``` + +### Options + +``` + --force[=false]: Continue even if there are pods not managed by a ReplicationController, Job, or DaemonSet. + --grace-period=-1: Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. + --ignore-daemonsets[=false]: Ignore DaemonSet-managed pods. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 2-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_drain.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_edit.md b/docs/user-guide/kubectl copy/kubectl_edit.md new file mode 100644 index 0000000000..300f90ef44 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_edit.md @@ -0,0 +1,104 @@ + + + + + +## kubectl edit + +Edit a resource on the server + +### Synopsis + + +Edit a resource from the default editor. + +The edit command allows you to directly edit any API resource you can retrieve via the +command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR +environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. +You can edit multiple objects, although changes are applied one at a time. The command +accepts filenames as well as command line arguments, although the files you point to must +be previously saved versions of resources. + +The files to edit will be output in the default API version, or a version specified +by --output-version. The default format is YAML - if you would like to edit in JSON +pass -o json. The flag --windows-line-endings can be used to force Windows line endings, +otherwise the default for your operating system will be used. + +In the event an error occurs while updating, a temporary file will be created on disk +that contains your unapplied changes. The most common error when updating a resource +is another editor changing the resource on the server. When this occurs, you will have +to apply your changes to the newer version of the resource, or update your temporary +saved copy to include the latest resource version. + +``` +kubectl edit (RESOURCE/NAME | -f FILENAME) +``` + +### Examples + +``` + # Edit the service named 'docker-registry': + kubectl edit svc/docker-registry + + # Use an alternative editor + KUBE_EDITOR="nano" kubectl edit svc/docker-registry + + # Edit the service 'docker-registry' in JSON using the v1 API format: + kubectl edit svc/docker-registry --output-version=v1 -o json +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to file to use to edit the resource + -o, --output="yaml": Output format. One of: yaml|json. + --output-version="": Output the formatted object with the given version (default api-version). + --record[=false]: Record current kubectl command in the resource annotation. + --save-config[=false]: 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. + --windows-line-endings[=false]: Use Windows line-endings (default Unix line-endings) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_edit.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_exec.md b/docs/user-guide/kubectl copy/kubectl_exec.md new file mode 100644 index 0000000000..561d5afdd7 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_exec.md @@ -0,0 +1,85 @@ + + + + + +## kubectl exec + +Execute a command in a container. + +### Synopsis + + +Execute a command in a container. + +``` +kubectl exec POD [-c CONTAINER] -- COMMAND [args...] +``` + +### Examples + +``` +# Get output from running 'date' from pod 123456-7890, using the first container by default +kubectl exec 123456-7890 date + +# Get output from running 'date' in ruby-container from pod 123456-7890 +kubectl exec 123456-7890 -c ruby-container date + +# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 +# and sends stdout/stderr from 'bash' back to the client +kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il +``` + +### Options + +``` + -c, --container="": Container name. If omitted, the first container in the pod will be chosen + -p, --pod="": Pod name + -i, --stdin[=false]: Pass stdin to the container + -t, --tty[=false]: Stdin is a TTY +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_exec.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_explain.md b/docs/user-guide/kubectl copy/kubectl_explain.md new file mode 100644 index 0000000000..8f7ca39107 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_explain.md @@ -0,0 +1,84 @@ + + + + + +## kubectl explain + +Documentation of resources. + +### Synopsis + + +Documentation of resources. + +Possible resource types include: pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa) +or endpoints (ep). + +``` +kubectl explain RESOURCE +``` + +### Examples + +``` +# Get the documentation of the resource and its fields +kubectl explain pods + +# Get the documentation of a specific field of a resource +kubectl explain pods.spec.containers +``` + +### Options + +``` + --recursive[=false]: Print the fields of fields (Currently only 1 level deep) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_explain.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_expose.md b/docs/user-guide/kubectl copy/kubectl_expose.md new file mode 100644 index 0000000000..f0789745b6 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_expose.md @@ -0,0 +1,120 @@ + + + + + +## kubectl expose + +Take a replication controller, service or pod and expose it as a new Kubernetes Service + +### Synopsis + + +Take a replication controller, service, replica set or pod and expose it as a new Kubernetes service. + +Looks up a replication controller, service, replica set or pod by name and uses the selector for that +resource as the selector for a new service on the specified port. A replica set will be exposed as a +service only if it's selector is convertible to a selector that service supports, i.e. when the +replica set selector contains only the matchLabels component. Note that if no port is specified +via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also +if no labels are specified, the new service will re-use the labels from the resource it exposes. + +``` +kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] +``` + +### Examples + +``` +# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. +kubectl expose rc nginx --port=80 --target-port=8000 + +# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. +kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000 + +# Create a service for a pod valid-pod, which serves on port 444 with the name "frontend" +kubectl expose pod valid-pod --port=444 --name=frontend + +# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" +kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https + +# Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'. +kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream + +# Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000. +kubectl expose rs nginx --port=80 --target-port=8000 +``` + +### Options + +``` + --container-port="": Synonym for --target-port + --dry-run[=false]: If true, only print the object that would be sent, without creating it. + --external-ip="": Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to expose a service + --generator="service/v2": The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. + -l, --labels="": Labels to apply to the service created by this call. + --load-balancer-ip="": IP to assign to to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). + --name="": The name for the newly created object. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. + --port="": The port that the service should serve on. Copied from the resource being exposed, if unspecified + --protocol="TCP": The network protocol for the service to be created. Default is 'tcp'. + --record[=false]: Record current kubectl command in the resource annotation. + --save-config[=false]: 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. + --selector="": A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set. + --session-affinity="": If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --target-port="": Name or number for the port on the container that the service should direct traffic to. Optional. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --type="": Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_get.md b/docs/user-guide/kubectl copy/kubectl_get.md new file mode 100644 index 0000000000..f447b11abe --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_get.md @@ -0,0 +1,118 @@ + + + + + +## kubectl get + +Display one or many resources + +### Synopsis + + +Display one or many resources. + +Possible resource types include (case insensitive): pods (po), services (svc), +replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), +limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), +resourcequotas (quota), namespaces (ns), endpoints (ep), +horizontalpodautoscalers (hpa), serviceaccounts or secrets. + +By specifying the output as 'template' and providing a Go template as the value +of the --template flag, you can filter the attributes of the fetched resource(s). + +``` +kubectl get [(-o|--output=)json|yaml|wide|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags] +``` + +### Examples + +``` +# List all pods in ps output format. +kubectl get pods + +# List all pods in ps output format with more information (such as node name). +kubectl get pods -o wide + +# List a single replication controller with specified NAME in ps output format. +kubectl get replicationcontroller web + +# List a single pod in JSON output format. +kubectl get -o json pod web-pod-13je7 + +# List a pod identified by type and name specified in "pod.yaml" in JSON output format. +kubectl get -f pod.yaml -o json + +# Return only the phase value of the specified pod. +kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} --api-version=v1 + +# List all replication controllers and services together in ps output format. +kubectl get rc,services + +# List one or more resources by their type and names. +kubectl get rc/web service/frontend pods/web-pod-13je7 +``` + +### Options + +``` + --all-namespaces[=false]: If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. + --export[=false]: If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information. + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + -L, --label-columns=[]: Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag statements like -L label1 -L label2... + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + -l, --selector="": Selector (label query) to filter on + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + -w, --watch[=false]: After listing/getting the requested object, watch for changes. + --watch-only[=false]: Watch for changes to the requested object(s), without listing/getting first. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_label.md b/docs/user-guide/kubectl copy/kubectl_label.md new file mode 100644 index 0000000000..6f11a4b83e --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_label.md @@ -0,0 +1,108 @@ + + + + + +## kubectl label + +Update the labels on a resource + +### Synopsis + + +Update the labels on a resource. + +A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. +If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label 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. + +``` +kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version] +``` + +### Examples + +``` +# Update pod 'foo' with the label 'unhealthy' and the value 'true'. +kubectl label pods foo unhealthy=true + +# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. +kubectl label --overwrite pods foo status=unhealthy + +# Update all pods in the namespace +kubectl label pods --all status=unhealthy + +# Update a pod identified by the type and name in "pod.json" +kubectl label -f pod.json status=unhealthy + +# Update pod 'foo' only if the resource is unchanged from version 1. +kubectl label pods foo status=unhealthy --resource-version=1 + +# Update pod 'foo' by removing a label named 'bar' if it exists. +# Does not require the --overwrite flag. +kubectl label pods foo bar- +``` + +### Options + +``` + --all[=false]: select all resources in the namespace of the specified resource types + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the labels + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --overwrite[=false]: If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. + --record[=false]: Record current kubectl command in the resource annotation. + --resource-version="": If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. + -l, --selector="": Selector (label query) to filter on + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_label.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_logs.md b/docs/user-guide/kubectl copy/kubectl_logs.md new file mode 100644 index 0000000000..6e28def56c --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_logs.md @@ -0,0 +1,94 @@ + + + + + +## kubectl logs + +Print the logs for a container in a pod. + +### Synopsis + + +Print the logs for a container in a pod. If the pod has only one container, the container name is optional. + +``` +kubectl logs [-f] [-p] POD [-c CONTAINER] +``` + +### Examples + +``` +# Return snapshot logs from pod nginx with only one container +kubectl logs nginx + +# Return snapshot of previous terminated ruby container logs from pod web-1 +kubectl logs -p -c ruby web-1 + +# Begin streaming the logs of the ruby container in pod web-1 +kubectl logs -f -c ruby web-1 + +# Display only the most recent 20 lines of output in pod nginx +kubectl logs --tail=20 nginx + +# Show all logs from pod nginx written in the last hour +kubectl logs --since=1h nginx +``` + +### Options + +``` + -c, --container="": Print the logs of this container + -f, --follow[=false]: Specify if the logs should be streamed. + --limit-bytes=0: Maximum bytes of logs to return. Defaults to no limit. + -p, --previous[=false]: If true, print the logs for the previous instance of the container in a pod if it exists. + --since=0: 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-time="": Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. + --tail=-1: Lines of recent log file to display. Defaults to -1, showing all log lines. + --timestamps[=false]: Include timestamps on each line in the log output +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_namespace.md b/docs/user-guide/kubectl copy/kubectl_namespace.md new file mode 100644 index 0000000000..3f35add25a --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_namespace.md @@ -0,0 +1,65 @@ + + + + + +## kubectl namespace + +SUPERSEDED: Set and view the current Kubernetes namespace + +### Synopsis + + +SUPERSEDED: Set and view the current Kubernetes namespace scope for command line requests. + +namespace has been superseded by the context.namespace field of .kubeconfig files. See 'kubectl config set-context --help' for more details. + + +``` +kubectl namespace [namespace] +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_namespace.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_patch.md b/docs/user-guide/kubectl copy/kubectl_patch.md new file mode 100644 index 0000000000..bb92517c47 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_patch.md @@ -0,0 +1,93 @@ + + + + + +## kubectl patch + +Update field(s) of a resource using strategic merge patch. + +### Synopsis + + +Update field(s) of a resource using strategic merge patch + +JSON and YAML formats are accepted. + +Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/api-reference/v1/definitions.html to find if a field is mutable. + +``` +kubectl patch (-f FILENAME | TYPE NAME) -p PATCH +``` + +### Examples + +``` + +# Partially update a node using strategic merge patch +kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' + +# Partially update a node identified by the type and name specified in "node.json" using strategic merge patch +kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}' + +# Update a container's image; spec.containers[*].name is required because it's a merge key +kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}' + +# Update a container's image using a json patch with positional arrays +kubectl patch pod valid-pod -type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + -p, --patch="": The patch to be applied to the resource JSON file. + --record[=false]: Record current kubectl command in the resource annotation. + --type="strategic": The type of patch being provided; one of [json merge strategic] +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 12-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_patch.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_port-forward.md b/docs/user-guide/kubectl copy/kubectl_port-forward.md new file mode 100644 index 0000000000..a8802e9506 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_port-forward.md @@ -0,0 +1,85 @@ + + + + + +## kubectl port-forward + +Forward one or more local ports to a pod. + +### Synopsis + + +Forward one or more local ports to a pod. + +``` +kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] +``` + +### Examples + +``` + +# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod +kubectl port-forward mypod 5000 6000 + +# Listen on port 8888 locally, forwarding to 5000 in the pod +kubectl port-forward mypod 8888:5000 + +# Listen on a random port locally, forwarding to 5000 in the pod +kubectl port-forward mypod :5000 + +# Listen on a random port locally, forwarding to 5000 in the pod +kubectl port-forward mypod 0:5000 +``` + +### Options + +``` + -p, --pod="": Pod name +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_port-forward.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_proxy.md b/docs/user-guide/kubectl copy/kubectl_proxy.md new file mode 100644 index 0000000000..fb24cd1fbe --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_proxy.md @@ -0,0 +1,108 @@ + + + + + +## kubectl proxy + +Run a proxy to the Kubernetes API server + +### Synopsis + + +To proxy all of the kubernetes api and nothing else, use: + +kubectl proxy --api-prefix=/ + +To proxy only part of the kubernetes api and also some static files: + +kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/ + +The above lets you 'curl localhost:8001/api/v1/pods'. + +To proxy the entire kubernetes api at a different root, use: + +kubectl proxy --api-prefix=/custom/ + +The above lets you 'curl localhost:8001/custom/api/v1/pods' + + +``` +kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] +``` + +### Examples + +``` +# Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/ +kubectl proxy --port=8011 --www=./local/www/ + +# Run a proxy to kubernetes apiserver on an arbitrary local port. +# The chosen port for the server will be output to stdout. +kubectl proxy --port=0 + +# Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api +# This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/ +kubectl proxy --api-prefix=/k8s-api +``` + +### Options + +``` + --accept-hosts="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$": Regular expression for hosts that the proxy should accept. + --accept-paths="^/.*": Regular expression for paths that the proxy should accept. + --address="127.0.0.1": The IP address on which to serve on. + --api-prefix="/": Prefix to serve the proxied API under. + --disable-filter[=false]: If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. + -p, --port=8001: The port on which to run the proxy. Set to 0 to pick a random port. + --reject-methods="POST,PUT,PATCH": Regular expression for HTTP methods that the proxy should reject. + --reject-paths="^/api/.*/exec,^/api/.*/run,^/api/.*/attach": Regular expression for paths that the proxy should reject. + -u, --unix-socket="": Unix socket on which to run the proxy. + -w, --www="": Also serve static files from the given directory under the specified prefix. + -P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_proxy.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_replace.md b/docs/user-guide/kubectl copy/kubectl_replace.md new file mode 100644 index 0000000000..ea0b65bfb9 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_replace.md @@ -0,0 +1,99 @@ + + + + + +## kubectl replace + +Replace a resource by filename or stdin. + +### Synopsis + + +Replace a resource by filename or stdin. + +JSON and YAML formats are accepted. If replacing an existing resource, the +complete resource spec must be provided. This can be obtained by +$ kubectl get TYPE NAME -o yaml + +Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/api-reference/v1/definitions.html to find if a field is mutable. + +``` +kubectl replace -f FILENAME +``` + +### Examples + +``` +# Replace a pod using the data in pod.json. +kubectl replace -f ./pod.json + +# Replace a pod based on the JSON passed into stdin. +cat pod.json | kubectl replace -f - + +# Update a single-container pod's image version (tag) to v4 +kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f - + +# Force replace, delete and then re-create the resource +kubectl replace --force -f ./pod.json +``` + +### Options + +``` + --cascade[=false]: Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). + -f, --filename=[]: Filename, directory, or URL to file to use to replace the resource. + --force[=false]: Delete and re-create the specified resource + --grace-period=-1: Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + --record[=false]: Record current kubectl command in the resource annotation. + --save-config[=false]: 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="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + --timeout=0: 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 + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_replace.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_rolling-update.md b/docs/user-guide/kubectl copy/kubectl_rolling-update.md new file mode 100644 index 0000000000..ba0540248a --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_rolling-update.md @@ -0,0 +1,110 @@ + + + + + +## kubectl rolling-update + +Perform a rolling update of the given ReplicationController. + +### Synopsis + + +Perform a rolling update of the given ReplicationController. + +Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the +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. + +``` +kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC) +``` + +### Examples + +``` +# Update pods of frontend-v1 using new replication controller data in frontend-v2.json. +kubectl rolling-update frontend-v1 -f frontend-v2.json + +# Update pods of frontend-v1 using JSON data passed into stdin. +cat frontend-v2.json | kubectl rolling-update frontend-v1 -f - + +# Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the +# name of the replication controller. +kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2 + +# Update the pods of frontend by just changing the image, and keeping the old name. +kubectl rolling-update frontend --image=image:v2 + +# Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2). +kubectl rolling-update frontend-v1 frontend-v2 --rollback + +``` + +### Options + +``` + --container="": Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod + --deployment-label-key="deployment": The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise + --dry-run[=false]: If true, print out the changes that would be made, but don't actually make them. + -f, --filename=[]: Filename or URL to file to use to create the new replication controller. + --image="": Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag). Can not be used with --filename/-f + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --poll-interval=3s: Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". + --rollback[=false]: If true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout + --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --timeout=5m0s: Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". + --update-period=1m0s: Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rolling-update.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_rollout.md b/docs/user-guide/kubectl copy/kubectl_rollout.md new file mode 100644 index 0000000000..ec24863388 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_rollout.md @@ -0,0 +1,73 @@ + + + + + +## kubectl rollout + +rollout manages a deployment + +### Synopsis + + +rollout manages a deployment using subcommands like "kubectl rollout undo deployment/abc" + +``` +kubectl rollout SUBCOMMAND +``` + +### Examples + +``` +# Rollback to the previous deployment +kubectl rollout undo deployment/abc +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl rollout history](kubectl_rollout_history.md) - view rollout history +* [kubectl rollout pause](kubectl_rollout_pause.md) - Mark the provided resource as paused +* [kubectl rollout resume](kubectl_rollout_resume.md) - Resume a paused resource +* [kubectl rollout undo](kubectl_rollout_undo.md) - undoes a previous rollout + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_rollout_history.md b/docs/user-guide/kubectl copy/kubectl_rollout_history.md new file mode 100644 index 0000000000..d7698c654d --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_rollout_history.md @@ -0,0 +1,76 @@ + + + + + +## kubectl rollout history + +view rollout history + +### Synopsis + + +view previous rollout revisions and configurations. + +``` +kubectl rollout history (TYPE NAME | TYPE/NAME) [flags] +``` + +### Examples + +``` +# View the rollout history of a deployment +kubectl rollout history deployment/abc +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + --revision=0: See the details, including podTemplate of the revision specified +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_history.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_rollout_pause.md b/docs/user-guide/kubectl copy/kubectl_rollout_pause.md new file mode 100644 index 0000000000..fbf0ff4444 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_rollout_pause.md @@ -0,0 +1,81 @@ + + + + + +## kubectl rollout pause + +Mark the provided resource as paused + +### Synopsis + + +Mark the provided resource as paused + +Paused resources will not be reconciled by a controller. +Use \"kubectl rollout resume\" to resume a paused resource. +Currently only deployments support being paused. + +``` +kubectl rollout pause RESOURCE +``` + +### Examples + +``` +# Mark the nginx deployment as paused. Any current state of +# the deployment will continue its function, new updates to the deployment will not +# have an effect as long as the deployment is paused. +kubectl rollout pause deployment/nginx +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_pause.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_rollout_resume.md b/docs/user-guide/kubectl copy/kubectl_rollout_resume.md new file mode 100644 index 0000000000..2116a36169 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_rollout_resume.md @@ -0,0 +1,79 @@ + + + + + +## kubectl rollout resume + +Resume a paused resource + +### Synopsis + + +Resume a paused resource + +Paused resources will not be reconciled by a controller. By resuming a +resource, we allow it to be reconciled again. +Currently only deployments support being resumed. + +``` +kubectl rollout resume RESOURCE +``` + +### Examples + +``` +# Resume an already paused deployment +kubectl rollout resume deployment/nginx +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_resume.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_rollout_undo.md b/docs/user-guide/kubectl copy/kubectl_rollout_undo.md new file mode 100644 index 0000000000..9a5dc1baca --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_rollout_undo.md @@ -0,0 +1,76 @@ + + + + + +## kubectl rollout undo + +undoes a previous rollout + +### Synopsis + + +undo rolls back to a previous rollout. + +``` +kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] +``` + +### Examples + +``` +# Rollback to the previous deployment +kubectl rollout undo deployment/abc +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + --to-revision=0: The revision to rollback to. Default to 0 (last revision). +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_undo.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_run.md b/docs/user-guide/kubectl copy/kubectl_run.md new file mode 100644 index 0000000000..b54e0d3f0d --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_run.md @@ -0,0 +1,132 @@ + + + + + +## kubectl run + +Run a particular image on the cluster. + +### Synopsis + + +Create and run a particular image, possibly replicated. +Creates a deployment or job to manage the created container(s). + +``` +kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...] +``` + +### Examples + +``` +# Start a single instance of nginx. +kubectl run nginx --image=nginx + +# Start a single instance of hazelcast and let the container expose port 5701 . +kubectl run hazelcast --image=hazelcast --port=5701 + +# Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container. +kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default" + +# Start a replicated instance of nginx. +kubectl run nginx --image=nginx --replicas=5 + +# Dry run. Print the corresponding API objects without creating them. +kubectl run nginx --image=nginx --dry-run + +# Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON. +kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }' + +# Start a single instance of busybox and keep it in the foreground, don't restart it if it exits. +kubectl run -i --tty busybox --image=busybox --restart=Never + +# Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command. +kubectl run nginx --image=nginx -- ... + +# Start the nginx container using a different command and custom arguments. +kubectl run nginx --image=nginx --command -- ... + +# Start the perl container to compute π to 2000 places and print it out. +kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)' +``` + +### Options + +``` + --attach[=false]: If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--interactive' is set, in which case the default is true. + --command[=false]: If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --env=[]: Environment variables to set in the container + --expose[=false]: If true, a public, external service is created for the container(s) which are run + --generator="": The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, otherwise the default is 'job/v1beta1'. + --hostport=-1: The host port mapping for the container port. To demonstrate a single-machine container. + --image="": The image for the container to run. + -l, --labels="": Labels to apply to the pod(s). + --leave-stdin-open[=false]: If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. + --limits="": The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi' + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given version (default api-version). + --overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. + --port=-1: The port that this container exposes. If --expose is true, this is also the port used by the service that is created. + --record[=false]: Record current kubectl command in the resource annotation. + -r, --replicas=1: Number of replicas to create for this container. Default is 1. + --requests="": The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi' + --restart="Always": The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to OnFailure or Never, a job is created for this pod and --replicas must be 1. Default 'Always' + --rm[=false]: If true, delete resources created in this command for attached containers. + --save-config[=false]: 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. + --service-generator="service/v2": The name of the generator to use for creating a service. Only used if --expose is true + --service-overrides="": An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true. + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + -i, --stdin[=false]: Keep stdin open on the container(s) in the pod, even if nothing is attached. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --tty[=false]: Allocated a TTY for each container in the pod. Because -t is currently shorthand for --template, -t is not supported for --tty. This shorthand is deprecated and we expect to adopt -t for --tty soon. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_run.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_scale.md b/docs/user-guide/kubectl copy/kubectl_scale.md new file mode 100644 index 0000000000..fe3976da46 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_scale.md @@ -0,0 +1,98 @@ + + + + + +## kubectl scale + +Set a new size for a Replication Controller, Job, or Deployment. + +### Synopsis + + +Set a new size for a Replication Controller, Job, or Deployment. + +Scale also allows users to specify one or more preconditions for the scale action. +If --current-replicas or --resource-version is specified, it is validated before the +scale is attempted, and it is guaranteed that the precondition holds true when the +scale is sent to the server. + +``` +kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME) +``` + +### Examples + +``` +# Scale replication controller named 'foo' to 3. +kubectl scale --replicas=3 rc/foo + +# Scale a resource identified by type and name specified in "foo.yaml" to 3. +kubectl scale --replicas=3 -f foo.yaml + +# If the deployment named mysql's current size is 2, scale mysql to 3. +kubectl scale --current-replicas=2 --replicas=3 deployment/mysql + +# Scale multiple replication controllers. +kubectl scale --replicas=5 rc/foo rc/bar rc/baz + +# Scale job named 'cron' to 3. +kubectl scale --replicas=3 job/cron +``` + +### Options + +``` + --current-replicas=-1: Precondition for current size. Requires that the current size of the resource match this value in order to scale. + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to set a new size + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + --record[=false]: Record current kubectl command in the resource annotation. + --replicas=-1: The new desired number of replicas. Required. + --resource-version="": Precondition for resource version. Requires that the current resource version match this value in order to scale. + --timeout=0: The length of time to wait before giving up on a scale operation, zero means don't wait. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 29-Feb-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_scale.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_stop.md b/docs/user-guide/kubectl copy/kubectl_stop.md new file mode 100644 index 0000000000..e7a71b9140 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_stop.md @@ -0,0 +1,96 @@ + + + + + +## kubectl stop + +Deprecated: Gracefully shut down a resource by name or filename. + +### Synopsis + + +Deprecated: Gracefully shut down a resource by name or filename. + +The stop command is deprecated, all its functionalities are covered by delete command. +See 'kubectl delete --help' for more details. + +Attempts to shut down and delete a resource that supports graceful termination. +If the resource is scalable it will be scaled to 0 before deletion. + +``` +kubectl stop (-f FILENAME | TYPE (NAME | -l label | --all)) +``` + +### Examples + +``` +# Shut down foo. +$ kubectl stop replicationcontroller foo + +# Stop pods and services with label name=myLabel. +$ kubectl stop pods,services -l name=myLabel + +# Shut down the service defined in service.json +$ kubectl stop -f service.json + +# Shut down all resources in the path/to/resources directory +$ kubectl stop -f path/to/resources +``` + +### Options + +``` + --all[=false]: [-all] to select all the specified resources. + -f, --filename=[]: Filename, directory, or URL to file of resource(s) to be stopped. + --grace-period=-1: Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. + --ignore-not-found[=false]: Treat "resource not found" as a successful stop. + -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + -l, --selector="": Selector (label query) to filter on. + --timeout=0: The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 24-Nov-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_stop.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_uncordon.md b/docs/user-guide/kubectl copy/kubectl_uncordon.md new file mode 100644 index 0000000000..55096cd3b1 --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_uncordon.md @@ -0,0 +1,71 @@ + + + + + +## kubectl uncordon + +Mark node as schedulable + +### Synopsis + + +Mark node as schedulable. + + +``` +kubectl uncordon NODE +``` + +### Examples + +``` +# Mark node "foo" as schedulable. +$ kubectl uncordon foo + +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 4-Jan-2016 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_uncordon.md?pixel)]() + diff --git a/docs/user-guide/kubectl copy/kubectl_version.md b/docs/user-guide/kubectl copy/kubectl_version.md new file mode 100644 index 0000000000..47a9d5f24a --- /dev/null +++ b/docs/user-guide/kubectl copy/kubectl_version.md @@ -0,0 +1,68 @@ + + + + + +## kubectl version + +Print the client and server version information. + +### Synopsis + + +Print the client and server version information. + +``` +kubectl version +``` + +### Options + +``` + --client[=false]: Client version only (no server required). +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --api-version="": The API version to use when talking to the server + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 8-Dec-2015 + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_version.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index 03b00d62cf..2c6a6c3ebf 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md index aefb0ce00d..3cf31b7846 100644 --- a/docs/user-guide/kubectl/kubectl_annotate.md +++ b/docs/user-guide/kubectl/kubectl_annotate.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md index 3e7843d81f..de3ad2e3cb 100644 --- a/docs/user-guide/kubectl/kubectl_api-versions.md +++ b/docs/user-guide/kubectl/kubectl_api-versions.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_apply.md b/docs/user-guide/kubectl/kubectl_apply.md index a422fed5dd..acfdf349a8 100644 --- a/docs/user-guide/kubectl/kubectl_apply.md +++ b/docs/user-guide/kubectl/kubectl_apply.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index 5ca5f15e06..b9d4d6281c 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md index d8d6746c85..e4ebc2b40d 100644 --- a/docs/user-guide/kubectl/kubectl_autoscale.md +++ b/docs/user-guide/kubectl/kubectl_autoscale.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md index f96f3f5651..9a1d6b042e 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md index c93c02c21e..be5cf2bc31 100644 --- a/docs/user-guide/kubectl/kubectl_config.md +++ b/docs/user-guide/kubectl/kubectl_config.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_current-context.md b/docs/user-guide/kubectl/kubectl_config_current-context.md index 24d14ec0b5..f104271637 100644 --- a/docs/user-guide/kubectl/kubectl_config_current-context.md +++ b/docs/user-guide/kubectl/kubectl_config_current-context.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_set-cluster.md b/docs/user-guide/kubectl/kubectl_config_set-cluster.md index 70a0998f1b..bf52eb877b 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md index c122465657..ec8aaaf474 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-context.md +++ b/docs/user-guide/kubectl/kubectl_config_set-context.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md index 0c4985af90..89cf284475 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md +++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md index 165a4dcd1e..41d9d017a1 100644 --- a/docs/user-guide/kubectl/kubectl_config_set.md +++ b/docs/user-guide/kubectl/kubectl_config_set.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md index 9bbf3d9f5e..07aec8fa8a 100644 --- a/docs/user-guide/kubectl/kubectl_config_unset.md +++ b/docs/user-guide/kubectl/kubectl_config_unset.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md index ce35581a0e..5204d6dac9 100644 --- a/docs/user-guide/kubectl/kubectl_config_use-context.md +++ b/docs/user-guide/kubectl/kubectl_config_use-context.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md index 829a45f79f..f4acd679f8 100644 --- a/docs/user-guide/kubectl/kubectl_config_view.md +++ b/docs/user-guide/kubectl/kubectl_config_view.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_convert.md b/docs/user-guide/kubectl/kubectl_convert.md index d4a6d0bf9a..e8e49b9cd7 100644 --- a/docs/user-guide/kubectl/kubectl_convert.md +++ b/docs/user-guide/kubectl/kubectl_convert.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_cordon.md b/docs/user-guide/kubectl/kubectl_cordon.md index 4b610189c2..3a01819b90 100644 --- a/docs/user-guide/kubectl/kubectl_cordon.md +++ b/docs/user-guide/kubectl/kubectl_cordon.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md index 6a7a677285..cc26302650 100644 --- a/docs/user-guide/kubectl/kubectl_create.md +++ b/docs/user-guide/kubectl/kubectl_create.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create_configmap.md b/docs/user-guide/kubectl/kubectl_create_configmap.md index abee69541f..a575740e72 100644 --- a/docs/user-guide/kubectl/kubectl_create_configmap.md +++ b/docs/user-guide/kubectl/kubectl_create_configmap.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create_namespace.md b/docs/user-guide/kubectl/kubectl_create_namespace.md index e4b6f8a0db..d308a63f19 100644 --- a/docs/user-guide/kubectl/kubectl_create_namespace.md +++ b/docs/user-guide/kubectl/kubectl_create_namespace.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create_secret.md b/docs/user-guide/kubectl/kubectl_create_secret.md index e6f768032d..fe2127cae6 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret.md +++ b/docs/user-guide/kubectl/kubectl_create_secret.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md index 439f9c4635..30e7aeca4e 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create_secret_generic.md b/docs/user-guide/kubectl/kubectl_create_secret_generic.md index 8e421d67e0..52de0bdadb 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_generic.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_generic.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md index 35d21408a2..d02e7f6f60 100644 --- a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md +++ b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md index 781ea49e1c..847db93a62 100644 --- a/docs/user-guide/kubectl/kubectl_delete.md +++ b/docs/user-guide/kubectl/kubectl_delete.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index cedbe63c5f..c451e423de 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_drain.md b/docs/user-guide/kubectl/kubectl_drain.md index d2fecd7df5..a887595ff2 100644 --- a/docs/user-guide/kubectl/kubectl_drain.md +++ b/docs/user-guide/kubectl/kubectl_drain.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_edit.md b/docs/user-guide/kubectl/kubectl_edit.md index 300f90ef44..5192c6ad5b 100644 --- a/docs/user-guide/kubectl/kubectl_edit.md +++ b/docs/user-guide/kubectl/kubectl_edit.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index 561d5afdd7..ffa7bd0a64 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md index 8f7ca39107..540eedb26d 100644 --- a/docs/user-guide/kubectl/kubectl_explain.md +++ b/docs/user-guide/kubectl/kubectl_explain.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index f0789745b6..62ea5c778c 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index f447b11abe..8ac7a2af1f 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md index 6f11a4b83e..73c37cb366 100644 --- a/docs/user-guide/kubectl/kubectl_label.md +++ b/docs/user-guide/kubectl/kubectl_label.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index 6e28def56c..89a94b1078 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md index 3f35add25a..baa6301dce 100644 --- a/docs/user-guide/kubectl/kubectl_namespace.md +++ b/docs/user-guide/kubectl/kubectl_namespace.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md index bb92517c47..2c7faa58cd 100644 --- a/docs/user-guide/kubectl/kubectl_patch.md +++ b/docs/user-guide/kubectl/kubectl_patch.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index a8802e9506..ff57bb2347 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md index fb24cd1fbe..467243a63e 100644 --- a/docs/user-guide/kubectl/kubectl_proxy.md +++ b/docs/user-guide/kubectl/kubectl_proxy.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md index ea0b65bfb9..7d0ee5a161 100644 --- a/docs/user-guide/kubectl/kubectl_replace.md +++ b/docs/user-guide/kubectl/kubectl_replace.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md index ba0540248a..f7c07672e7 100644 --- a/docs/user-guide/kubectl/kubectl_rolling-update.md +++ b/docs/user-guide/kubectl/kubectl_rolling-update.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md index ec24863388..8d3ba96301 100644 --- a/docs/user-guide/kubectl/kubectl_rollout.md +++ b/docs/user-guide/kubectl/kubectl_rollout.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md index d7698c654d..32e7f865a7 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_history.md +++ b/docs/user-guide/kubectl/kubectl_rollout_history.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_rollout_pause.md b/docs/user-guide/kubectl/kubectl_rollout_pause.md index fbf0ff4444..d45a2bee59 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_pause.md +++ b/docs/user-guide/kubectl/kubectl_rollout_pause.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_rollout_resume.md b/docs/user-guide/kubectl/kubectl_rollout_resume.md index 2116a36169..f77c24069f 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_resume.md +++ b/docs/user-guide/kubectl/kubectl_rollout_resume.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md index 9a5dc1baca..b3e029a6c4 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_undo.md +++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index b54e0d3f0d..35d3eef06c 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index fe3976da46..68e00cbbd2 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_stop.md b/docs/user-guide/kubectl/kubectl_stop.md index e7a71b9140..78ea5383f3 100644 --- a/docs/user-guide/kubectl/kubectl_stop.md +++ b/docs/user-guide/kubectl/kubectl_stop.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_uncordon.md b/docs/user-guide/kubectl/kubectl_uncordon.md index 55096cd3b1..ba44ccd473 100644 --- a/docs/user-guide/kubectl/kubectl_uncordon.md +++ b/docs/user-guide/kubectl/kubectl_uncordon.md @@ -1,3 +1,5 @@ +--- +--- diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 47a9d5f24a..b517439e40 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -1,3 +1,5 @@ +--- +---