kubectl get

Synopsis

Display one or many resources.

Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the —selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass —all-namespaces.

By specifying the output as ‘template’ and providing a Go template as the value of the —template flag, you can filter the attributes of the fetched resources.

Use “kubectl api-resources” for a complete list of supported resources.

  1. kubectl get [(-o|--output=)json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file|custom-columns|custom-columns-file|wide] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags]

Examples

  1.   # List all pods in ps output format
  2.   kubectl get pods
  4.   # List all pods in ps output format with more information (such as node name)
  5.   kubectl get pods -o wide
  7.   # List a single replication controller with specified NAME in ps output format
  8.   kubectl get replicationcontroller web
  10.   # List deployments in JSON output format, in the "v1" version of the "apps" API group
  11.   kubectl get deployments.v1.apps -o json
  13.   # List a single pod in JSON output format
  14.   kubectl get -o json pod web-pod-13je7
  16.   # List a pod identified by type and name specified in "pod.yaml" in JSON output format
  17.   kubectl get -f pod.yaml -o json
  19.   # List resources from a directory with kustomization.yaml - e.g. dir/kustomization.yaml
  20.   kubectl get -k dir/
  22.   # Return only the phase value of the specified pod
  23.   kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
  25.   # List resource information in custom columns
  26.   kubectl get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image
  28.   # List all replication controllers and services together in ps output format
  29.   kubectl get rc,services
  31.   # List one or more resources by their type and names
  32.   kubectl get rc/web service/frontend pods/web-pod-13je7
  34.   # List the 'status' subresource for a single pod
  35.   kubectl get pod web-pod-13je7 --subresource status

Options

-A, —all-namespaces

If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with —namespace.

—allow-missing-template-keys     Default: true

If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

—chunk-size int     Default: 500

Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.

—field-selector string

Selector (field query) to filter on, supports ‘=’, ‘==’, and ‘!=’.(e.g. —field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.

-f, —filename strings

Filename, directory, or URL to files identifying the resource to get from a server.

-h, —help

help for get

—ignore-not-found

If the requested object does not exist the command will return exit code 0.

-k, —kustomize string

Process the kustomization directory. This flag can’t be used together with -f or -R.

-L, —label-columns strings

Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2…

—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: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns [https://kubernetes.io/docs/reference/kubectl/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/].

—output-watch-events

Output watch event objects when —watch or —watch-only is used. Existing objects are output as initial ADDED events.

—raw string

Raw URI to request from the server. Uses the transport specified by the kubeconfig file.

-R, —recursive

Process the directory used in -f, —filename recursively. Useful when you want to manage related manifests organized within the same directory.

-l, —selector string

Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

—server-print     Default: true

If true, have the server return the appropriate table output. Supports extension APIs and CRDs.

—show-kind

If present, list the resource type for the requested object(s).

—show-labels

When printing, show all labels as the last column (default hide labels column)

—show-managed-fields

If true, keep the managedFields when printing objects in JSON or YAML format.

—sort-by string

If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. ‘{.metadata.name}’). The field in the API resource specified by this JSONPath expression must be an integer or a string.

—subresource string

If specified, gets the subresource of the requested object. Must be one of [status scale]. This flag is beta and may change in the future.

—template string

Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].

-w, —watch

After listing/getting the requested object, watch for changes.

—watch-only

Watch for changes to the requested object(s), without listing/getting first.

—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

—cloud-provider-gce-l7lb-src-cidrs cidrs     Default: 130.211.0.0/22,35.191.0.0/16

CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks

—cloud-provider-gce-lb-src-cidrs cidrs     Default: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16

CIDRs opened in GCE firewall for L4 LB traffic proxy & health checks

—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