337 lines
12 KiB
Markdown
337 lines
12 KiB
Markdown
---
|
|
title: kubectl
|
|
content_type: tool-reference
|
|
weight: 30
|
|
auto_generated: true
|
|
---
|
|
|
|
|
|
<!--
|
|
The file is auto-generated from the Go source code of the component using a generic
|
|
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
|
|
to generate the reference documentation, please read
|
|
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
|
|
To update the reference content, please follow the
|
|
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
|
|
guide. You can file document formatting bugs against the
|
|
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
|
|
-->
|
|
|
|
|
|
## {{% heading "synopsis" %}}
|
|
|
|
|
|
kubectl controls the Kubernetes cluster manager.
|
|
|
|
Find more information at: https://kubernetes.io/docs/reference/kubectl/
|
|
|
|
```
|
|
kubectl [flags]
|
|
```
|
|
|
|
## {{% heading "options" %}}
|
|
|
|
<table style="width: 100%; table-layout: fixed;">
|
|
<colgroup>
|
|
<col span="1" style="width: 10px;" />
|
|
<col span="1" />
|
|
</colgroup>
|
|
<tbody>
|
|
|
|
<tr>
|
|
<td colspan="2">--as string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username to impersonate for the operation. User could be a regular user or a service account in a namespace.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--as-group strings</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Group to impersonate for the operation, this flag can be repeated to specify multiple groups.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--as-uid string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>UID to impersonate for the operation.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--cache-dir string Default: "$HOME/.kube/cache"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Default cache directory</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--certificate-authority string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a cert file for the certificate authority</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--client-certificate string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client certificate file for TLS</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--client-key string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to a client key file for TLS</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--cluster string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig cluster to use</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--context string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig context to use</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--default-not-ready-toleration-seconds int Default: 300</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--default-unreachable-toleration-seconds int Default: 300</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--disable-compression</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, opt-out of response compression for all requests to the server</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">-h, --help</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>help for kubectl</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--insecure-skip-tls-verify</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--kubeconfig string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Path to the kubeconfig file to use for CLI requests.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--match-server-version</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Require server version to match client version</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">-n, --namespace string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>If present, the namespace scope for this CLI request</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--password string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Password for basic authentication to the API server</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--profile string Default: "none"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--profile-output string Default: "profile.pprof"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Name of the file to write the profile to</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--request-timeout string Default: "0"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>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.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">-s, --server string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The address and port of the Kubernetes API server</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-buffer-duration duration Default: 1m0s</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-db string Default: "cadvisor"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database name</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-host string Default: "localhost:8086"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database host:port</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-password string Default: "root"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database password</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-secure</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>use secure connection with database</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-table string Default: "stats"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>table name</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--storage-driver-user string Default: "root"</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>database username</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--tls-server-name string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--token string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Bearer token for authentication to the API server</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--user string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>The name of the kubeconfig user to use</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--username string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Username for basic authentication to the API server</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--version version[=true]</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td colspan="2">--warnings-as-errors</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td><td style="line-height: 130%; word-wrap: break-word;"><p>Treat warnings received from the server as errors and exit with a non-zero exit code</p></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
## {{% heading "seealso" %}}
|
|
|
|
* [kubectl annotate](../kubectl_annotate/) - Update the annotations on a resource
|
|
* [kubectl api-resources](../kubectl_api-resources/) - Print the supported API resources on the server
|
|
* [kubectl api-versions](../kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version"
|
|
* [kubectl apply](../kubectl_apply/) - Apply a configuration to a resource by file name or stdin
|
|
* [kubectl attach](../kubectl_attach/) - Attach to a running container
|
|
* [kubectl auth](../kubectl_auth/) - Inspect authorization
|
|
* [kubectl autoscale](../kubectl_autoscale/) - Auto-scale a deployment, replica set, stateful set, or replication controller
|
|
* [kubectl certificate](../kubectl_certificate/) - Modify certificate resources
|
|
* [kubectl cluster-info](../kubectl_cluster-info/) - Display cluster information
|
|
* [kubectl completion](../kubectl_completion/) - Output shell completion code for the specified shell (bash, zsh, fish, or powershell)
|
|
* [kubectl config](../kubectl_config/) - Modify kubeconfig files
|
|
* [kubectl cordon](../kubectl_cordon/) - Mark node as unschedulable
|
|
* [kubectl cp](../kubectl_cp/) - Copy files and directories to and from containers
|
|
* [kubectl create](../kubectl_create/) - Create a resource from a file or from stdin
|
|
* [kubectl debug](../kubectl_debug/) - Create debugging sessions for troubleshooting workloads and nodes
|
|
* [kubectl delete](../kubectl_delete/) - Delete resources by file names, stdin, resources and names, or by resources and label selector
|
|
* [kubectl describe](../kubectl_describe/) - Show details of a specific resource or group of resources
|
|
* [kubectl diff](../kubectl_diff/) - Diff the live version against a would-be applied version
|
|
* [kubectl drain](../kubectl_drain/) - Drain node in preparation for maintenance
|
|
* [kubectl edit](../kubectl_edit/) - Edit a resource on the server
|
|
* [kubectl events](../kubectl_events/) - List events
|
|
* [kubectl exec](../kubectl_exec/) - Execute a command in a container
|
|
* [kubectl explain](../kubectl_explain/) - Get documentation for a resource
|
|
* [kubectl expose](../kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes service
|
|
* [kubectl get](../kubectl_get/) - Display one or many resources
|
|
* [kubectl kustomize](../kubectl_kustomize/) - Build a kustomization target from a directory or URL
|
|
* [kubectl label](../kubectl_label/) - Update the labels on a resource
|
|
* [kubectl logs](../kubectl_logs/) - Print the logs for a container in a pod
|
|
* [kubectl options](../kubectl_options/) - Print the list of flags inherited by all commands
|
|
* [kubectl patch](../kubectl_patch/) - Update fields of a resource
|
|
* [kubectl plugin](../kubectl_plugin/) - Provides utilities for interacting with plugins
|
|
* [kubectl port-forward](../kubectl_port-forward/) - Forward one or more local ports to a pod
|
|
* [kubectl proxy](../kubectl_proxy/) - Run a proxy to the Kubernetes API server
|
|
* [kubectl replace](../kubectl_replace/) - Replace a resource by file name or stdin
|
|
* [kubectl rollout](../kubectl_rollout/) - Manage the rollout of a resource
|
|
* [kubectl run](../kubectl_run/) - Run a particular image on the cluster
|
|
* [kubectl scale](../kubectl_scale/) - Set a new size for a deployment, replica set, or replication controller
|
|
* [kubectl set](../kubectl_set/) - Set specific features on objects
|
|
* [kubectl taint](../kubectl_taint/) - Update the taints on one or more nodes
|
|
* [kubectl top](../kubectl_top/) - Display resource (CPU/memory) usage
|
|
* [kubectl uncordon](../kubectl_uncordon/) - Mark node as schedulable
|
|
* [kubectl version](../kubectl_version/) - Print the client and server version information
|
|
* [kubectl wait](../kubectl_wait/) - Experimental: Wait for a specific condition on one or many resources
|
|
|