You are viewing documentation for Kubernetes version: v1.30
Kubernetes v1.30 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date information, see the latest version.
kubectl plugin
Synopsis
Provides utilities for interacting with plugins.
Plugins provide extended functionality that is not part of the major command-line distribution. Please refer to the documentation and examples for more information about how write your own plugins.
The easiest way to discover and install plugins is via the kubernetes sub-project krew. To install krew, visit https://krew.sigs.k8s.io/docs/user-guide/setup/install/ krew.sigs.k8s.io https://krew.sigs.k8s.io/docs/user-guide/setup/install/
kubectl plugin [flags]
Options
| -h, --help | |
help for plugin |
|
| --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 |
|
| --cloud-provider-gce-l7lb-src-cidrs cidrs Default: 130.211.0.0/22,35.191.0.0/16 | |
CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks |
|
| --cloud-provider-gce-lb-src-cidrs cidrs Default: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16 | |
CIDRs opened in GCE firewall for L4 LB traffic proxy & health checks |
|
| --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 |
|
| --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 - kubectl controls the Kubernetes cluster manager
- kubectl plugin list - List all visible plugin executables on a user's PATH
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.