KUBERNETES(1)(kubernetes)

✨ KUBERNETES(1)(kubernetes) ✨

okay bestie, welcome to the kubectl api-resources page, straight outta the kubernetes manual β€” the one and only, section 1, user commands. it was originally written by Eric Paris back in Jan 2015, and look at us now, still thriving πŸ’…


🌸 NAME 🌸

kubectl api-resources β€” print the supported API resources on the server 🫢


✨ SYNOPSIS ✨

kubectl api-resources [OPTIONS]

πŸ’– DESCRIPTION πŸ’–

bestie. it prints the supported API resources on the server. that's the whole vibe. every resource kind your cluster knows about, laid out for you like a little menu. iconic behavior, honestly 🌈


πŸŽ€ OPTIONS πŸŽ€

  • --api-group="" β€” limit it to resources in the specified API group. one group only, we're being picky πŸ’…
  • --cached=false β€” use the cached list of resources if there's one available. lowkey speedrun mode ⭐
  • --categories=[] β€” limit to resources that belong to the specified categories.
  • --namespaced=true β€” if it's false, you get the non-namespaced resources back; otherwise it returns namespaced resources by default. so true is the default, no cap.
  • --no-headers=false β€” when you're using the default or custom-column output format, this skips printing headers (default is to print them, fr fr).
  • -o, --output="" β€” output format. one of: (json, yaml, kyaml, name, wide).
  • --show-managed-fields=false β€” if true, keeps the managedFields when printing objects in JSON or YAML format.
  • --sort-by="" β€” if it's non-empty, sorts the list of resources using the specified field. the field can be either 'name' or 'kind' β€” those two, periodt.
  • --verbs=[] β€” limit to resources that support the specified verbs.

πŸ¦‹ OPTIONS INHERITED FROM PARENT COMMANDS πŸ¦‹

these are the ones that come from kubectl itself, like family heirlooms πŸ’œ

  • --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 🚨 so like, be careful bestie.
  • --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.
  • -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.

πŸ”₯ EXAMPLE πŸ”₯

# Print the supported API resources
kubectl api-resources

# Print the supported API resources with more information
kubectl api-resources -o wide

# Print the supported API resources sorted by a column
kubectl api-resources --sort-by=name

# Print the supported namespaced resources
kubectl api-resources --namespaced=true

# Print the supported non-namespaced resources
kubectl api-resources --namespaced=false

# Print the supported API resources with a specific APIGroup
kubectl api-resources --api-group=rbac.authorization.k8s.io

πŸ’€ SEE ALSO πŸ’€

  • kubectl(1), β€” go read the parent, it's giving main character energy πŸ‘‘

πŸ“œ 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! πŸ™ˆ no shade, just facts.


okay that's the whole page bestie, every flag accounted for, nothing skipped, we ate and left no crumbs πŸ“

and that's a wrap on the Manuals / User section of KUBERNETES(1)(kubernetes) β€” mwah, take care of your cluster πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from