KUBERNETES(1)(kubernetes)

✨ KUBERNETES(1)(kubernetes) ✨

okay bestie so you found the kubectl manpage section of the Kubernetes manual (yes, the manual is literally named kubernetes, that's the vibe) 🫢 and this particular page was put together by Eric Paris all the way back in January 2015. let's get into it πŸ’…


πŸ’– NAME πŸ’–

kubectl options β€” this prints out the list of flags that every single kubectl command inherits. like, the whole shared wardrobe of flags. no cap. πŸ‘‘


🌸 SYNOPSIS 🌸

kubectl options [OPTIONS]

πŸ¦‹ DESCRIPTION πŸ¦‹

Print the list of flags inherited by all commands. that's it. that's the whole job. she's simple, she's iconic, she's serving pure utility ✨


πŸŽ€ OPTIONS INHERITED FROM PARENT COMMANDS πŸŽ€

these bad boys come down from the parent commands, so they're basically the family heirlooms πŸ’œ

  • --as="" β€” the username you wanna impersonate for the operation. could be a regular user, or a service account sitting inside a namespace.
  • --as-group=[] β€” the group you wanna impersonate for the operation. lowkey repeatable, so you can pass it multiple times to line up multiple groups.
  • --as-uid="" β€” the UID you wanna impersonate for the operation.
  • --as-user-extra=[] β€” user extras you wanna impersonate for the operation. also repeatable, so you can stack multiple values onto the same key.
  • --cache-dir="/home/username/.kube/cache" β€” the default cache directory. that's her home 🏠
  • --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, you 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. heads up bestie, this makes your HTTPS connections insecure 🚨
  • --kubeconfig="" β€” path to the kubeconfig file to use for CLI requests.
  • --kuberc="" β€” path to the kuberc file to use for preferences. you can turn this off by exporting the KUBECTL_KUBERC=false feature gate, or by turning off the feature with KUBERC=off.
  • --match-server-version=false β€” require the server version to match the 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 the 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" β€” how long to wait before giving up on a single server request. non-zero values should carry a matching time unit (e.g. 1s, 2m, 3h). a value of zero means don't timeout requests, we wait forever, we are devoted πŸ’€
  • -s, --server="" β€” the address and port of the Kubernetes API server.
  • --tls-server-name="" β€” server name to use for server certificate validation. if it's not provided, the hostname used to contact the server is used instead.
  • --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. dramatic but valid 😭

🌈 EXAMPLE 🌈

  # Print flags inherited by all commands
  kubectl options

πŸ‘‘ SEE ALSO πŸ‘‘


🧚 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! (her words, not mine β€” she's manifesting automation πŸ™ˆ)


and that's the whole page, bestie πŸ’– this one came out of the Manuals / User corner of the docs, filed under KUBERNETES(1)(kubernetes), dated Jan 2015. go forth and print those inherited flags, you absolute main character πŸŽ€βœ¨

πŸ“¦ where this page comes from