LinuxCommandLibrary

kubectl-describe

shows detailed resource information

TLDR

Describe pod

$ kubectl describe pod [pod-name]
copy
Describe node
$ kubectl describe node [node-name]
copy
Describe deployment
$ kubectl describe deployment [deployment-name]
copy
Describe with selector
$ kubectl describe pods -l [app=myapp]
copy
Describe in namespace
$ kubectl describe pod [pod-name] -n [namespace]
copy

SYNOPSIS

kubectl describe [options] resource [name]

DESCRIPTION

kubectl describe produces a detailed, human-readable summary of one or more Kubernetes resources. Unlike `kubectl get`, which returns structured data fields, describe aggregates information from multiple API calls to present a comprehensive view that includes resource metadata, spec, current status, conditions, allocated resources, mounted volumes, and associated events.
The command is particularly valuable for troubleshooting, as the Events section at the bottom of the output shows recent actions taken by controllers, schedulers, and the kubelet -- such as image pull failures, scheduling decisions, readiness probe results, and container restarts. For nodes, it displays capacity, allocatable resources, running pods, and system conditions.
Output from describe is formatted for human consumption and should not be parsed programmatically. For structured data suitable for scripting, use `kubectl get -o json` or `kubectl get -o yaml` instead.

PARAMETERS

RESOURCE

Resource type (pod, node, deployment, etc.).
NAME
Resource name (optional).
-l SELECTOR
Label selector.
-n NAMESPACE
Target namespace.
--all-namespaces
Search all namespaces.
--help
Display help information.

CAVEATS

Subcommand of kubectl. Output not for parsing. Use get -o json for structured data.

HISTORY

kubectl describe provides detailed resource inspection for Kubernetes troubleshooting.

SEE ALSO

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community