kubectl-config - Man Page
Modify kubeconfig files
Examples (TL;DR)
- Get all contexts in the default kubeconfig file:
kubectl config get-contexts
- Get all clusters/contexts/users in a custom kubeconfig file:
kubectl config get-clusters|get-contexts|get-users --kubeconfig path/to/kubeconfig.yaml
- Get the current context:
kubectl config current-context
- Switch to another context:
kubectl config use|use-context context_name
- Delete clusters/contexts/users:
kubectl config delete-cluster|delete-context|delete-user cluster|context|user
- Permanently add custom kubeconfig files:
export KUBECONFIG="$HOME.kube/config:path/to/custom/kubeconfig.yaml" kubectl config get-contexts
Eric Paris Jan 2015
Synopsis
kubectl config [Options]
Description
Modify kubeconfig files using subcommands like "kubectl config set current-context my-context".
The loading order follows these rules:
- If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place.
- 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.
- Otherwise, ${HOME}/.kube/config is used and no merging takes place.
Options
--kubeconfig="" use a particular kubeconfig file
Options Inherited from Parent Commands
--as="" Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group=[] Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid="" UID to impersonate for the operation.
--azure-container-registry-config="" Path to the file containing Azure container registry configuration information.
--cache-dir="/home/username/.kube/cache" Default cache directory
--certificate-authority="" Path to a cert file for the certificate authority
--client-certificate="" Path to a client certificate file for TLS
--client-key="" Path to a client key file for TLS
--cluster="" The name of the kubeconfig cluster to use
--context="" The name of the kubeconfig context to use
--disable-compression=false If true, opt-out of response compression for all requests to the server
--insecure-skip-tls-verify=false If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--match-server-version=false Require server version to match client version
-n, --namespace="" If present, the namespace scope for this CLI request
--password="" Password for basic authentication to the API server
--profile="none" Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)
--profile-output="profile.pprof" Name of the file to write the profile to
--request-timeout="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="" The address and port of the Kubernetes API server
--tls-server-name="" Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token="" Bearer token for authentication to the API server
--user="" The name of the kubeconfig user to use
--username="" Username for basic authentication to the API server
--version=false --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version
--warnings-as-errors=false Treat warnings received from the server as errors and exit with a non-zero exit code
See Also
kubectl(1), kubectl-config-current-context(1), kubectl-config-delete-cluster(1), kubectl-config-delete-context(1), kubectl-config-delete-user(1), kubectl-config-get-clusters(1), kubectl-config-get-contexts(1), kubectl-config-get-users(1), kubectl-config-rename-context(1), kubectl-config-set(1), kubectl-config-set-cluster(1), kubectl-config-set-context(1), kubectl-config-set-credentials(1), kubectl-config-unset(1), kubectl-config-use-context(1), kubectl-config-view(1),
History
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!
Referenced By
kubectl(1), kubectl-config-current-context(1), kubectl-config-delete-cluster(1), kubectl-config-delete-context(1), kubectl-config-delete-user(1), kubectl-config-get-clusters(1), kubectl-config-get-contexts(1), kubectl-config-get-users(1), kubectl-config-rename-context(1), kubectl-config-set(1), kubectl-config-set-cluster(1), kubectl-config-set-context(1), kubectl-config-set-credentials(1), kubectl-config-unset(1), kubectl-config-use-context(1), kubectl-config-view(1).