kubectl
Synopsis
kubectl controls the Kubernetes cluster manager.
Find more information at: https://kubernetes.io/docs/reference/kubectl/
kubectl [flags]
Options
| --as string | |
Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | |
| --as-group strings | |
Group to impersonate for the operation, this flag can be repeated to specify multiple groups. | |
| --as-uid string | |
UID to impersonate for the operation. | |
| --cache-dir string Default: "$HOME/.kube/cache" | |
Default cache directory | |
| --certificate-authority string | |
Path to a cert file for the certificate authority | |
| --client-certificate string | |
Path to a client certificate file for TLS | |
| --client-key string | |
Path to a client key file for TLS | |
| --cluster string | |
The name of the kubeconfig cluster to use | |
| --context string | |
The name of the kubeconfig context to use | |
| --default-not-ready-toleration-seconds int Default: 300 | |
Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration. | |
| --default-unreachable-toleration-seconds int Default: 300 | |
Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration. | |
| --disable-compression | |
If true, opt-out of response compression for all requests to the server | |
| -h, --help | |
help for kubectl | |
| --insecure-skip-tls-verify | |
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure | |
| --kubeconfig string | |
Path to the kubeconfig file to use for CLI requests. | |
| --match-server-version | |
Require server version to match client version | |
| -n, --namespace string | |
If present, the namespace scope for this CLI request | |
| --password string | |
Password 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 string | |
The address and port of the Kubernetes API server | |
| --storage-driver-buffer-duration duration Default: 1m0s | |
Writes 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-secure | |
use secure connection with database | |
| --storage-driver-table string Default: "stats" | |
table name | |
| --storage-driver-user string Default: "root" | |
database username | |
| --tls-server-name string | |
Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used | |
| --token string | |
Bearer token for authentication to the API server | |
| --user string | |
The name of the kubeconfig user to use | |
| --username string | |
Username 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-errors | |
Treat warnings received from the server as errors and exit with a non-zero exit code | |
See Also
- kubectl annotate - Update the annotations on a resource
- kubectl api-resources - Print the supported API resources on the server
- kubectl 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 stdin
- kubectl attach - Attach to a running container
- kubectl auth - Inspect authorization
- kubectl autoscale - Auto-scale a deployment, replica set, stateful set, or replication controller
- kubectl certificate - Modify certificate resources
- kubectl cluster-info - Display cluster information
- kubectl completion - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
- kubectl config - Modify kubeconfig files
- kubectl cordon - Mark node as unschedulable
- kubectl cp - Copy files and directories to and from containers
- kubectl create - Create a resource from a file or from stdin
- kubectl debug - Create debugging sessions for troubleshooting workloads and nodes
- kubectl delete - Delete resources by file names, stdin, resources and names, or by resources and label selector
- kubectl describe - Show details of a specific resource or group of resources
- kubectl diff - Diff the live version against a would-be applied version
- kubectl drain - Drain node in preparation for maintenance
- kubectl edit - Edit a resource on the server
- kubectl events - List events
- kubectl exec - Execute a command in a container
- kubectl explain - Get documentation for a resource
- kubectl expose - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
- kubectl get - Display one or many resources
- kubectl kustomize - Build a kustomization target from a directory or URL
- kubectl label - Update the labels on a resource
- kubectl logs - Print the logs for a container in a pod
- kubectl options - Print the list of flags inherited by all commands
- kubectl patch - Update fields of a resource
- kubectl plugin - Provides utilities for interacting with plugins
- kubectl port-forward - Forward one or more local ports to a pod
- kubectl proxy - Run a proxy to the Kubernetes API server
- kubectl replace - Replace a resource by file name or stdin
- kubectl rollout - Manage the rollout of a resource
- kubectl run - Run a particular image on the cluster
- kubectl scale - Set a new size for a deployment, replica set, or replication controller
- kubectl set - Set specific features on objects
- kubectl taint - Update the taints on one or more nodes
- kubectl top - Display resource (CPU/memory) usage
- kubectl uncordon - Mark node as schedulable
- kubectl version - Print the client and server version information
- kubectl wait - Experimental: Wait for a specific condition on one or many resources
This 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.