kubectl-get man page

kubectl get — Display one or many resources


kubectl get [Options]


Display one or many resources.

Valid resource types include:

item clusters (valid only for federation apiservers)
item componentstatuses (aka 'cs')
item configmaps (aka 'cm')
item daemonsets (aka 'ds')
item deployments (aka 'deploy')
item endpoints (aka 'ep')
item events (aka 'ev')
item horizontalpodautoscalers (aka 'hpa')
item ingresses (aka 'ing')
item jobs
item limitranges (aka 'limits')
item namespaces (aka 'ns')
item networkpolicies
item nodes (aka 'no')
item persistentvolumeclaims (aka 'pvc')
item persistentvolumes (aka 'pv')
item pods (aka 'po')
item podsecuritypolicies (aka 'psp')
item podtemplates
item replicasets (aka 'rs')
item replicationcontrollers (aka 'rc')
item resourcequotas (aka 'quota')
item secrets
item serviceaccounts (aka 'sa')
item services (aka 'svc')
item statefulsets
item storageclasses
item thirdpartyresources

This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases. You can see the full results for any resource by providing the '--show-all' flag.

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 resource(s).


If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information.
-f, --filename=[]
Filename, directory, or URL to files identifying the resource to get from a server.
If true, include definitions of new APIs via calls to the API server. [default true]
-L, --label-columns=[]
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...
When using the default or custom-column output format, don't print headers.
-o, --output=""
Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [ ⟨http://kubernetes.io/docs/user-guide/ku…⟩], golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://kubernetes.io/docs/user-guide/js…⟩].
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
Raw URI to request from the server. Uses the transport specified by the kubeconfig file.
-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
-l, --selector=""
Selector (label query) to filter on
-a, --show-all=false
When printing, show all resources (default hide terminated pods.)
If present, list the resource type for the requested object(s).
When printing, show all labels as the last column (default hide labels column)
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.
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/#pk…⟩].
-w, --watch=false
After listing/getting the requested object, watch for changes.
Watch for changes to the requested object(s), without listing/getting first.

Options Inherited from Parent Commands

Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.

log to standard error as well as files

DEPRECATED: The API version to use when talking to the server

Max number of application metrics to store (per container)

Username to impersonate for the operation

Path to the file container Azure container registry configuration information.

Comma-separated list of files to check for boot-id. Use the first one that exists.

Path to a cert. file for the certificate authority

Path to a client certificate file for TLS

Path to a client key file for TLS

The name of the kubeconfig cluster to use

location of the container hints file

The name of the kubeconfig context to use

docker endpoint

a comma-separated list of environment variable keys that needs to be collected for docker containers

Only report docker containers in addition to root stats

DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)

Whether to enable cpu load reader

Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types

Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types

Interval between global housekeepings

The Google Cloud Platform Service Account JSON Key to use for authentication.

Interval between container housekeepings

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

Data source used by InitialResources. Supported options: influxdb, gcm.

InfluxDB database name which contains metrics required by InitialResources

Hawkular configuration URL

Address of InfluxDB which contains metrics required by InitialResources

Whether the estimation should be made only based on data from the same namespace.

Password used for connecting to InfluxDB

Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.

User used for connecting to InfluxDB

Path to the kubeconfig file to use for CLI requests.

when logging hits line file:N, emit a stack trace

Whether to log the usage of the cAdvisor container

If non-empty, write log files in this directory

Log level (0 = DEBUG, 5 = FATAL)

log to standard error instead of files

Comma-separated list of files to check for machine-id. Use the first one that exists.

Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request

Password for basic authentication to the API server

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

logs at or above this threshold go to stderr

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

database name

database host:port

database password

use secure connection with database

table name

database username

Bearer token for authentication to the API server

The name of the kubeconfig user to use

Username for basic authentication to the API server

-v, --v=0
log level for V logs

comma-separated list of pattern=N settings for file-filtered logging


# List all pods in ps output format.
kubectl get pods

# List all pods in ps output format with more information (such as node name).
kubectl get pods -o wide

# List a single replication controller with specified NAME in ps output format.
kubectl get replicationcontroller web

# List a single pod in JSON output format.
kubectl get -o json pod web-pod-13je7

# List a pod identified by type and name specified in "pod.yaml" in JSON output format.
kubectl get -f pod.yaml -o json

# Return only the phase value of the specified pod.
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}

# List all replication controllers and services together in ps output format.
kubectl get rc,services

# List one or more resources by their type and names.
kubectl get rc/web service/frontend pods/web-pod-13je7

See Also



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!

Referenced By


kubernetes User Manuals Eric Paris Jan 2015