# kubectl

kubectlSynopsiskubectl controls the Kubernetes cluster manager.Find more information at: https://kubernetes.io/docs/reference/kubectl/kubectl [flags] Options--as stringUsername to impersonate for the operation. User could be a regular user or a service account in a namespace.--as-group stringsGroup to impersonate for the operation, this flag can be repeated to specify multiple groups.--as-uid stringUID to impersonate for the operation.--cache-dir string Default: "$HOME/.kube/cache"Default cache directory--certificate-authority stringPath to a cert file for the certificate authority--client-certificate stringPath to a client certificate file for TLS--client-key stringPath to a client key file for TLS--cluster stringThe name of the kubeconfig cluster to use--context stringThe name of the kubeconfig context to use--disable-compressionIf true, opt-out of response compression for all requests to the server-h, --helphelp for kubectl--insecure-skip-tls-verifyIf true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure--kubeconfig stringPath to the kubeconfig file to use for CLI requests.--kuberc stringPath to the kuberc file to use for preferences. This can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.--match-server-versionRequire server version to match client version-n, --namespace stringIf present, the namespace scope for this CLI request--password stringPassword for basic authentication to the API server--profile string Default: "none"Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)--profile-output string Default: "profile.pprof"Name of the file to write the profile to--request-timeout string Default: "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 stringThe address and port of the Kubernetes API server--storage-driver-buffer-duration duration Default: 1m0sWrites in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction--storage-driver-db string Default: "cadvisor"database name--storage-driver-host string Default: "localhost:8086"database host:port--storage-driver-password string Default: "root"database password--storage-driver-secureuse secure connection with database--storage-driver-table string Default: "stats"table name--storage-driver-user string Default: "root"database username--tls-server-name stringServer name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used--token stringBearer token for authentication to the API server--user stringThe name of the kubeconfig user to use--username stringUsername for basic authentication to the API server--version version[=true]--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version--warnings-as-errorsTreat warnings received from the server as errors and exit with a non-zero exit codeSee Alsokubectl annotate - Update the annotations on a resourcekubectl api-resources - Print the supported API resources on the serverkubectl api-versions - Print the supported API versions on the server, in the form of "group/version"kubectl apply - Apply a configuration to a resource by file name or stdinkubectl attach - Attach to a running containerkubectl auth - Inspect authorizationkubectl autoscale - Auto-scale a deployment, replica set, stateful set, or replication controllerkubectl certificate - Modify certificate resourceskubectl cluster-info - Display cluster informationkubectl completion - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)kubectl config - Modify kubeconfig fileskubectl cordon - Mark node as unschedulablekubectl cp - Copy files and directories to and from containerskubectl create - Create a resource from a file or from stdinkubectl debug - Create debugging sessions for troubleshooting workloads and nodeskubectl delete - Delete resources by file names, stdin, resources and names, or by resources and label selectorkubectl describe - Show details of a specific resource or group of resourceskubectl diff - Diff the live version against a would-be applied versionkubectl drain - Drain node in preparation for maintenancekubectl edit - Edit a resource on the serverkubectl events - List eventskubectl exec - Execute a command in a containerkubectl explain - Get documentation for a resourcekubectl expose - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes servicekubectl get - Display one or many resourceskubectl kustomize - Build a kustomization target from a directory or URLkubectl label - Update the labels on a resourcekubectl logs - Print the logs for a container in a podkubectl options - Print the list of flags inherited by all commandskubectl patch - Update fields of a resourcekubectl plugin - Provides utilities for interacting with pluginskubectl port-forward - Forward one or more local ports to a podkubectl proxy - Run a proxy to the Kubernetes API serverkubectl replace - Replace a resource by file name or stdinkubectl rollout - Manage the rollout of a resourcekubectl run - Run a particular image on the clusterkubectl scale - Set a new size for a deployment, replica set, or replication controllerkubectl set - Set specific features on objectskubectl taint - Update the taints on one or more nodeskubectl top - Display resource (CPU/memory) usagekubectl uncordon - Mark node as schedulablekubectl version - Print the client and server version informationkubectl wait - Experimental: Wait for a specific condition on one or many resourcesThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.