Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

Edit This Page

kubectl describe

Show details of a specific resource or group of resources


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.

Valid resource types include: * clusters (valid only for federation apiservers) * componentstatuses (aka ‘cs’) * configmaps (aka ‘cm’) * daemonsets (aka ‘ds’) * deployments (aka ‘deploy’) * events (aka ‘ev’) * endpoints (aka ‘ep’) * horizontalpodautoscalers (aka ‘hpa’) * ingress (aka ‘ing’) * jobs * limitranges (aka ‘limits’) * nodes (aka ‘no’) * namespaces (aka ‘ns’) * petsets (alpha feature, may be unstable) * pods (aka ‘po’) * persistentvolumes (aka ‘pv’) * persistentvolumeclaims (aka ‘pvc’) * quota * resourcequotas (aka ‘quota’) * replicasets (aka ‘rs’) * replicationcontrollers (aka ‘rc’) * secrets * serviceaccounts (aka ‘sa’) * services (aka ‘svc’)

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


# 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


      --all-namespaces          If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
  -f, --filename value          Filename, directory, or URL to a file containing the resource to describe (default [])
      --include-extended-apis   If true, include definitions of new APIs via calls to the API server. [default true] (default true)
  -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
      --show-events             If true, display events related to the described object. (default true)

Options inherited from parent commands

      --alsologtostderr value          log to standard error as well as files
      --as string                      Username to impersonate for the operation
      --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
      --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.
      --log-backtrace-at value         when logging hits line file:N, emit a stack trace (default :0)
      --log-dir value                  If non-empty, write log files in this directory
      --logtostderr value              log to standard error instead of files
      --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
  -s, --server string                  The address and port of the Kubernetes API server
      --stderrthreshold value          logs at or above this threshold go to stderr (default 2)
      --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
  -v, --v value                        log level for V logs
      --vmodule value                  comma-separated list of pattern=N settings for file-filtered logging
Auto generated by spf13/cobra on 2-Sep-2016



Create Issue Edit This Page