KUBERNETES(1)(kubernetes)

💖 KUBERNETES(1)(kubernetes) 💖

okay bestie, grab a boba because we're about to read the manual page for kubectl config, and I promise it's gonna be cute AND useful. This one's from Eric Paris, dated Jan 2015 (a whole legend), and it lives in section 1 of the kubernetes manual. Let's go 💅

---

✨ NAME ✨

kubectl config — modify kubeconfig files

no cap, that's it. that's the whole job. it edits your kubeconfig files 🎀

---

🌸 SYNOPSIS 🌸

kubectl config [OPTIONS]

---

🦋 DESCRIPTION 🦋

You modify your kubeconfig files using subcommands, like this iconic lil number:

kubectl config set current-context my-context

now here's the tea about the loading order — the way kubectl figures out which files to read follows these rules, and you're gonna wanna memorize them fr fr:

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. periodt, one file, that's it.
2. If the $KUBECONFIG environment variable is set, then it's used as a list of paths (using the normal path delimiting rules for your system). These paths get merged. When a value is modified, it's modified in the file that defines the stanza. When a value is created, it's created in the first file that exists. And if no files in the chain exist? Then it creates the last file in the list. the audacity, honestly 😭
3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.

---

💅 OPTIONS 💅

• --kubeconfig="" — use a particular kubeconfig file 🗂️

---

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the ones you get from the parent command, and there are a LOT, so hydrate before reading:

• --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.
• --as-user-extra=[] — User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
• --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. 🚨 bestie this one is literally the "trust me bro" flag, say it with me: insecure.
• --kuberc="" — 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=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|trace) 📊
• --profile-output="profile.pprof" — Name of the file to write the profile to
• --proxy-url="" — Proxy URL to use for requests to the API server
• --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 🌈

the whole friend group, iykyk:

• 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! 😌✨

---

okay that's the whole page, you ate that 🫶 this came to you from the Manuals / User corner of the world, under KUBERNETES(1)(kubernetes), and we're signing off with all the love, a lil sparkle, and a reminder that ${HOME}/.kube/config is always waiting for you 🌸💖 bye bestie!!