kubectl-describe man page

kubectl describe — Show details of a specific resource or group of resources


kubectl describe [Options]


Show details of a specific resource or group of resources.

This command joins many API calls together to form a detailed description of a given resource or group of resources.

$ kubectl describe TYPE NAME_PREFIX

will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX

Possible resource types include (case insensitive): pods (po), services (svc), deployments, replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, componentstatuses (cs), endpoints (ep), and secrets.


-f, --filename=[]
Filename, directory, or URL to a file containing the resource to describe
If true, include definitions of new APIs via calls to the API server. [default true]
-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
If true, display events related to the described object.

Options Inherited from Parent Commands

log to standard error as well as files

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

Username to impersonate for the operation.

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

The name of the kubeconfig context to use

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

Path to the kubeconfig file to use for CLI requests.

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

If non-empty, write log files in this directory

Maximum number of seconds between log flushes

log to standard error instead of files

Require server version to match client version

If present, the namespace scope for this CLI request.

Password for basic authentication to the API server.

-s, --server=""
The address and port of the Kubernetes API server

logs at or above this threshold go to stderr

Bearer token for authentication to the API server.

The name of the kubeconfig user to use

Username for basic authentication to the API server.

log level for V logs

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


# Describe a node
kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal

# Describe a pod
kubectl describe pods/nginx

# Describe a pod identified by type and name in "pod.json"
kubectl describe -f pod.json

# Describe all pods
kubectl describe pods

# Describe pods by label name=myLabel
kubectl describe po -l name=myLabel

# Describe all pods managed by the 'frontend' replication controller (rc-created pods
# get the name of the rc as a prefix in the pod the name).
kubectl describe pods frontend

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


Explore man page connections for kubectl-describe(1).