KUBERNETES(1)(kubernetes)

πŸ‘‘ kubectl β€” the manual page, but make it make sense

okay bestie, welcome to kubectl(1) β€” that's section 1 of the kubernetes manual, the one you actually open when you're staring at a terminal at 2am and your pods are doing something unhinged. πŸ’…


✨ NAME ✨

kubectl β€” kubectl controls the Kubernetes cluster manager


✨ SYNOPSIS ✨

kubectl [OPTIONS]

✨ DESCRIPTION ✨

kubectl controls the Kubernetes cluster manager. that's the whole job description, and honestly? it ate. πŸ‘‘

want the full lore? it lives here:

https://kubernetes.io/docs/reference/kubectl/

no cap, that link is the mothership. go read it when you want the deep dive, because this page is just the global flags that apply to basically everything. πŸ¦‹


✨ OPTIONS ✨

these are the flags that ride along with literally every kubectl command. memorize the ones you use, look up the ones you don't. 🌸

  • --as="" β€” username to impersonate for the operation. could be a regular user, could be a service account chillin' in a namespace. shapeshifter energy. 🧚
  • --as-group=[] β€” group to impersonate for the operation. repeat this flag to stack up multiple groups, like friendship bracelets but for RBAC.
  • --as-uid="" β€” UID to impersonate for the operation. yep, you can cosplay as a specific UID now.
  • --as-user-extra=[] β€” user extras to impersonate for the operation. repeat the flag to give multiple values for the same key. very "and another thing" of you.
  • --cache-dir="/home/username/.kube/cache" β€” default cache directory. this is where the vibes get cached. πŸŽ€
  • --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. switching contexts is literally the main character moment of every k8s story.
  • --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. please. this one is a warning, not a personality trait. insecure HTTPS is not the slay you think it is.
  • --kubeconfig="" β€” path to the kubeconfig file to use for CLI requests.
  • --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. strict queen behavior. πŸ’…
  • -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. zero = the "we'll be here forever and that's fine" setting. 😭
  • -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. turning a warning into a whole crisis. iconic, honestly. πŸ’€

✨ SEE ALSO ✨

the whole extended universe, fr fr. go follow them all: 🌈


✨ 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! 🫢


and that's the whole page, bestie. this is the Manuals / User version of the KUBERNETES(1)(kubernetes) page, dated Jan 2015 β€” so like, vintage, but make it cluster management. πŸ’– slay responsibly. ✨

πŸ“¦ where this page comes from