kubectl - Man Page

kubectl controls the Kubernetes cluster manager

Examples (TL;DR)

Eric Paris Jan 2015

Synopsis

kubectl [Options]

Description

kubectl controls the Kubernetes cluster manager.

Find more information at: https://kubernetes.io/docs/reference/kubectl/

Options

--as="" Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

--as-group=[] Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

--as-uid="" UID to impersonate for the operation.

--azure-container-registry-config="" Path to the file containing Azure container registry configuration information.

--cache-dir="/home/username/.kube/cache" Default cache directory

--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

--disable-compression=false If true, opt-out of response compression for all requests to the server

--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.

--match-server-version=false Require server version to match client version

-n, --namespace="" If present, the namespace scope for this CLI request

--password="" Password for basic authentication to the API server

--profile="none" Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output="profile.pprof" Name of the file to write the profile to

--request-timeout="0" The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

-s, --server="" The address and port of the Kubernetes API server

--tls-server-name="" Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

--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

--version=false --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version

--warnings-as-errors=false Treat warnings received from the server as errors and exit with a non-zero exit code

See Also

kubectl-alpha(1), kubectl-annotate(1), kubectl-api-resources(1), kubectl-api-versions(1), kubectl-apply(1), kubectl-attach(1), kubectl-auth(1), kubectl-autoscale(1), kubectl-certificate(1), kubectl-cluster-info(1), kubectl-completion(1), kubectl-config(1), kubectl-cordon(1), kubectl-cp(1), kubectl-create(1), kubectl-debug(1), kubectl-delete(1), kubectl-describe(1), kubectl-diff(1), kubectl-drain(1), kubectl-edit(1), kubectl-events(1), kubectl-exec(1), kubectl-explain(1), kubectl-expose(1), kubectl-get(1), kubectl-kustomize(1), kubectl-label(1), kubectl-logs(1), kubectl-options(1), kubectl-patch(1), kubectl-plugin(1), kubectl-port-forward(1), kubectl-proxy(1), kubectl-replace(1), kubectl-rollout(1), kubectl-run(1), kubectl-scale(1), kubectl-set(1), kubectl-taint(1), kubectl-top(1), kubectl-uncordon(1), kubectl-version(1), kubectl-wait(1),

History

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Referenced By

kubectl-alpha(1), kubectl-annotate(1), kubectl-api-resources(1), kubectl-api-versions(1), kubectl-apply(1), kubectl-attach(1), kubectl-auth(1), kubectl-autoscale(1), kubectl-certificate(1), kubectl-cluster-info(1), kubectl-completion(1), kubectl-config(1), kubectl-cordon(1), kubectl-cp(1), kubectl-create(1), kubectl-debug(1), kubectl-delete(1), kubectl-describe(1), kubectl-diff(1), kubectl-drain(1), kubectl-edit(1), kubectl-events(1), kubectl-exec(1), kubectl-explain(1), kubectl-expose(1), kubectl-get(1), kubectl-kustomize(1), kubectl-label(1), kubectl-logs(1), kubectl-options(1), kubectl-patch(1), kubectl-plugin(1), kubectl-port-forward(1), kubectl-proxy(1), kubectl-replace(1), kubectl-rollout(1), kubectl-run(1), kubectl-scale(1), kubectl-set(1), kubectl-taint(1), kubectl-top(1), kubectl-uncordon(1), kubectl-version(1), kubectl-wait(1), PCP_KUBE_PODS(1).

User Manuals