content large_stringlengths 3 20.5k | url large_stringlengths 54 193 | branch large_stringclasses 4 values | source large_stringclasses 42 values | embeddings listlengths 384 384 | score float64 -0.21 0.65 |
|---|---|---|---|---|---|
| | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_api-versions/_index.md | main | kubernetes | [
0.006926718633621931,
0.04775698855519295,
-0.0639820545911789,
0.004822997376322746,
-0.05836129188537598,
-0.009063953533768654,
0.012504618614912033,
0.03747840225696564,
0.044203981757164,
-0.01929897628724575,
-0.028421133756637573,
-0.12972436845302582,
0.09957721084356308,
-0.017334... | 0.110729 |
## {{% heading "synopsis" %}} Execute a command in a container. ``` kubectl exec (POD | TYPE/NAME) [-c CONTAINER] [flags] -- COMMAND [args...] ``` ## {{% heading "examples" %}} ``` # Get output from running the 'date' command from pod mypod, using the first container by default kubectl exec mypod -- date # Get output from running the 'date' command in ruby-container from pod mypod kubectl exec mypod -c ruby-container -- date # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod # and sends stdout/stderr from 'bash' back to the client kubectl exec mypod -c ruby-container -i -t -- bash -il # List contents of /usr from the first container of pod mypod and sort by modification time # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr") kubectl exec mypod -i -t -- ls -t /usr # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default kubectl exec deploy/mydeployment -- date # Get output from running 'date' command from the first pod of the service myservice, using the first container by default kubectl exec svc/myservice -- date ``` ## {{% heading "options" %}} | -c, --container string | | | --- | --- | | | Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen | | -f, --filename strings | | | | to use to exec into the resource | | -h, --help | | | | help for exec | | --pod-running-timeout duration Default: 1m0s | | | | The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running | | -q, --quiet | | | | Only print output from the remote session | | -i, --stdin | | | | Pass stdin to the container | | -t, --tty | | | | Stdin is a TTY | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --disable-compression | | | | If true, opt-out of response compression for all | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_exec/_index.md | main | kubernetes | [
0.050580766052007675,
0.02166559547185898,
0.02421736903488636,
0.03884243592619896,
-0.03785247355699539,
0.016280051320791245,
-0.025386206805706024,
0.06224846467375755,
0.020509587600827217,
0.0281208548694849,
-0.020397214218974113,
-0.049774352461099625,
-0.03998713195323944,
-0.0149... | 0.07016 |
file for TLS | | --cluster string | | | | The name of the kubeconfig cluster to use | | --context string | | | | The name of the kubeconfig context to use | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_exec/_index.md | main | kubernetes | [
-0.013490872457623482,
0.04913942515850067,
-0.009798124432563782,
-0.00783325731754303,
-0.0754423588514328,
-0.01682891510426998,
-0.025413615629076958,
-0.0609951876103878,
0.06902533024549484,
-0.027134424075484276,
-0.034880924969911575,
-0.1019795686006546,
0.034843940287828445,
0.00... | 0.064914 |
## {{% heading "synopsis" %}} Update fields of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. JSON and YAML formats are accepted. Note: Strategic merge patch is not supported for custom resources. ``` kubectl patch (-f FILENAME | TYPE NAME) [-p PATCH|--patch-file FILE] ``` ## {{% heading "examples" %}} ``` # Partially update a node using a strategic merge patch, specifying the patch as JSON kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' # Partially update a node using a strategic merge patch, specifying the patch as YAML kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true' # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}' # Update a container's image; spec.containers[\*].name is required because it's a merge key kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}' # Update a container's image using a JSON patch with positional arrays kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' # Update a deployment's replicas through the 'scale' subresource using a merge patch kubectl patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}' ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | --field-manager string Default: "kubectl-patch" | | | | Name of the manager used to track field ownership. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to update | | -h, --help | | | | help for patch | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | --local | | | | If true, patch will operate on the content of the file, not the server-side resource. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | -p, --patch string | | | | The patch to be applied to the resource JSON file. | | --patch-file string | | | | A file containing a patch to be applied to the resource. | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --subresource string | | | | If specified, patch will operate on the subresource of the requested object. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | --type string Default: "strategic" | | | | The type of patch being provided; one of [json merge strategic] | ## {{% heading "parentoptions" %}} | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_patch/_index.md | main | kubernetes | [
-0.036677416414022446,
0.06524956226348877,
0.06175949051976204,
-0.00870838388800621,
-0.01989612728357315,
0.011708399280905724,
-0.02624000981450081,
-0.011411739513278008,
0.011496564373373985,
0.055927641689777374,
0.003813366638496518,
-0.03726398944854736,
0.0065411836840212345,
-0.... | 0.125178 |
heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_patch/_index.md | main | kubernetes | [
-0.01926860399544239,
0.05096229910850525,
-0.040171511471271515,
-0.020051615312695503,
-0.0798175260424614,
-0.05382998660206795,
0.11154261976480484,
-0.012031023390591145,
0.043528005480766296,
-0.014240343123674393,
0.0476793497800827,
-0.10386577248573303,
0.05898642539978027,
-0.013... | 0.037251 |
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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_patch/_index.md | main | kubernetes | [
0.012425383552908897,
0.08783390372991562,
-0.0017476478824391961,
0.018680155277252197,
0.00582584273070097,
0.013730294071137905,
-0.004873279947787523,
-0.023249566555023193,
0.04002055525779724,
-0.027625910937786102,
-0.04382102191448212,
-0.12157654017210007,
0.06962104886770248,
-0.... | 0.138063 |
## {{% heading "synopsis" %}} Drain node in preparation for maintenance. The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the API server supports https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ eviction https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ . Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server). If there are daemon set-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any daemon set-managed pods, because those pods would be immediately replaced by the daemon set controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by a replication controller, replica set, daemon set, stateful set, or job, then drain will not delete any pods unless you use --force. --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 'drain' waits for graceful termination. You should not operate on the machine until the command completes. When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. https://kubernetes.io/images/docs/kubectl\_drain.svg Workflowhttps://kubernetes.io/images/docs/kubectl\_drain.svg ``` kubectl drain NODE ``` ## {{% heading "examples" %}} ``` # Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set on it kubectl drain foo --force # As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set, and use a grace period of 15 minutes kubectl drain foo --grace-period=900 ``` ## {{% heading "options" %}} | --chunk-size int Default: 500 | | | --- | --- | | | Return large lists in chunks rather than all at once. Pass 0 to disable. | | --delete-emptydir-data | | | | Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). | | --disable-eviction | | | | Force drain to use delete, even if eviction is supported. This will bypass checking PodDisruptionBudgets, use with caution. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | --force | | | | Continue even if there are pods that do not declare a controller. | | --grace-period int Default: -1 | | | | Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. | | -h, --help | | | | help for drain | | --ignore-daemonsets | | | | Ignore DaemonSet-managed pods. | | --pod-selector string | | | | Label selector to filter pods on the node | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --skip-wait-for-delete-timeout int | | | | If pod DeletionTimestamp older than N seconds, skip waiting for the pod. Seconds must be greater than 0 to skip. | | --timeout duration | | | | The length of time to wait before giving up, zero means infinite | ## {{% heading "parentoptions" %}} | --as string | | | --- | --- | | | Username to impersonate for the operation. User could be a regular user or a | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_drain/_index.md | main | kubernetes | [
-0.019596265628933907,
0.034570224583148956,
0.09317512065172195,
0.047413554042577744,
0.00837706495076418,
-0.030612101778388023,
-0.005373677238821983,
-0.0723557248711586,
0.10634986311197281,
0.07347755134105682,
-0.02170121669769287,
0.028319787234067917,
-0.030784765258431435,
-0.05... | 0.200411 |
--timeout duration | | | | The length of time to wait before giving up, zero means infinite | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_drain/_index.md | main | kubernetes | [
-0.017757870256900787,
0.08818703144788742,
-0.04420612379908562,
0.007804160937666893,
-0.06579150259494781,
-0.06973151862621307,
0.07149950414896011,
-0.007868236862123013,
0.058380357921123505,
-0.009957706555724144,
0.05525205284357071,
-0.05644259229302406,
0.006084189284592867,
-0.0... | 0.049047 |
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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_drain/_index.md | main | kubernetes | [
0.02073049545288086,
0.061819419264793396,
0.0036530867218971252,
0.005349702667444944,
-0.046609073877334595,
-0.012744610197842121,
-0.0211318489164114,
-0.007950336672365665,
0.03991957753896713,
-0.011635142378509045,
-0.044924162328243256,
-0.13116252422332764,
0.08338893204927444,
-0... | 0.076584 |
## {{% heading "synopsis" %}} Update the labels on a resource. \* A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters each. \* Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app. \* If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. \* If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. ``` kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY\_1=VAL\_1 ... KEY\_N=VAL\_N [--resource-version=version] ``` ## {{% heading "examples" %}} ``` # Update pod 'foo' with the label 'unhealthy' and the value 'true' kubectl label pods foo unhealthy=true # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value kubectl label --overwrite pods foo status=unhealthy # Update all pods in the namespace kubectl label pods --all status=unhealthy # Update a pod identified by the type and name in "pod.json" kubectl label -f pod.json status=unhealthy # Update pod 'foo' only if the resource is unchanged from version 1 kubectl label pods foo status=unhealthy --resource-version=1 # Update pod 'foo' by removing a label named 'bar' if it exists # Does not require the --overwrite flag kubectl label pods foo bar- ``` ## {{% heading "options" %}} | --all | | | --- | --- | | | Select all resources, in the namespace of the specified resource types | | -A, --all-namespaces | | | | If true, check the specified action in all namespaces. | | --allow-missing-template-keys Default: true | | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | --field-manager string Default: "kubectl-label" | | | | Name of the manager used to track field ownership. | | --field-selector string | | | | Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to update the labels | | -h, --help | | | | help for label | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | --list | | | | If true, display the labels for a given resource. | | --local | | | | If true, label will NOT contact api-server but run locally. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | --overwrite | | | | If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --resource-version string | | | | If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. | | -l, --selector | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_label/_index.md | main | kubernetes | [
-0.012999586760997772,
0.049494143575429916,
0.051221445202827454,
-0.027823928743600845,
-0.025169726461172104,
-0.0035065978299826384,
0.03337905928492546,
-0.03256230801343918,
0.046940650790929794,
0.010598213411867619,
-0.0025316851679235697,
-0.06148985028266907,
0.02274743840098381,
... | 0.085867 |
recursively. Useful when you want to manage related manifests organized within the same directory. | | --resource-version string | | | | If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_label/_index.md | main | kubernetes | [
-0.0019531387370079756,
0.10429372638463974,
-0.01817949302494526,
-0.03701074793934822,
0.016189729794859886,
0.02415408194065094,
0.05940474569797516,
-0.01864464581012726,
-0.0031626191921532154,
-0.09511592984199524,
0.057964254170656204,
-0.04655638709664345,
0.0020319242030382156,
0.... | 0.117289 |
--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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_label/_index.md | main | kubernetes | [
0.044846709817647934,
0.03228430449962616,
-0.0411759652197361,
0.00679504219442606,
-0.06456972658634186,
-0.006941088940948248,
0.020866649225354195,
-0.0024229635018855333,
0.13883432745933533,
0.038227539509534836,
-0.020581280812621117,
-0.1003536731004715,
0.08167579770088196,
-0.019... | 0.101129 |
## {{% heading "synopsis" %}} Experimental: Check who you are and your attributes (groups, extra). This command is helpful to get yourself aware of the current user attributes, especially when dynamic authentication, e.g., token webhook, auth proxy, or OIDC provider, is enabled in the Kubernetes cluster. ``` kubectl auth whoami ``` ## {{% heading "examples" %}} ``` # Get your subject attributes kubectl auth whoami # Get your subject attributes in JSON format kubectl auth whoami -o json ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | -h, --help | | | | help for whoami | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/kubectl_auth_whoami.md | main | kubernetes | [
0.012368825264275074,
0.11328091472387314,
0.0619179904460907,
0.017905252054333687,
0.00979836005717516,
-0.005255491007119417,
-0.013375585898756981,
-0.005699346773326397,
0.03721226379275322,
-0.019044989719986916,
-0.01954769343137741,
-0.15105393528938293,
-0.004149561747908592,
0.00... | 0.068404 |
| | | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl auth](../) - Inspect authorization | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/kubectl_auth_whoami.md | main | kubernetes | [
0.06153656914830208,
0.04630650579929352,
-0.08219816535711288,
0.023165928199887276,
-0.029876243323087692,
0.0068366797640919685,
0.024081174284219742,
0.06538044661283493,
0.06552503257989883,
0.021762559190392494,
0.019651900976896286,
-0.06267552822828293,
0.02443157695233822,
-0.0562... | 0.079133 |
## {{% heading "synopsis" %}} Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects. Missing objects are created, and the containing namespace is created for namespaced objects, if required. Existing roles are updated to include the permissions in the input objects, and remove extra permissions if --remove-extra-permissions is specified. Existing bindings are updated to include the subjects in the input objects, and remove extra subjects if --remove-extra-subjects is specified. This is preferred to 'apply' for RBAC resources so that semantically-aware merging of rules and subjects is done. ``` kubectl auth reconcile -f FILENAME ``` ## {{% heading "examples" %}} ``` # Reconcile RBAC resources from a file kubectl auth reconcile -f my-rbac-rules.yaml ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to reconcile. | | -h, --help | | | | help for reconcile | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --remove-extra-permissions | | | | If true, removes extra permissions added to roles | | --remove-extra-subjects | | | | If true, removes extra subjects added to rolebindings | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --disable-compression | | | | If true, opt-out of response compression for all requests to the | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/kubectl_auth_reconcile.md | main | kubernetes | [
-0.01684066653251648,
0.005027341656386852,
-0.014012536965310574,
0.05068332329392433,
0.0015274669276550412,
0.006521274335682392,
-0.008141996338963509,
-0.07053812593221664,
0.014478703960776329,
-0.006695025600492954,
-0.0013676491798833013,
-0.043931517750024796,
0.05217115581035614,
... | 0.104551 |
| | --cluster string | | | | The name of the kubeconfig cluster to use | | --context string | | | | The name of the kubeconfig context to use | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl auth](../) - Inspect authorization | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/kubectl_auth_reconcile.md | main | kubernetes | [
-0.010287727229297161,
0.04045521840453148,
-0.014571359381079674,
-0.0010464584920555353,
-0.0705762580037117,
-0.00745211960747838,
-0.0288222786039114,
-0.06297985464334488,
0.04771438613533974,
-0.039355624467134476,
-0.030870262533426285,
-0.1111326813697815,
0.04095853865146637,
0.00... | 0.060468 |
## {{% heading "synopsis" %}} Check whether an action is allowed. VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL that starts with "/". NAME is the name of a particular Kubernetes resource. This command pairs nicely with impersonation. See --as global flag. ``` kubectl auth can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL] ``` ## {{% heading "examples" %}} ``` # Check to see if I can create pods in any namespace kubectl auth can-i create pods --all-namespaces # Check to see if I can list deployments in my current namespace kubectl auth can-i list deployments.apps # Check to see if service account "foo" of namespace "dev" can list pods in the namespace "prod" # You must be allowed to use impersonation for the global option "--as" kubectl auth can-i list pods --as=system:serviceaccount:dev:foo -n prod # Check to see if I can do everything in my current namespace ("\*" means all) kubectl auth can-i '\*' '\*' # Check to see if I can get the job named "bar" in namespace "foo" kubectl auth can-i list jobs.batch/bar -n foo # Check to see if I can read pod logs kubectl auth can-i get pods --subresource=log # Check to see if I can access the URL /logs/ kubectl auth can-i get /logs/ # Check to see if I can approve certificates.k8s.io kubectl auth can-i approve certificates.k8s.io # List all allowed actions in namespace "foo" kubectl auth can-i --list --namespace=foo ``` ## {{% heading "options" %}} | -A, --all-namespaces | | | --- | --- | | | If true, check the specified action in all namespaces. | | -h, --help | | | | help for can-i | | --list | | | | If true, prints all allowed actions. | | --no-headers | | | | If true, prints allowed actions without headers | | -q, --quiet | | | | If true, suppress output and just return the exit code. | | --subresource string | | | | SubResource such as pod/log or deployment/scale | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/kubectl_auth_can-i.md | main | kubernetes | [
-0.027300141751766205,
-0.0018208971014246345,
0.0004778188595082611,
0.018820924684405327,
-0.0009632541332393885,
-0.02825905941426754,
0.04125268757343292,
-0.05229618400335312,
0.057358335703611374,
0.031448930501937866,
-0.00827203132212162,
-0.09600555151700974,
0.020037885755300522,
... | 0.129648 |
| | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl auth](../) - Inspect authorization | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/kubectl_auth_can-i.md | main | kubernetes | [
-0.024918653070926666,
0.07433940470218658,
0.019209567457437515,
-0.014263056218624115,
-0.05987798050045967,
-0.027589598670601845,
-0.051917728036642075,
-0.06785847991704941,
0.08332071453332901,
-0.008467527106404305,
-0.05580417811870575,
-0.11012149602174759,
0.031501561403274536,
0... | 0.042423 |
## {{% heading "synopsis" %}} Inspect authorization. ``` kubectl auth [flags] ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for auth | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/_index.md | main | kubernetes | [
-0.007831035181879997,
0.07679566740989685,
-0.01683751679956913,
-0.003835180541500449,
-0.07946312427520752,
-0.02626829594373703,
0.10305189341306686,
-0.007979432120919228,
0.02379642426967621,
0.005839098244905472,
0.006723709870129824,
-0.11746753752231598,
-0.007984786294400692,
-0.... | 0.074686 |
| --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager \* [kubectl auth can-i](kubectl\_auth\_can-i/) - Check whether an action is allowed \* [kubectl auth reconcile](kubectl\_auth\_reconcile/) - Reconciles rules for RBAC role, role binding, cluster role, and cluster role binding objects \* [kubectl auth whoami](kubectl\_auth\_whoami/) - Experimental: Check self subject attributes | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_auth/_index.md | main | kubernetes | [
0.02365819364786148,
0.07470757514238358,
-0.025043269619345665,
0.017253169789910316,
-0.0462014302611351,
-0.024011678993701935,
-0.0009415118838660419,
0.02196679078042507,
0.033910419791936874,
-0.016501393169164658,
-0.03083488903939724,
-0.1537303477525711,
0.09546376764774323,
-0.00... | 0.071521 |
## {{% heading "synopsis" %}} Copy files and directories to and from containers. ``` kubectl cp ``` ## {{% heading "examples" %}} ``` # !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image. If 'tar' is not present, 'kubectl cp' will fail. # # For advanced use cases, such as symlinks, wildcard expansion or # file mode preservation, consider using 'kubectl exec'. # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace tar cf - /tmp/foo | kubectl exec -i -n -- tar xf - -C /tmp/bar # Copy /tmp/foo from a remote pod to /tmp/bar locally kubectl exec -n -- tar cf - /tmp/foo | tar xf - -C /tmp/bar # Copy /tmp/foo\_dir local directory to /tmp/bar\_dir in a remote pod in the default namespace kubectl cp /tmp/foo\_dir :/tmp/bar\_dir # Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container kubectl cp /tmp/foo :/tmp/bar -c # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace kubectl cp /tmp/foo /:/tmp/bar # Copy /tmp/foo from a remote pod to /tmp/bar locally kubectl cp /:/tmp/foo /tmp/bar ``` ## {{% heading "options" %}} | -c, --container string | | | --- | --- | | | Container name. If omitted, use the kubectl.kubernetes.io/default-container annotation for selecting the container to be attached or the first container in the pod will be chosen | | -h, --help | | | | help for cp | | --no-preserve | | | | The copied file/directory's ownership and permissions will not be preserved in the container | | --retries int | | | | Set number of retries to complete a copy operation from a container. Specify 0 to disable or any negative value for infinite retrying. The default is 0 (no retry). | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-version | | | | Require | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_cp/_index.md | main | kubernetes | [
-0.0011184700997546315,
0.03590847924351692,
0.06701891124248505,
-0.009912225417792797,
0.019825736060738564,
-0.004897939506918192,
0.0012056550476700068,
0.05674659460783005,
0.011803853325545788,
0.004775079898536205,
0.025781163945794106,
-0.10396777093410492,
-0.0018041417934000492,
... | 0.064102 |
Path to the kubeconfig file to use for CLI requests. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_cp/_index.md | main | kubernetes | [
-0.019888052716851234,
0.0005752964643761516,
-0.022018341347575188,
-0.02209566719830036,
-0.04340651258826256,
0.01780710183084011,
-0.007307331543415785,
0.019029641523957253,
0.04293156415224075,
0.004787974525243044,
-0.008029665797948837,
-0.1169433444738388,
-0.0015330084133893251,
... | 0.059368 |
## {{% heading "synopsis" %}} Forward one or more local ports to a pod. Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and a rerun of the command is needed to resume forwarding. ``` kubectl port-forward TYPE/NAME [options] [LOCAL\_PORT:]REMOTE\_PORT [...[LOCAL\_PORT\_N:]REMOTE\_PORT\_N] ``` ## {{% heading "examples" %}} ``` # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod kubectl port-forward pod/mypod 5000 6000 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment kubectl port-forward deployment/mydeployment 5000 6000 # Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service kubectl port-forward service/myservice 8443:https # Listen on port 8888 locally, forwarding to 5000 in the pod kubectl port-forward pod/mypod 8888:5000 # Listen on port 8888 on all addresses, forwarding to 5000 in the pod kubectl port-forward --address 0.0.0.0 pod/mypod 8888:5000 # Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod kubectl port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000 # Listen on a random port locally, forwarding to 5000 in the pod kubectl port-forward pod/mypod :5000 ``` ## {{% heading "options" %}} | --address strings Default: "localhost" | | | --- | --- | | | Addresses to listen on (comma separated). Only accepts IP addresses or localhost as a value. When localhost is supplied, kubectl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind. | | -h, --help | | | | help for port-forward | | --pod-running-timeout duration Default: 1m0s | | | | The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_port-forward/_index.md | main | kubernetes | [
0.07293648272752762,
-0.0060709635727107525,
0.05414815992116928,
-0.0023274668492376804,
-0.036071017384529114,
0.01428054179996252,
-0.0063310656696558,
0.004204210359603167,
-0.014038972556591034,
0.06297935545444489,
-0.04004824161529541,
-0.06482531875371933,
-0.006166751496493816,
-0... | 0.110847 |
| --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_port-forward/_index.md | main | kubernetes | [
-0.015173605643212795,
0.028647253289818764,
0.003873241599649191,
-0.0421191044151783,
-0.07231345772743225,
-0.00843961164355278,
-0.02009115368127823,
-0.039906907826662064,
0.06260709464550018,
-0.023349136114120483,
-0.02518875151872635,
-0.134470596909523,
0.03983733057975769,
0.0060... | 0.028388 |
## {{% heading "synopsis" %}} Replace a resource by file name or stdin. JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by $ kubectl get TYPE NAME -o yaml ``` kubectl replace -f FILENAME ``` ## {{% heading "examples" %}} ``` # Replace a pod using the data in pod.json kubectl replace -f ./pod.json # Replace a pod based on the JSON passed into stdin cat pod.json | kubectl replace -f - # Update a single-container pod's image version (tag) to v4 kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.\*$/\1:v4/' | kubectl replace -f - # Force replace, delete and then re-create the resource kubectl replace --force -f ./pod.json ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --cascade string[="background"] Default: "background" | | | | Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | --field-manager string Default: "kubectl-replace" | | | | Name of the manager used to track field ownership. | | -f, --filename strings | | | | The files that contain the configurations to replace. | | --force | | | | If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. | | --grace-period int Default: -1 | | | | Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). | | -h, --help | | | | help for replace | | -k, --kustomize string | | | | Process a kustomization directory. This flag can't be used together with -f or -R. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | --raw string | | | | Raw URI to PUT to the server. Uses the transport specified by the kubeconfig file. | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --save-config | | | | If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --subresource string | | | | If specified, replace will operate on the subresource of the requested object. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | --timeout duration | | | | The length of time to wait before giving up on a delete, zero means determine | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_replace/_index.md | main | kubernetes | [
0.03944283723831177,
0.07159137725830078,
0.08989399671554565,
0.013945049606263638,
0.02008647657930851,
-0.006708941888064146,
-0.005986351054161787,
0.011441798880696297,
0.04263520985841751,
0.014435055665671825,
-0.011397596448659897,
-0.05919326841831207,
-0.023944726213812828,
0.012... | 0.064435 |
| | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | --timeout duration | | | | The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object | | --validate string[="strict"] Default: "strict" | | | | Must be one of: strict (or true), warn, ignore (or false). "true" or "strict" will use a schema to validate the input and fail the request if invalid. It will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not. "warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise. "false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields. | | --wait | | | | If true, wait for resources to be gone before returning. This waits for finalizers. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_replace/_index.md | main | kubernetes | [
-0.01835133507847786,
0.12473848462104797,
-0.04672933369874954,
-0.022066880017518997,
0.010611671023070812,
0.023823875933885574,
-0.008256295695900917,
-0.00037711000186391175,
0.05224664881825447,
-0.06921001523733139,
0.040231335908174515,
-0.004093831870704889,
0.0003280331438872963,
... | 0.079423 |
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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_replace/_index.md | main | kubernetes | [
0.07461893558502197,
0.024266617372632027,
-0.07281578332185745,
0.04796551540493965,
-0.08637144416570663,
0.008693916723132133,
0.0061714984476566315,
0.06528662890195847,
0.068369559943676,
0.04374644532799721,
0.003871725406497717,
-0.056281402707099915,
0.04111037403345108,
-0.0593216... | 0.0751 |
## {{% heading "synopsis" %}} Display one or many resources. Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in the current namespace if you don't specify any namespace. By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources. Use "kubectl api-resources" for a complete list of supported resources. ``` kubectl get [(-o|--output=)json|yaml|kyaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file|custom-columns|custom-columns-file|wide] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags] ``` ## {{% heading "examples" %}} ``` # List all pods in ps output format kubectl get pods # List all pods in ps output format with more information (such as node name) kubectl get pods -o wide # List a single replication controller with specified NAME in ps output format kubectl get replicationcontroller web # List deployments in JSON output format, in the "v1" version of the "apps" API group kubectl get deployments.v1.apps -o json # List a single pod in JSON output format kubectl get -o json pod web-pod-13je7 # List a pod identified by type and name specified in "pod.yaml" in JSON output format kubectl get -f pod.yaml -o json # List resources from a directory with kustomization.yaml - e.g. dir/kustomization.yaml kubectl get -k dir/ # Return only the phase value of the specified pod kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} # List resource information in custom columns kubectl get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image # List all replication controllers and services together in ps output format kubectl get rc,services # List one or more resources by their type and names kubectl get rc/web service/frontend pods/web-pod-13je7 # List the 'status' subresource for a single pod kubectl get pod web-pod-13je7 --subresource status # List all deployments in namespace 'backend' kubectl get deployments.apps --namespace backend # List all pods existing in all namespaces kubectl get pods --all-namespaces ``` ## {{% heading "options" %}} | -A, --all-namespaces | | | --- | --- | | | If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | | --allow-missing-template-keys Default: true | | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --chunk-size int Default: 500 | | | | Return large lists in chunks rather than all at once. Pass 0 to disable. | | --field-selector string | | | | Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to get from a server. | | -h, --help | | | | help for get | | --ignore-not-found | | | | If set to true, suppresses NotFound error for specific objects that do not exist. Using this flag with commands that query for collections of resources has no effect when no resources are found. | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | -L, --label-columns strings | | | | Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_get/_index.md | main | kubernetes | [
0.05298260599374771,
0.09961889684200287,
-0.02088293991982937,
0.02410126104950905,
0.022726401686668396,
0.032279450446367264,
0.0033821607939898968,
-0.03113756701350212,
0.08881910145282745,
-0.0390319861471653,
-0.013820447959005833,
-0.09977847337722778,
-0.011192099191248417,
-0.002... | 0.009327 |
directory. This flag can't be used together with -f or -R. | | -L, --label-columns strings | | | | Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... | | --no-headers | | | | When using the default or custom-column output format, don't print headers (default print headers). | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns [https://kubernetes.io/docs/reference/kubectl/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/]. | | --output-watch-events | | | | Output watch event objects when --watch or --watch-only is used. Existing objects are output as initial ADDED events. | | --raw string | | | | Raw URI to request from the server. Uses the transport specified by the kubeconfig file. | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --server-print Default: true | | | | If true, have the server return the appropriate table output. Supports extension APIs and CRDs. | | --show-kind | | | | If present, list the resource type for the requested object(s). | | --show-labels | | | | When printing, show all labels as the last column (default hide labels column) | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --sort-by string | | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. | | --subresource string | | | | If specified, gets the subresource of the requested object. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | -w, --watch | | | | After listing/getting the requested object, watch for changes. | | --watch-only | | | | Watch for changes to the requested object(s), without listing/getting first. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_get/_index.md | main | kubernetes | [
0.05147970840334892,
0.10953928530216217,
-0.10117875039577484,
-0.048692524433135986,
0.014196381904184818,
0.059294238686561584,
-0.023129453882575035,
0.03998330980539322,
0.05706299468874931,
-0.04742502048611641,
0.10658743977546692,
-0.08462592214345932,
-0.02381777949631214,
0.04648... | 0.022296 |
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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_get/_index.md | main | kubernetes | [
-0.0279762614518404,
0.06302154064178467,
0.0019514808664098382,
-0.009046110324561596,
-0.06595027446746826,
-0.02938474714756012,
-0.036537736654281616,
-0.06334038078784943,
0.09155720472335815,
-0.04038531705737114,
-0.00642595486715436,
-0.087058424949646,
0.06145612522959709,
0.01019... | 0.042397 |
manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_get/_index.md | main | kubernetes | [
-0.06050267443060875,
0.03015855699777603,
-0.01637798547744751,
0.06663832068443298,
-0.01916760578751564,
-0.017294373363256454,
0.12631051242351532,
0.01701965183019638,
-0.007665052078664303,
0.045752402395009995,
0.03871450200676918,
-0.0927233099937439,
-0.018894556909799576,
0.01855... | 0.163862 |
## {{% heading "synopsis" %}} Diff configurations specified by file name or stdin between the current online configuration, and the configuration as it would be if applied. The output is always YAML. KUBECTL\_EXTERNAL\_DIFF environment variable can be used to select your own diff command. Users can use external commands with params too, example: KUBECTL\_EXTERNAL\_DIFF="colordiff -N -u" By default, the "diff" command available in your path will be run with the "-u" (unified diff) and "-N" (treat absent files as empty) options. Exit status: 0 No differences were found. 1 Differences were found. >1 Kubectl or diff failed with an error. Note: KUBECTL\_EXTERNAL\_DIFF, if used, is expected to follow that convention. ``` kubectl diff -f FILENAME ``` ## {{% heading "examples" %}} ``` # Diff resources included in pod.json kubectl diff -f pod.json # Diff file read from stdin cat service.yaml | kubectl diff -f - ``` ## {{% heading "options" %}} | --concurrency int Default: 1 | | | --- | --- | | | Number of objects to process in parallel when diffing against the live version. Larger number = faster, but more memory, I/O and CPU over that shorter period of time. | | --field-manager string Default: "kubectl-client-side-apply" | | | | Name of the manager used to track field ownership. | | -f, --filename strings | | | | Filename, directory, or URL to files contains the configuration to diff | | --force-conflicts | | | | If true, server-side apply will force the changes against conflicts. | | -h, --help | | | | help for diff | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | --prune | | | | Include resources that would be deleted by pruning. Can be used with -l and default shows all resources would be pruned | | --prune-allowlist strings | | | | Overwrite the default allowlist with <group/version/kind> for --prune | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --server-side | | | | If true, apply runs in the server instead of the client. | | --show-managed-fields | | | | If true, include managed fields in the diff. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_diff/_index.md | main | kubernetes | [
-0.005806851666420698,
0.018280543386936188,
0.09295541048049927,
-0.022943058982491493,
0.07800234854221344,
-0.0640757754445076,
-0.030566591769456863,
-0.011090407148003578,
0.09131057560443878,
0.007740237284451723,
0.00786487478762865,
-0.06853187829256058,
-0.03309665620326996,
-0.03... | 0.081893 |
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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_diff/_index.md | main | kubernetes | [
-0.0279762614518404,
0.06302154064178467,
0.0019514808664098382,
-0.009046110324561596,
-0.06595027446746826,
-0.02938474714756012,
-0.036537736654281616,
-0.06334038078784943,
0.09155720472335815,
-0.04038531705737114,
-0.00642595486715436,
-0.087058424949646,
0.06145612522959709,
0.01019... | 0.042397 |
manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_diff/_index.md | main | kubernetes | [
-0.06050267443060875,
0.03015855699777603,
-0.01637798547744751,
0.06663832068443298,
-0.01916760578751564,
-0.017294373363256454,
0.12631051242351532,
0.01701965183019638,
-0.007665052078664303,
0.045752402395009995,
0.03871450200676918,
-0.0927233099937439,
-0.018894556909799576,
0.01855... | 0.163862 |
## {{% heading "synopsis" %}} Delete resources by file names, stdin, resources and names, or by resources and label selector. JSON and YAML formats are accepted. Only one type of argument may be specified: file names, resources and names, or resources and label selector. Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must specify the --force flag. Note: only a subset of resources support graceful deletion. In absence of the support, the --grace-period flag is ignored. IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods, the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource. After a CustomResourceDefinition is deleted, invalidation of discovery cache may take up to 6 hours. If you don't want to wait, you might want to run "kubectl api-resources" to refresh the discovery cache. ``` kubectl delete ([-f FILENAME] | [-k DIRECTORY] | TYPE [(NAME | -l label | --all)]) ``` ## {{% heading "examples" %}} ``` # Delete a pod using the type and name specified in pod.json kubectl delete -f ./pod.json # Delete resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml kubectl delete -k dir # Delete resources from all files that end with '.json' kubectl delete -f '\*.json' # Delete a pod based on the type and name in the JSON passed into stdin cat pod.json | kubectl delete -f - # Delete pods and services with same names "baz" and "foo" kubectl delete pod,service baz foo # Delete pods and services with label name=myLabel kubectl delete pods,services -l name=myLabel # Delete a pod with minimal delay kubectl delete pod foo --now # Force delete a pod on a dead node kubectl delete pod foo --force # Delete all pods kubectl delete pods --all # Delete all pods only if the user confirms the deletion kubectl delete pods --all --interactive ``` ## {{% heading "options" %}} | --all | | | --- | --- | | | Delete all resources, in the namespace of the specified resource types. | | -A, --all-namespaces | | | | If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | | --cascade string[="background"] Default: "background" | | | | Must be "background", | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_delete/_index.md | main | kubernetes | [
-0.00811649952083826,
0.044906891882419586,
0.04933462664484978,
0.028961768373847008,
0.0807252749800682,
-0.05334445461630821,
0.00216641160659492,
-0.07885676622390747,
0.15073522925376892,
0.026827048510313034,
0.024117857217788696,
0.04740216210484505,
0.013378049246966839,
0.01415689... | 0.18248 |
resources, in the namespace of the specified resource types. | | -A, --all-namespaces | | | | If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | | --cascade string[="background"] Default: "background" | | | | Must be "background", "orphan", or "foreground". Selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). Defaults to background. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | --field-selector string | | | | Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. | | -f, --filename strings | | | | containing the resource to delete. | | --force | | | | If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. | | --grace-period int Default: -1 | | | | Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). | | -h, --help | | | | help for delete | | --ignore-not-found | | | | Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. | | -i, --interactive | | | | If true, delete resource only when user confirms. | | -k, --kustomize string | | | | Process a kustomization directory. This flag can't be used together with -f or -R. | | --now | | | | If true, resources are signaled for immediate shutdown (same as --grace-period=1). | | -o, --output string | | | | Output mode. Use "-o name" for shorter output (resource/name). | | --raw string | | | | Raw URI to DELETE to the server. Uses the transport specified by the kubeconfig file. | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --timeout duration | | | | The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object | | --wait Default: true | | | | If true, wait for resources to be gone before returning. This waits for finalizers. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --cache-dir string Default: "$HOME/.kube/cache" | | | | Default cache directory | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_delete/_index.md | main | kubernetes | [
-0.016501212492585182,
-0.01988123171031475,
-0.012500203214585781,
0.06931275129318237,
0.03031534142792225,
-0.06597904860973358,
0.051373645663261414,
-0.09094054996967316,
0.03243199735879898,
0.04576082155108452,
-0.013126415200531483,
-0.02304096147418022,
0.05988350510597229,
-0.042... | 0.12346 |
| | UID to impersonate for the operation. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_delete/_index.md | main | kubernetes | [
-0.016345366835594177,
0.06791731715202332,
-0.03954824060201645,
-0.0020642245654016733,
-0.0715821161866188,
-0.041652195155620575,
0.07133367657661438,
-0.04001013562083244,
0.0563899427652359,
-0.01256965845823288,
0.023777160793542862,
-0.06915873289108276,
0.07459820806980133,
-0.007... | 0.121787 |
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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_delete/_index.md | main | kubernetes | [
0.04748755320906639,
0.0632443055510521,
0.053977012634277344,
0.01839311048388481,
0.054524704813957214,
-0.005692110396921635,
-0.09378955513238907,
-0.06682035326957703,
0.06275604665279388,
0.028504110872745514,
-0.04385683685541153,
-0.04690364748239517,
-0.0021163783967494965,
-0.047... | 0.117252 |
## {{% heading "synopsis" %}} Approve a certificate signing request. kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requester with the attributes requested in the CSR. SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do. ``` kubectl certificate approve (-f FILENAME | NAME) ``` ## {{% heading "examples" %}} ``` # Approve CSR 'csr-sqgzp' kubectl certificate approve csr-sqgzp ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to update | | --force | | | | Update the CSR even if it is already approved. | | -h, --help | | | | help for approve | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path to the kuberc file to use for preferences. This can be | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_certificate/kubectl_certificate_approve.md | main | kubernetes | [
-0.030236395075917244,
0.11296512186527252,
0.021396508440375328,
0.021431541070342064,
0.007676752284169197,
0.0009242342202924192,
-0.021912265568971634,
0.0029945618007332087,
0.023874450474977493,
-0.02470805123448372,
0.03584863245487213,
-0.10609772056341171,
0.051874078810214996,
0.... | 0.037493 |
not be checked for validity. This will make your HTTPS connections insecure | | --kubeconfig string | | | | Path to the kubeconfig file to use for CLI requests. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl certificate](../) - Modify certificate resources | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_certificate/kubectl_certificate_approve.md | main | kubernetes | [
-0.0001877673639683053,
0.028826894238591194,
-0.020242471247911453,
-0.035908132791519165,
-0.04392850026488304,
-0.024911651387810707,
-0.00818276684731245,
-0.028881531208753586,
0.06599261611700058,
-0.007821520790457726,
-0.020093262195587158,
-0.1092788577079773,
0.03269055858254433,
... | 0.0125 |
## {{% heading "synopsis" %}} Deny a certificate signing request. kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requester. ``` kubectl certificate deny (-f FILENAME | NAME) ``` ## {{% heading "examples" %}} ``` # Deny CSR 'csr-sqgzp' kubectl certificate deny csr-sqgzp ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to update | | --force | | | | Update the CSR even if it is already denied. | | -h, --help | | | | help for deny | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-version | | | | Require server version to match client version | | -n, --namespace string | | | | If present, the namespace scope for this CLI request | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_certificate/kubectl_certificate_deny.md | main | kubernetes | [
-0.021419819444417953,
0.13533183932304382,
0.011994902975857258,
0.011187451891601086,
-0.007489396724849939,
0.00938305351883173,
-0.03296786919236183,
0.001761755207553506,
0.016037963330745697,
-0.05176185443997383,
0.04098191112279892,
-0.09208851307630539,
0.0515567809343338,
0.01256... | 0.046961 |
use for preferences. This can be disabled by exporting KUBECTL\_KUBERC=false feature gate or turning off the feature KUBERC=off. | | --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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl certificate](../) - Modify certificate resources | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_certificate/kubectl_certificate_deny.md | main | kubernetes | [
0.02047172375023365,
0.022765303030610085,
-0.007474340032786131,
-0.03048262558877468,
-0.027342351153492928,
-0.000051561175496317446,
-0.03585940599441528,
0.004696331452578306,
0.06578096002340317,
0.004344374872744083,
-0.020769406110048294,
-0.0888160988688469,
-0.011190354824066162,
... | 0.063957 |
## {{% heading "synopsis" %}} Modify certificate resources. ``` kubectl certificate SUBCOMMAND ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for certificate | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_certificate/_index.md | main | kubernetes | [
-0.0201299749314785,
0.0890575423836708,
0.00048593655810691416,
0.013633151538670063,
-0.0830526277422905,
-0.03315458446741104,
0.08846466988325119,
0.007074510212987661,
0.012127025052905083,
-0.021147508174180984,
-0.0010553132742643356,
-0.12997743487358093,
0.03432824835181236,
0.018... | 0.044837 |
| | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager \* [kubectl certificate approve](kubectl\_certificate\_approve/) - Approve a certificate signing request \* [kubectl certificate deny](kubectl\_certificate\_deny/) - Deny a certificate signing request | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_certificate/_index.md | main | kubernetes | [
0.01790028251707554,
0.0704151839017868,
-0.02185305394232273,
0.01231384091079235,
-0.04804162681102753,
-0.025519980117678642,
0.0019154426408931613,
0.021190185099840164,
0.03688395768404007,
-0.023281535133719444,
-0.03553348407149315,
-0.1503194123506546,
0.09603817760944366,
-0.00453... | 0.070336 |
## {{% heading "synopsis" %}} Mark node as unschedulable. ``` kubectl cordon NODE ``` ## {{% heading "examples" %}} ``` # Mark node "foo" as unschedulable kubectl cordon foo ``` ## {{% heading "options" %}} | --dry-run string[="unchanged"] Default: "none" | | | --- | --- | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | -h, --help | | | | help for cordon | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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" | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_cordon/_index.md | main | kubernetes | [
-0.03662111237645149,
0.08708522468805313,
0.012003612704575062,
0.06614813953638077,
-0.034710850566625595,
-0.035145990550518036,
0.01229893695563078,
-0.01294154953211546,
0.03280156850814819,
-0.008704190142452717,
0.01427310798317194,
-0.05404936522245407,
-0.016764845699071884,
-0.01... | 0.102805 |
| | | 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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_cordon/_index.md | main | kubernetes | [
0.0419749990105629,
0.039506345987319946,
-0.03774046152830124,
0.013834038749337196,
-0.060321539640426636,
-0.00767519511282444,
0.017999187111854553,
-0.0017537538660690188,
0.14459972083568573,
0.05219338834285736,
-0.026096122339367867,
-0.08907046914100647,
0.08360935002565384,
-0.01... | 0.108482 |
## {{% heading "synopsis" %}} Display users defined in the kubeconfig. ``` kubectl config get-users [flags] ``` ## {{% heading "examples" %}} ``` # List the users that kubectl knows about kubectl config get-users ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for get-users | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_get-users.md | main | kubernetes | [
-0.024585368111729622,
0.04333019256591797,
0.0322110652923584,
0.01839660108089447,
-0.07273294776678085,
-0.01790686883032322,
0.09726408869028091,
0.025118425488471985,
-0.005917333997786045,
-0.03286050632596016,
0.01649428717792034,
-0.14628194272518158,
-0.0017652533715590835,
-0.024... | 0.08052 |
| | | 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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_get-users.md | main | kubernetes | [
0.010968625545501709,
0.05800088122487068,
-0.04699156805872917,
0.020335253328084946,
-0.05771931633353233,
0.003219686448574066,
0.004016706254333258,
0.03074841946363449,
0.025204941630363464,
-0.012865693308413029,
-0.037029415369033813,
-0.13821716606616974,
0.08989087492227554,
-0.01... | 0.091755 |
## {{% heading "synopsis" %}} Unset an individual value in a kubeconfig file. PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. ``` kubectl config unset PROPERTY\_NAME ``` ## {{% heading "examples" %}} ``` # Unset the current-context kubectl config unset current-context # Unset namespace in foo context kubectl config unset contexts.foo.namespace ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for unset | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_unset.md | main | kubernetes | [
-0.045261163264513016,
0.057862237095832825,
0.046642061322927475,
0.05028698965907097,
-0.05308105796575546,
-0.004911232739686966,
0.09189978986978531,
-0.011814817786216736,
0.022180987522006035,
-0.005174503196030855,
0.022801773622632027,
-0.1037391796708107,
0.02339283749461174,
-0.0... | 0.091493 |
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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_unset.md | main | kubernetes | [
0.0006697714561596513,
0.029967378824949265,
-0.08267408609390259,
-0.011433558538556099,
-0.10414841026067734,
-0.012842437252402306,
0.004304264672100544,
0.02228429540991783,
0.05259271711111069,
0.017699964344501495,
0.002161988290026784,
-0.13831791281700134,
0.10374293476343155,
-0.0... | 0.098206 |
## {{% heading "synopsis" %}} Delete the specified user from the kubeconfig. ``` kubectl config delete-user NAME ``` ## {{% heading "examples" %}} ``` # Delete the minikube user kubectl config delete-user minikube ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for delete-user | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_delete-user.md | main | kubernetes | [
-0.01730414666235447,
0.049834415316581726,
0.023254331201314926,
0.0051859901286661625,
-0.03782036900520325,
0.00039011784247122705,
0.07710112631320953,
0.017821619287133217,
0.009991823695600033,
0.018314789980649948,
0.035844024270772934,
-0.11588746309280396,
0.030298253521323204,
-0... | 0.054155 |
| | 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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_delete-user.md | main | kubernetes | [
0.010955785401165485,
0.0510677807033062,
-0.0501570850610733,
0.021867992356419563,
-0.06160426512360573,
0.002103335689753294,
0.007832451723515987,
0.029341289773583412,
0.024397237226366997,
-0.009949320927262306,
-0.03926635533571243,
-0.1369825005531311,
0.09360115230083466,
-0.00745... | 0.085977 |
## {{% heading "synopsis" %}} Delete the specified cluster from the kubeconfig. ``` kubectl config delete-cluster NAME ``` ## {{% heading "examples" %}} ``` # Delete the minikube cluster kubectl config delete-cluster minikube ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for delete-cluster | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_delete-cluster.md | main | kubernetes | [
-0.014990653842687607,
0.045502979308366776,
0.009016372263431549,
0.040273517370224,
-0.01254927460104227,
0.004123926628381014,
0.059003256261348724,
0.0026214513927698135,
-0.004437414463609457,
0.021385304629802704,
0.03910910710692406,
-0.11840904504060745,
0.029187509790062904,
-0.02... | 0.084414 |
| | 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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_delete-cluster.md | main | kubernetes | [
0.010955785401165485,
0.0510677807033062,
-0.0501570850610733,
0.021867992356419563,
-0.06160426512360573,
0.002103335689753294,
0.007832451723515987,
0.029341289773583412,
0.024397237226366997,
-0.009949320927262306,
-0.03926635533571243,
-0.1369825005531311,
0.09360115230083466,
-0.00745... | 0.085977 |
## {{% heading "synopsis" %}} Delete the specified context from the kubeconfig. ``` kubectl config delete-context NAME ``` ## {{% heading "examples" %}} ``` # Delete the context for the minikube cluster kubectl config delete-context minikube ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for delete-context | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_delete-context.md | main | kubernetes | [
-0.0017792521975934505,
0.051704201847314835,
0.01995656080543995,
0.03790120407938957,
-0.0052296752110123634,
0.009318576194345951,
0.07710862904787064,
0.020897235721349716,
0.005762506276369095,
0.012918200343847275,
0.02691330760717392,
-0.12663456797599792,
0.03867195546627045,
-0.01... | 0.06097 |
"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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_delete-context.md | main | kubernetes | [
0.025667980313301086,
0.04635836184024811,
-0.051247380673885345,
0.008903688751161098,
-0.05909927934408188,
-0.002019602106884122,
-0.0010429412359371781,
0.03656712919473648,
0.024457506835460663,
-0.00670876307412982,
-0.03267069533467293,
-0.13220660388469696,
0.09061671048402786,
-0.... | 0.089073 |
## {{% heading "synopsis" %}} Display one or many contexts from the kubeconfig file. ``` kubectl config get-contexts [(-o|--output=)name)] ``` ## {{% heading "examples" %}} ``` # List all the contexts in your kubeconfig file kubectl config get-contexts # Describe one context in your kubeconfig file kubectl config get-contexts my-context ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for get-contexts | | --no-headers | | | | When using the default or custom-column output format, don't print headers (default print headers). | | -o, --output string | | | | Output format. One of: (name). | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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" | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_get-contexts.md | main | kubernetes | [
0.02809077315032482,
0.08001415431499481,
-0.004130036104470491,
0.041626937687397,
0.007077440153807402,
0.014565113931894302,
0.05267956107854843,
0.04020967334508896,
-0.007962637580931187,
-0.03465518355369568,
-0.008281085640192032,
-0.16290688514709473,
0.016972528770565987,
-0.05295... | 0.038595 |
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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_get-contexts.md | main | kubernetes | [
0.04875127226114273,
0.031169701367616653,
-0.09864017367362976,
0.03470781818032265,
-0.1023675799369812,
-0.035848088562488556,
0.012594357132911682,
0.027632877230644226,
0.04513347148895264,
0.00005604785474133678,
0.008833294734358788,
-0.08063051104545593,
0.09377548098564148,
-0.031... | 0.08887 |
## {{% heading "synopsis" %}} Display the current-context. ``` kubectl config current-context [flags] ``` ## {{% heading "examples" %}} ``` # Display the current-context kubectl config current-context ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for current-context | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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. | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_current-context.md | main | kubernetes | [
-0.03272877633571625,
0.038284990936517715,
0.023845249786973,
0.015382801182568073,
-0.04075278714299202,
-0.018203459680080414,
0.11058461666107178,
0.026929806917905807,
0.0014873238978907466,
-0.01729302480816841,
0.006930527742952108,
-0.1482316553592682,
0.008835948072373867,
-0.0047... | 0.099937 |
--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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_current-context.md | main | kubernetes | [
0.0236787348985672,
0.05804344639182091,
-0.0428994782269001,
0.02204752340912819,
-0.05707494542002678,
-0.006649624090641737,
0.01641649194061756,
0.03363355994224548,
0.023281216621398926,
-0.009429195895791054,
-0.027241995558142662,
-0.14248378574848175,
0.09320332854986191,
-0.004433... | 0.092591 |
## {{% heading "synopsis" %}} Set a user entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values. Client-certificate flags: --client-certificate=certfile --client-key=keyfile Bearer token flags: --token=bearer\_token Basic auth flags: --username=basic\_user --password=basic\_password Bearer token and basic auth are mutually exclusive. ``` kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer\_token] [--username=basic\_user] [--password=basic\_password] [--auth-provider=provider\_name] [--auth-provider-arg=key=value] [--exec-command=exec\_command] [--exec-api-version=exec\_api\_version] [--exec-arg=arg] [--exec-env=key=value] ``` ## {{% heading "examples" %}} ``` # Set only the "client-key" field on the "cluster-admin" # entry, without touching other values kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key # Set basic auth for the "cluster-admin" entry kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif # Embed client certificate data in the "cluster-admin" entry kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true # Enable the Google Compute Platform auth provider for the "cluster-admin" entry kubectl config set-credentials cluster-admin --auth-provider=gcp # Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional arguments kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar # Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret- # Enable new exec auth plugin for the "cluster-admin" entry kubectl config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1 # Enable new exec auth plugin for the "cluster-admin" entry with interactive mode kubectl config set-credentials cluster-admin --exec-command=/path/to/the/executable --exec-api-version=client.authentication.k8s.io/v1beta1 --exec-interactive-mode=Never # Define new exec auth plugin arguments for the "cluster-admin" entry kubectl config set-credentials cluster-admin --exec-arg=arg1 --exec-arg=arg2 # Create or update exec auth plugin environment variables for the "cluster-admin" entry kubectl config set-credentials cluster-admin --exec-env=key1=val1 --exec-env=key2=val2 # Remove exec auth plugin environment variables for the "cluster-admin" entry kubectl config set-credentials cluster-admin --exec-env=var-to-remove- ``` ## {{% heading "options" %}} | --auth-provider string | | | --- | --- | | | Auth provider for the user entry in kubeconfig | | --auth-provider-arg strings | | | | 'key=value' arguments for the auth provider | | --client-certificate string | | | | Path to client-certificate file for the user entry in kubeconfig | | --client-key string | | | | Path to client-key file for the user entry in kubeconfig | | --embed-certs tristate[=true] | | | | Embed client cert/key for the user entry in kubeconfig | | --exec-api-version string | | | | API version of the exec credential plugin for the user entry in kubeconfig | | --exec-arg strings | | | | New arguments for the exec credential plugin command for the user entry in kubeconfig | | --exec-command string | | | | Command for the exec credential plugin for the user entry in kubeconfig | | --exec-env strings | | | | 'key=value' environment values for the exec credential plugin | | --exec-interactive-mode string | | | | InteractiveMode of the exec credentials plugin for the user entry in kubeconfig | | --exec-provide-cluster-info tristate[=true] | | | | ProvideClusterInfo of the exec credentials plugin for the user entry in kubeconfig | | -h, --help | | | | help for set-credentials | | --password string | | | | password for the user entry in kubeconfig | | --token string | | | | token for the user entry in kubeconfig | | --username string | | | | username for the user entry in kubeconfig | ## {{% heading "parentoptions" %}} | --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 | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-credentials.md | main | kubernetes | [
0.01939914934337139,
0.05333836004137993,
-0.02745216339826584,
-0.022161373868584633,
-0.09551212191581726,
-0.01642940752208233,
0.0473322756588459,
0.026150815188884735,
0.06270889192819595,
-0.003464505774900317,
0.009569480083882809,
-0.15125806629657745,
0.08395155519247055,
-0.03707... | 0.005842 |
| | | 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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --cache-dir string Default: "$HOME/.kube/cache" | | | | Default cache directory | | --certificate-authority string | | | | Path to a cert file for the certificate authority | | --cluster string | | | | The name of the kubeconfig cluster to use | | --context string | | | | The name of the kubeconfig context to use | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-version | | | | Require server version to match client version | | -n, --namespace string | | | | If present, the namespace scope for this CLI request | | --profile string Default: "none" | | | | Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace) | | --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 | | --user string | | | | The name of the kubeconfig user to use | | --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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-credentials.md | main | kubernetes | [
0.012579833157360554,
0.024938220158219337,
-0.06062128022313118,
-0.0061414907686412334,
-0.06820472329854965,
-0.021645311266183853,
0.08587462455034256,
-0.0474197119474411,
0.03651455044746399,
-0.009563524276018143,
0.026408959180116653,
-0.08585843443870544,
0.035474903881549835,
-0.... | 0.146232 |
the server as errors and exit with a non-zero exit code | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-credentials.md | main | kubernetes | [
0.047617796808481216,
0.06539472192525864,
0.03361470624804497,
0.016868965700268745,
-0.018033303320407867,
0.025062065571546555,
-0.029218370094895363,
-0.03803105652332306,
0.058683931827545166,
0.029035357758402824,
-0.004543448332697153,
-0.09284088760614395,
-0.020941877737641335,
-0... | 0.090847 |
## {{% heading "synopsis" %}} Set a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields. ``` kubectl config set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true] [--tls-server-name=example.com] ``` ## {{% heading "examples" %}} ``` # Set only the server field on the e2e cluster entry without touching other values kubectl config set-cluster e2e --server=https://1.2.3.4 # Embed certificate authority data for the e2e cluster entry kubectl config set-cluster e2e --embed-certs --certificate-authority=~/.kube/e2e/kubernetes.ca.crt # Disable cert checking for the e2e cluster entry kubectl config set-cluster e2e --insecure-skip-tls-verify=true # Set the custom TLS server name to use for validation for the e2e cluster entry kubectl config set-cluster e2e --tls-server-name=my-cluster-name # Set the proxy URL for the e2e cluster entry kubectl config set-cluster e2e --proxy-url=https://1.2.3.4 ``` ## {{% heading "options" %}} | --certificate-authority string | | | --- | --- | | | Path to certificate-authority file for the cluster entry in kubeconfig | | --embed-certs tristate[=true] | | | | embed-certs for the cluster entry in kubeconfig | | -h, --help | | | | help for set-cluster | | --insecure-skip-tls-verify tristate[=true] | | | | insecure-skip-tls-verify for the cluster entry in kubeconfig | | --proxy-url string | | | | proxy-url for the cluster entry in kubeconfig | | --server string | | | | server for the cluster entry in kubeconfig | | --tls-server-name string | | | | tls-server-name for the cluster entry in kubeconfig | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --cache-dir string Default: "$HOME/.kube/cache" | | | | Default cache directory | | --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 | | --disable-compression | | | | If true, opt-out of response compression for all requests to the server | | --kubeconfig string | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-cluster.md | main | kubernetes | [
0.03510863333940506,
0.06058372184634209,
0.032055143266916275,
0.03682912513613701,
-0.02815169282257557,
-0.03797735273838043,
-0.014772176742553711,
-0.0009944242192432284,
0.024564411491155624,
0.003503152634948492,
0.014396259561181068,
-0.16779759526252747,
0.06612224131822586,
-0.02... | 0.043487 |
capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace) | | --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. | | --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 | | --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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-cluster.md | main | kubernetes | [
0.036918509751558304,
0.010912870988249779,
-0.16361548006534576,
0.05243793874979019,
-0.017530683428049088,
-0.031491611152887344,
0.026486586779356003,
0.08950548619031906,
-0.011432374827563763,
0.01422139909118414,
0.06684248149394989,
-0.024523915722966194,
0.047260433435440063,
-0.0... | 0.048836 |
## {{% heading "synopsis" %}} Set a context entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields. ``` kubectl config set-context [NAME | --current] [--cluster=cluster\_nickname] [--user=user\_nickname] [--namespace=namespace] ``` ## {{% heading "examples" %}} ``` # Set the user field on the gce context entry without touching other values kubectl config set-context gce --user=cluster-admin ``` ## {{% heading "options" %}} | --cluster string | | | --- | --- | | | cluster for the context entry in kubeconfig | | --current | | | | Modify the current context | | -h, --help | | | | help for set-context | | -n, --namespace string | | | | namespace for the context entry in kubeconfig | | --user string | | | | user for the context entry in kubeconfig | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --context string | | | | The name of the kubeconfig context to use | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-version | | | | Require server version to match client version | | --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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-context.md | main | kubernetes | [
-0.001750255236402154,
-0.0148248840123415,
0.012339157052338123,
-0.008271663449704647,
-0.08548672497272491,
0.003247653366997838,
0.10753415524959564,
0.009706110693514347,
-0.019287848845124245,
-0.00020575278904289007,
-0.02796846255660057,
-0.14639919996261597,
0.03130712732672691,
-... | 0.068364 |
| 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 | | --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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set-context.md | main | kubernetes | [
0.020320355892181396,
0.024114403873682022,
-0.12925434112548828,
0.06352842599153519,
-0.06142505258321762,
-0.06495801359415054,
-0.022974755614995956,
0.03965757042169571,
0.02199026383459568,
0.0007979711517691612,
0.007711043115705252,
-0.04347334802150726,
0.13318954408168793,
-0.014... | 0.061357 |
## {{% heading "synopsis" %}} Set an individual value in a kubeconfig file. PROPERTY\_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. PROPERTY\_VALUE is the new value you want to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. Specifying an attribute name that already exists will merge new fields on top of existing values. ``` kubectl config set PROPERTY\_NAME PROPERTY\_VALUE ``` ## {{% heading "examples" %}} ``` # Set the server field on the my-cluster cluster to https://1.2.3.4 kubectl config set clusters.my-cluster.server https://1.2.3.4 # Set the certificate-authority-data field on the my-cluster cluster kubectl config set clusters.my-cluster.certificate-authority-data $(echo "cert\_data\_here" | base64 -i -) # Set the cluster field in the my-context context to my-cluster kubectl config set contexts.my-context.cluster my-cluster # Set the client-key-data field in the cluster-admin user using --set-raw-bytes option kubectl config set users.cluster-admin.client-key-data cert\_data\_here --set-raw-bytes=true ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for set | | --set-raw-bytes tristate[=true] | | | | When writing a []byte PROPERTY\_VALUE, write the given string directly without base64 decoding. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set.md | main | kubernetes | [
0.0820297971367836,
0.05350007861852646,
0.0033876383677124977,
0.04116622358560562,
-0.03873667120933533,
0.029527222737669945,
-0.0013708178885281086,
0.008959797210991383,
0.025208577513694763,
0.010237871669232845,
-0.0069732666015625,
-0.1354924887418747,
0.07794542610645294,
-0.06234... | 0.0315 |
One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_set.md | main | kubernetes | [
0.04783884435892105,
0.027796542271971703,
-0.07659143954515457,
0.03688029199838638,
-0.07159605622291565,
-0.0041790432296693325,
-0.0017654355615377426,
0.03894989937543869,
0.1072540134191513,
0.034344181418418884,
0.021427486091852188,
-0.040575046092271805,
-0.0008248428930528462,
-0... | 0.093401 |
## {{% heading "synopsis" %}} Set the current-context in a kubeconfig file. ``` kubectl config use-context CONTEXT\_NAME ``` ## {{% heading "examples" %}} ``` # Use the context for the minikube cluster kubectl config use-context minikube ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for use-context | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_use-context.md | main | kubernetes | [
-0.006531381513923407,
0.03631148487329483,
0.0155112873762846,
0.027781488373875618,
-0.02402731031179428,
0.026753408834338188,
0.07457583397626877,
0.0749838575720787,
-0.00459409411996603,
0.004714022856205702,
0.01564902439713478,
-0.14886079728603363,
0.0316067673265934,
-0.020630050... | 0.071784 |
"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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_use-context.md | main | kubernetes | [
0.025667980313301086,
0.04635836184024811,
-0.051247380673885345,
0.008903688751161098,
-0.05909927934408188,
-0.002019602106884122,
-0.0010429412359371781,
0.03656712919473648,
0.024457506835460663,
-0.00670876307412982,
-0.03267069533467293,
-0.13220660388469696,
0.09061671048402786,
-0.... | 0.089073 |
## {{% heading "synopsis" %}} Renames a context from the kubeconfig file. CONTEXT\_NAME is the context name that you want to change. NEW\_NAME is the new name you want to set. Note: If the context being renamed is the 'current-context', this field will also be updated. ``` kubectl config rename-context CONTEXT\_NAME NEW\_NAME ``` ## {{% heading "examples" %}} ``` # Rename the context 'old-name' to 'new-name' in your kubeconfig file kubectl config rename-context old-name new-name ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for rename-context | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_rename-context.md | main | kubernetes | [
-0.016399633139371872,
0.02441268600523472,
0.04634932428598404,
-0.00628862576559186,
-0.061206892132759094,
0.014988849870860577,
0.06049410626292229,
0.024377474561333656,
0.04482722654938698,
0.023647300899028778,
0.0016285961028188467,
-0.11769656836986542,
-0.0025310772471129894,
-0.... | 0.07946 |
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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_rename-context.md | main | kubernetes | [
0.02065977454185486,
0.017925752326846123,
-0.08806876838207245,
0.010327421128749847,
-0.09272976964712143,
-0.025673000141978264,
-0.001775683369487524,
0.008105049841105938,
0.0691470131278038,
0.016305312514305115,
0.014517203904688358,
-0.11707139760255814,
0.11167927831411362,
-0.020... | 0.084095 |
## {{% heading "synopsis" %}} Display clusters defined in the kubeconfig. ``` kubectl config get-clusters [flags] ``` ## {{% heading "examples" %}} ``` # List the clusters that kubectl knows about kubectl config get-clusters ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for get-clusters | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_get-clusters.md | main | kubernetes | [
-0.015148044563829899,
0.02523152343928814,
0.004099410958588123,
0.054222941398620605,
-0.03883656486868858,
-0.01098302099853754,
0.07113292813301086,
0.01277117244899273,
-0.01375954132527113,
-0.022155243903398514,
0.019042719155550003,
-0.1482900232076645,
0.011834795586764812,
-0.022... | 0.119802 |
| | | 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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_get-clusters.md | main | kubernetes | [
0.010968625545501709,
0.05800088122487068,
-0.04699156805872917,
0.020335253328084946,
-0.05771931633353233,
0.003219686448574066,
0.004016706254333258,
0.03074841946363449,
0.025204941630363464,
-0.012865693308413029,
-0.037029415369033813,
-0.13821716606616974,
0.08989087492227554,
-0.01... | 0.091755 |
## {{% heading "synopsis" %}} Modify kubeconfig files using subcommands like "kubectl config set current-context my-context". The loading order follows these rules: 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. 2. If $KUBECONFIG environment variable is set, then it is used as a list of paths (normal path delimiting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place. ``` kubectl config SUBCOMMAND ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for config | | --kubeconfig string | | | | use a particular kubeconfig file | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/_index.md | main | kubernetes | [
0.0172271691262722,
0.034655239433050156,
0.033878449350595474,
0.008836323395371437,
0.00004410500332596712,
-0.005630082916468382,
0.053277913480997086,
0.005034157540649176,
0.09311925619840622,
-0.02856329083442688,
0.02645101398229599,
-0.008418933488428593,
-0.010060971602797508,
-0.... | 0.07424 |
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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager \* [kubectl config current-context](kubectl\_config\_current-context/) - Display the current-context \* [kubectl config delete-cluster](kubectl\_config\_delete-cluster/) - Delete the specified cluster from the kubeconfig \* [kubectl config delete-context](kubectl\_config\_delete-context/) - Delete the specified context from the kubeconfig \* [kubectl config delete-user](kubectl\_config\_delete-user/) - Delete the specified user from the kubeconfig \* [kubectl config get-clusters](kubectl\_config\_get-clusters/) - Display clusters defined in the kubeconfig \* [kubectl config get-contexts](kubectl\_config\_get-contexts/) - Describe one or many contexts \* [kubectl config get-users](kubectl\_config\_get-users/) - Display users defined in the kubeconfig \* [kubectl config rename-context](kubectl\_config\_rename-context/) - Rename a context from the kubeconfig file \* [kubectl config set](kubectl\_config\_set/) - Set an individual value in a kubeconfig file \* [kubectl config set-cluster](kubectl\_config\_set-cluster/) - Set a cluster entry in kubeconfig \* [kubectl config set-context](kubectl\_config\_set-context/) - Set a context entry in kubeconfig \* [kubectl config set-credentials](kubectl\_config\_set-credentials/) - Set a user entry in kubeconfig \* [kubectl config unset](kubectl\_config\_unset/) - Unset an individual value in a kubeconfig file \* [kubectl config use-context](kubectl\_config\_use-context/) - Set the current-context in a kubeconfig file \* [kubectl config view](kubectl\_config\_view/) - Display merged kubeconfig settings or a specified kubeconfig file | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/_index.md | main | kubernetes | [
0.07694543153047562,
0.03517056629061699,
-0.08009016513824463,
0.019290819764137268,
-0.10467194765806198,
-0.006685176398605108,
-0.006563705857843161,
0.018474796786904335,
0.09814553707838058,
0.0609339214861393,
-0.006666338536888361,
-0.09831860661506653,
0.051690734922885895,
-0.041... | 0.076614 |
## {{% heading "synopsis" %}} Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression. ``` kubectl config view [flags] ``` ## {{% heading "examples" %}} ``` # Show merged kubeconfig settings kubectl config view # Show merged kubeconfig settings, raw certificate data, and exposed secrets kubectl config view --raw # Get the password for the e2e user kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' ``` ## {{% heading "options" %}} | --allow-missing-template-keys Default: true | | | --- | --- | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --flatten | | | | Flatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) | | -h, --help | | | | help for view | | --merge tristate[=true] Default: true | | | | Merge the full hierarchy of kubeconfig files | | --minify | | | | Remove all information not used by current-context from the output | | -o, --output string Default: "yaml" | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | --raw | | | | Display raw byte data and sensitive data | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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 | | | | use a particular kubeconfig file | | --kuberc string | | | | Path 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-version | | | | Require server version to match client version | | -n, --namespace string | | | | If present, the namespace scope for this CLI request | | --password string | | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_view.md | main | kubernetes | [
0.03125544264912605,
0.11735493689775467,
0.030097229406237602,
0.03594775125384331,
0.0035153948701918125,
0.018354550004005432,
0.0008094091899693012,
0.05944492667913437,
0.013598401099443436,
-0.04202018678188324,
0.030646974220871925,
-0.12225550413131714,
-0.007958045229315758,
-0.04... | -0.001291 |
exporting KUBECTL\_KUBERC=false feature gate or turning off the feature KUBERC=off. | | --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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl config](../) - Modify kubeconfig files | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_config/kubectl_config_view.md | main | kubernetes | [
0.007152256555855274,
0.016849014908075333,
-0.029394669458270073,
-0.025240711867809296,
-0.0156319048255682,
0.00552903488278389,
-0.02077556401491165,
0.018125591799616814,
0.05855267867445946,
-0.0014895574422553182,
-0.0030196502339094877,
-0.1114126592874527,
-0.026286430656909943,
-... | 0.047524 |
## {{% heading "synopsis" %}} Mark node as schedulable. ``` kubectl uncordon NODE ``` ## {{% heading "examples" %}} ``` # Mark node "foo" as schedulable kubectl uncordon foo ``` ## {{% heading "options" %}} | --dry-run string[="unchanged"] Default: "none" | | | --- | --- | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | -h, --help | | | | help for uncordon | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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" | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_uncordon/_index.md | main | kubernetes | [
-0.016107473522424698,
0.08858239650726318,
0.023945683613419533,
0.10924117267131805,
-0.02908569574356079,
0.003343918127939105,
0.002688224893063307,
-0.05163700506091118,
0.007931366562843323,
0.004244506359100342,
-0.02968631312251091,
-0.05016501992940903,
-0.001971030607819557,
-0.0... | 0.132387 |
| | | 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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_uncordon/_index.md | main | kubernetes | [
0.0419749990105629,
0.039506345987319946,
-0.03774046152830124,
0.013834038749337196,
-0.060321539640426636,
-0.00767519511282444,
0.017999187111854553,
-0.0017537538660690188,
0.14459972083568573,
0.05219338834285736,
-0.026096122339367867,
-0.08907046914100647,
0.08360935002565384,
-0.01... | 0.108482 |
## {{% heading "synopsis" %}} Creates a proxy server or application-level gateway between localhost and the Kubernetes API server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote Kubernetes API server port, except for the path matching the static content path. ``` kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] ``` ## {{% heading "examples" %}} ``` # To proxy all of the Kubernetes API and nothing else kubectl proxy --api-prefix=/ # To proxy only part of the Kubernetes API and also some static files # You can get pods info with 'curl localhost:8001/api/v1/pods' kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/ # To proxy the entire Kubernetes API at a different root # You can get pods info with 'curl localhost:8001/custom/api/v1/pods' kubectl proxy --api-prefix=/custom/ # Run a proxy to the Kubernetes API server on port 8011, serving static content from ./local/www/ kubectl proxy --port=8011 --www=./local/www/ # Run a proxy to the Kubernetes API server on an arbitrary local port # The chosen port for the server will be output to stdout kubectl proxy --port=0 # Run a proxy to the Kubernetes API server, changing the API prefix to k8s-api # This makes e.g. the pods API available at localhost:8001/k8s-api/v1/pods/ kubectl proxy --api-prefix=/k8s-api ``` ## {{% heading "options" %}} | --accept-hosts string Default: "^localhost$,^127\.0\.0\.1$,^\[::1\]$" | | | --- | --- | | | Regular expression for hosts that the proxy should accept. | | --accept-paths string Default: "^.\*" | | | | Regular expression for paths that the proxy should accept. | | --address string Default: "127.0.0.1" | | | | The IP address on which to serve on. | | --api-prefix string Default: "/" | | | | Prefix to serve the proxied API under. | | --append-server-path | | | | If true, enables automatic path appending of the kube context server path to each request. | | --disable-filter | | | | If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. | | -h, --help | | | | help for proxy | | --keepalive duration | | | | keepalive specifies the keep-alive period for an active network connection. Set to 0 to disable keepalive. | | -p, --port int Default: 8001 | | | | The port on which to run the proxy. Set to 0 to pick a random port. | | --reject-methods string Default: "^$" | | | | Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH'). | | --reject-paths string Default: "^/api/.\*/pods/.\*/exec, ^/api/.\*/pods/.\*/attach" | | | | Regular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths. | | -u, --unix-socket string | | | | Unix socket on which to run the proxy. | | -w, --www string | | | | Also serve static files from the given directory under the specified prefix. | | -P, --www-prefix string Default: "/static/" | | | | Prefix to serve static files under, if static file directory is specified. | ## {{% heading "parentoptions" %}} | --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. | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_proxy/_index.md | main | kubernetes | [
0.023747306317090988,
0.013001111336052418,
0.055771604180336,
-0.010393301956355572,
-0.07405796647071838,
-0.01730702444911003,
-0.04350381717085838,
0.03698878362774849,
0.030834021046757698,
0.06336953490972519,
-0.07142258435487747,
-0.014144424349069595,
-0.004305805079638958,
-0.029... | 0.136887 |
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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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] | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_proxy/_index.md | main | kubernetes | [
-0.009463820606470108,
0.02215619571506977,
-0.05235973000526428,
-0.01589483767747879,
-0.0845535472035408,
-0.01847766898572445,
0.0750003531575203,
-0.041150644421577454,
0.03565413877367973,
-0.01848030462861061,
0.026121729984879494,
-0.09837653487920761,
0.06153155118227005,
-0.01539... | 0.09305 |
| | | 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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_proxy/_index.md | main | kubernetes | [
0.009980800561606884,
0.08096329122781754,
0.0015513591933995485,
0.023486293852329254,
-0.00893212016671896,
0.045260485261678696,
0.033637553453445435,
-0.015394662506878376,
0.03463347256183624,
0.009470125660300255,
-0.030399614945054054,
-0.11234798282384872,
0.051893118768930435,
-0.... | 0.151854 |
## {{% heading "synopsis" %}} Display resource (CPU/memory) usage of pods. The 'top pod' command allows you to see the resource consumption of pods. Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation. ``` kubectl top pod [NAME | -l label] ``` ## {{% heading "examples" %}} ``` # Show metrics for all pods in the default namespace kubectl top pod # Show metrics for all pods in the given namespace kubectl top pod --namespace=NAMESPACE # Show metrics for a given pod and its containers kubectl top pod POD\_NAME --containers # Show metrics for the pods defined by label name=myLabel kubectl top pod -l name=myLabel ``` ## {{% heading "options" %}} | -A, --all-namespaces | | | --- | --- | | | If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | | --containers | | | | If present, print usage of containers within a pod. | | --field-selector string | | | | Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. | | -h, --help | | | | help for pod | | --no-headers | | | | If present, print output without headers. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --show-swap | | | | Print pod resources related to swap memory. | | --sort-by string | | | | If non-empty, sort pods list using specified field. The field can be either 'cpu' or 'memory'. | | --sum | | | | Print the sum of the resource usage | | --use-protocol-buffers Default: true | | | | Enables using protocol-buffers to access Metrics API. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path to the kuberc file to use | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_top/kubectl_top_pod.md | main | kubernetes | [
0.04449159651994705,
0.013374350033700466,
-0.013187281787395477,
0.07025474309921265,
0.007120987866073847,
-0.022229362279176712,
0.046564918011426926,
0.03922799229621887,
0.03258906304836273,
0.008595507591962814,
-0.03770877793431282,
-0.12218668311834335,
-0.02143743261694908,
-0.053... | 0.165228 |
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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl top](../) - Display resource (CPU/memory) usage | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_top/kubectl_top_pod.md | main | kubernetes | [
-0.00855252705514431,
0.016477389261126518,
0.004181202966719866,
-0.03529612347483635,
-0.0547427199780941,
-0.015094508416950703,
-0.027786508202552795,
-0.04261590540409088,
0.07133129239082336,
-0.030890464782714844,
-0.02927667461335659,
-0.10198953747749329,
0.05939776822924614,
0.03... | -0.006542 |
## {{% heading "synopsis" %}} Display resource (CPU/memory) usage of nodes. The top-node command allows you to see the resource consumption of nodes. ``` kubectl top node [NAME | -l label] ``` ## {{% heading "examples" %}} ``` # Show metrics for all nodes kubectl top node # Show metrics for a given node kubectl top node NODE\_NAME ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for node | | --no-headers | | | | If present, print output without headers | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --show-capacity | | | | Print node resources based on Capacity instead of Allocatable(default) of the nodes. | | --show-swap | | | | Print node resources related to swap memory. | | --sort-by string | | | | If non-empty, sort nodes list using specified field. The field can be either 'cpu' or 'memory'. | | --use-protocol-buffers Default: true | | | | Enables using protocol-buffers to access Metrics API. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_top/kubectl_top_node.md | main | kubernetes | [
0.04718936234712601,
0.0848175585269928,
-0.01656409166753292,
0.05935965105891228,
0.022073471918702126,
-0.00411619059741497,
0.05611046776175499,
0.009034542366862297,
0.00367633905261755,
0.012071477249264717,
-0.054747868329286575,
-0.131683811545372,
0.02260022796690464,
-0.106209754... | 0.155177 |
profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl top](../) - Display resource (CPU/memory) usage | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_top/kubectl_top_node.md | main | kubernetes | [
0.05021156743168831,
0.04805637523531914,
-0.0714360848069191,
0.03334534540772438,
-0.03419020026922226,
0.002005777321755886,
0.016771724447607994,
0.05044650658965111,
0.08477044850587845,
0.03835661709308624,
0.005620026029646397,
-0.062024105340242386,
0.008881889283657074,
-0.0719138... | 0.079951 |
## {{% heading "synopsis" %}} Display resource (CPU/memory) usage. This command provides a view of recent resource consumption for nodes and pods. It fetches metrics from the Metrics Server, which aggregates this data from the kubelet on each node. The Metrics Server must be installed and running in the cluster for this command to work. The metrics shown are specifically optimized for Kubernetes autoscaling decisions, such as those made by the Horizontal Pod Autoscaler (HPA) and Vertical Pod Autoscaler (VPA). Because of this, the values may not match those from standard OS tools like 'top', as the metrics are designed to provide a stable signal for autoscalers rather than for pinpoint accuracy. When to use this command: \* For on-the-fly spot-checks of resource usage (e.g. identify which pods are consuming the most resources at a glance, or get a quick sense of the load on your nodes) \* Understand current resource consumption patterns \* Validate the behavior of your HPA or VPA configurations by seeing the metrics they use for scaling decisions. It is not intended to be a replacement for full-featured monitoring solutions. Its primary design goal is to provide a low-overhead signal for autoscalers, not to be a perfectly accurate monitoring tool. For high-accuracy reporting, historical analysis, dashboarding, or alerting, you should use a dedicated monitoring solution. ``` kubectl top [flags] ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for top | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_top/_index.md | main | kubernetes | [
0.030803514644503593,
0.027384424582123756,
0.0012838845141232014,
0.04196224361658096,
-0.003445657901465893,
-0.02868293970823288,
0.014051676727831364,
0.039578165858983994,
0.09515632688999176,
-0.007367018610239029,
-0.03141690045595169,
-0.07266464829444885,
-0.03744879737496376,
-0.... | 0.214685 |
-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|trace) | | --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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager \* [kubectl top node](kubectl\_top\_node/) - Display resource (CPU/memory) usage of nodes \* [kubectl top pod](kubectl\_top\_pod/) - Display resource (CPU/memory) usage of pods | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_top/_index.md | main | kubernetes | [
0.0006845721509307623,
0.037232231348752975,
-0.08472656458616257,
-0.01691560633480549,
-0.060415118932724,
-0.007474325131624937,
0.0064207930117845535,
0.04954909905791283,
0.08122032880783081,
0.0035333430860191584,
0.00376530340872705,
-0.08508483320474625,
0.03295992687344551,
-0.049... | 0.088709 |
## {{% heading "synopsis" %}} Set a new size for a deployment, replica set, replication controller, or stateful set. Scale also allows users to specify one or more preconditions for the scale action. If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server. ``` kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME) ``` ## {{% heading "examples" %}} ``` # Scale a replica set named 'foo' to 3 kubectl scale --replicas=3 rs/foo # Scale a resource identified by type and name specified in "foo.yaml" to 3 kubectl scale --replicas=3 -f foo.yaml # If the deployment named mysql's current size is 2, scale mysql to 3 kubectl scale --current-replicas=2 --replicas=3 deployment/mysql # Scale multiple replication controllers kubectl scale --replicas=5 rc/example1 rc/example2 rc/example3 # Scale stateful set named 'web' to 3 kubectl scale --replicas=3 statefulset/web ``` ## {{% heading "options" %}} | --all | | | --- | --- | | | Select all resources in the namespace of the specified resource types | | --allow-missing-template-keys Default: true | | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --current-replicas int Default: -1 | | | | Precondition for current size. Requires that the current size of the resource match this value in order to scale. -1 (default) for no condition. | | --dry-run string[="unchanged"] Default: "none" | | | | Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. | | -f, --filename strings | | | | Filename, directory, or URL to files identifying the resource to set a new size | | -h, --help | | | | help for scale | | -k, --kustomize string | | | | Process the kustomization directory. This flag can't be used together with -f or -R. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | -R, --recursive | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | --replicas int | | | | The new desired number of replicas. Required. | | --resource-version string | | | | Precondition for resource version. Requires that the current resource version match this value in order to scale. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | --timeout duration | | | | The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). | ## {{% heading "parentoptions" %}} | --as string | | | --- | --- | | | Username to impersonate for the operation. User could be a regular user or a service account in a namespace. | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_scale/_index.md | main | kubernetes | [
0.012852886691689491,
0.014736500568687916,
-0.0005185706540942192,
0.03957720473408699,
-0.028101438656449318,
0.0005103392177261412,
-0.004750706255435944,
-0.01170626562088728,
0.027397261932492256,
0.06471926718950272,
0.02077786810696125,
-0.07875853776931763,
0.06858506798744202,
-0.... | 0.083176 |
Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_scale/_index.md | main | kubernetes | [
-0.02398272044956684,
0.09237245470285416,
-0.04211054742336273,
0.013211434707045555,
-0.08094394952058792,
-0.05279040336608887,
0.10234534740447998,
0.002697739051654935,
0.04025403782725334,
-0.0033953681122511625,
0.042175374925136566,
-0.10289517045021057,
0.015138562768697739,
-0.03... | 0.041999 |
| | 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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_scale/_index.md | main | kubernetes | [
0.015281644649803638,
0.07580984383821487,
0.005405541975051165,
0.018466565757989883,
-0.040394701063632965,
-0.006054998841136694,
-0.008069530129432678,
-0.02214113622903824,
0.04473146051168442,
-0.013792033307254314,
-0.04779524356126785,
-0.14643704891204834,
0.09862017631530762,
-0.... | 0.081356 |
## {{% heading "synopsis" %}} List all available plugin files on a user's PATH. To see plugins binary names without the full path use --name-only flag. Available plugin files are those that are: - executable - anywhere on the user's PATH - begin with "kubectl-" ``` kubectl plugin list [flags] ``` ## {{% heading "examples" %}} ``` # List all available plugins kubectl plugin list # List only binary names of available plugins without paths kubectl plugin list --name-only ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for list | | --name-only | | | | If true, display only the binary name of each plugin, rather than its full path | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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" | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_plugin/kubectl_plugin_list.md | main | kubernetes | [
0.0011079527903348207,
0.05248017981648445,
0.008089989423751831,
0.04319937527179718,
0.013623157516121864,
0.015611802227795124,
0.02849382907152176,
0.04167526587843895,
0.0013752963859587908,
-0.014063180424273014,
0.011093192733824253,
-0.12009485810995102,
-0.02092791721224785,
0.033... | 0.035083 |
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 | ## {{% heading "seealso" %}} \* [kubectl plugin](../) - Provides utilities for interacting with plugins | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_plugin/kubectl_plugin_list.md | main | kubernetes | [
0.041221603751182556,
0.038708124309778214,
-0.026554619893431664,
0.010490687564015388,
-0.06685011088848114,
-0.02023056522011757,
0.01027637254446745,
-0.01044172141700983,
0.1563275009393692,
0.056083958595991135,
-0.03053206019103527,
-0.09008370339870453,
0.07804910838603973,
-0.0139... | 0.100824 |
## {{% heading "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: [krew.sigs.k8s.io]. To install krew, visit https://krew.sigs.k8s.io/docs/user-guide/setup/install ``` kubectl plugin [flags] ``` ## {{% heading "examples" %}} ``` # List all available plugins kubectl plugin list # List only binary names of available plugins without paths kubectl plugin list --name-only ``` ## {{% heading "options" %}} | -h, --help | | | --- | --- | | | help for plugin | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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: | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_plugin/_index.md | main | kubernetes | [
-0.04011344909667969,
-0.014795376919209957,
0.05188180133700371,
0.019068773835897446,
-0.043370917439460754,
0.05202685669064522,
-0.03170838579535484,
0.010130482725799084,
0.04120718315243721,
0.01445477269589901,
-0.01239448320120573,
-0.1230192631483078,
-0.04305769130587578,
0.01774... | 0.113202 |
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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager \* [kubectl plugin list](kubectl\_plugin\_list/) - List all visible plugin executables on a user's PATH | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_plugin/_index.md | main | kubernetes | [
0.034519124776124954,
0.050694067031145096,
-0.11121287941932678,
0.028667138889431953,
-0.07620327174663544,
-0.058413222432136536,
0.014310672879219055,
0.011663108132779598,
0.07334382832050323,
0.022391214966773987,
0.015348552726209164,
-0.10665103048086166,
0.10952067375183105,
-0.00... | 0.110208 |
## {{% heading "synopsis" %}} Wait for a specific condition on one or many resources. The command takes multiple resources and waits until the specified condition is seen in the Status field of every given resource. Alternatively, the command can wait for the given set of resources to be created or deleted by providing the "create" or "delete" keyword as the value to the --for flag. A successful message will be printed to stdout indicating when the specified condition has been met. You can use -o option to change to output destination. ``` kubectl wait ([-f FILENAME] | resource.group/resource.name | resource.group [(-l label | --all)]) [--for=create|--for=delete|--for condition=available|--for=jsonpath='{}'[=value]] ``` ## {{% heading "examples" %}} ``` # Wait for the pod "busybox1" to contain the status condition of type "Ready" kubectl wait --for=condition=Ready pod/busybox1 # The default value of status condition is true; you can wait for other targets after an equal delimiter (compared after Unicode simple case folding, which is a more general form of case-insensitivity) kubectl wait --for=condition=Ready=false pod/busybox1 # Wait for the pod "busybox1" to contain the status phase to be "Running" kubectl wait --for=jsonpath='{.status.phase}'=Running pod/busybox1 # Wait for pod "busybox1" to be Ready kubectl wait --for='jsonpath={.status.conditions[?(@.type=="Ready")].status}=True' pod/busybox1 # Wait for the service "loadbalancer" to have ingress kubectl wait --for=jsonpath='{.status.loadBalancer.ingress}' service/loadbalancer # Wait for the secret "busybox1" to be created, with a timeout of 30s kubectl create secret generic busybox1 kubectl wait --for=create secret/busybox1 --timeout=30s # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command kubectl delete pod/busybox1 kubectl wait --for=delete pod/busybox1 --timeout=60s ``` ## {{% heading "options" %}} | --all | | | --- | --- | | | Select all resources in the namespace of the specified resource types | | -A, --all-namespaces | | | | If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | | --allow-missing-template-keys Default: true | | | | If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. | | --field-selector string | | | | Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. | | -f, --filename strings | | | | identifying the resource. | | --for string | | | | The condition to wait on: [create|delete|condition=condition-name[=condition-value]|jsonpath='{JSONPath expression}'=[JSONPath value]]. The default condition-value is true. Condition values are compared after Unicode simple case folding, which is a more general form of case-insensitivity. | | -h, --help | | | | help for wait | | --local | | | | If true, annotation will NOT contact api-server but run locally. | | -o, --output string | | | | Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). | | -R, --recursive Default: true | | | | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. | | -l, --selector string | | | | Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) | | --show-managed-fields | | | | If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | --timeout duration Default: 30s | | | | | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_wait/_index.md | main | kubernetes | [
0.00037862229510210454,
0.05057186260819435,
-0.0048924763686954975,
0.042488209903240204,
0.020719759166240692,
-0.0030071930959820747,
0.028372954577207565,
-0.0769624412059784,
0.09855753928422928,
-0.016853440552949905,
0.018794478848576546,
-0.07539191842079163,
-0.007143132388591766,
... | 0.105237 |
If true, keep the managedFields when printing objects in JSON or YAML format. | | --template string | | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. | | --timeout duration Default: 30s | | | | The length of time to wait before giving up. Zero means check once and don't wait, negative means wait for a week. | ## {{% heading "parentoptions" %}} | --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. | | --as-user-extra strings | | | | User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. | | --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 | | --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. | | --kuberc string | | | | Path 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-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|trace) | | --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 | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_wait/_index.md | main | kubernetes | [
-0.022891758009791374,
0.09239137172698975,
-0.039092712104320526,
0.06337663531303406,
-0.04518086835741997,
-0.0015384296420961618,
0.016237085685133934,
0.022798508405685425,
-0.03073888272047043,
-0.03390783444046974,
0.10209368169307709,
-0.037942901253700256,
-0.013442429713904858,
0... | 0.033777 |
| 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 | ## {{% heading "seealso" %}} \* [kubectl](../kubectl/) - kubectl controls the Kubernetes cluster manager | https://github.com/kubernetes/website/blob/main//content/en/docs/reference/kubectl/generated/kubectl_wait/_index.md | main | kubernetes | [
-0.003244162304326892,
0.028847722336649895,
-0.055884916335344315,
-0.01674445904791355,
-0.07729291170835495,
-0.024253668263554573,
-0.01085849292576313,
0.011170733720064163,
0.04770159721374512,
-0.012039014138281345,
-0.026711180806159973,
-0.13546296954154968,
0.10170632600784302,
0... | 0.071333 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.