describe

Describe a node

  1. kubectl describe nodes kubernetes-node-emt8.c.myproject.internal

Describe a pod

  1. kubectl describe pods/nginx

Describe a pod identified by type and name in “pod.json”

  1. kubectl describe -f pod.json

Describe all pods

  1. kubectl describe pods

Describe pods by label name=myLabel

  1. 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)

  1. kubectl describe pods frontend

Show details of a specific resource or group of resources.

Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example:

$ 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.

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

Usage

$ kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

Flags

NameShorthandDefaultUsage
all-namespacesAfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with —namespace.
chunk-size500Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future.
filenamef[]Filename, directory, or URL to files containing the resource to describe
kustomizekProcess the kustomization directory. This flag can’t be used together with -f or -R.
recursiveRfalseProcess the directory used in -f, —filename recursively. Useful when you want to manage related manifests organized within the same directory.
selectorlSelector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’.(e.g. -l key1=value1,key2=value2)
show-eventstrueIf true, display events related to the described object.