kubectl api-resources

Synopsis

Print the supported API resources on the server.

  1. kubectl api-resources [flags]

Examples

  1. # Print the supported API resources
  2. kubectl api-resources
  3. # Print the supported API resources with more information
  4. kubectl api-resources -o wide
  5. # Print the supported API resources sorted by a column
  6. kubectl api-resources --sort-by=name
  7. # Print the supported namespaced resources
  8. kubectl api-resources --namespaced=true
  9. # Print the supported non-namespaced resources
  10. kubectl api-resources --namespaced=false
  11. # Print the supported API resources with a specific APIGroup
  12. kubectl api-resources --api-group=rbac.authorization.k8s.io

Options

—api-group string

Limit to resources in the specified API group.

—cached

Use the cached list of resources if available.

—categories strings

Limit to resources that belong to the specified categories.

-h, —help

help for api-resources

—namespaced     Default: true

If false, non-namespaced resources will be returned, otherwise returning namespaced resources by default.

—no-headers

When using the default or custom-column output format, don’t print headers (default print headers).

-o, —output string

Output format. One of: (wide, name).

—sort-by string

If non-empty, sort list of resources using specified field. The field can be either ‘name’ or ‘kind’.

—verbs strings

Limit to resources that support the specified verbs.

—as string

Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

—as-group strings

Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

—as-uid string

UID to impersonate for the operation.

—cache-dir string     Default: “$HOME/.kube/cache”

Default cache directory

—certificate-authority string

Path to a cert file for the certificate authority

—client-certificate string

Path to a client certificate file for TLS

—client-key string

Path to a client key file for TLS

—cluster string

The name of the kubeconfig cluster to use

—context string

The name of the kubeconfig context to use

—default-not-ready-toleration-seconds int     Default: 300

Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.

—default-unreachable-toleration-seconds int     Default: 300

Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.

—disable-compression

If true, opt-out of response compression for all requests to the server

—insecure-skip-tls-verify

If true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure

—kubeconfig string

Path to the kubeconfig file to use for CLI requests.

—match-server-version

Require server version to match client version

-n, —namespace string

If present, the namespace scope for this CLI request

—password string

Password for basic authentication to the API server

—profile string     Default: “none”

Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

—profile-output string     Default: “profile.pprof”

Name of the file to write the profile to

—request-timeout string     Default: “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 string

The address and port of the Kubernetes API server

—storage-driver-buffer-duration duration     Default: 1m0s

Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

—storage-driver-db string     Default: “cadvisor”

database name

—storage-driver-host string     Default: “localhost:8086”

database host:port

—storage-driver-password string     Default: “root”

database password

—storage-driver-secure

use secure connection with database

—storage-driver-table string     Default: “stats”

table name

—storage-driver-user string     Default: “root”

database username

—tls-server-name string

Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

—token string

Bearer token for authentication to the API server

—user string

The name of the kubeconfig user to use

—username string

Username for basic authentication to the API server

—version version[=true]

—version, —version=raw prints version information and quits; —version=vX.Y.Z… sets the reported version

—warnings-as-errors

Treat warnings received from the server as errors and exit with a non-zero exit code

See Also

  • kubectl - kubectl controls the Kubernetes cluster manager