kubectl describe for details in Kubernetes - Step-by-Step Execution

Process Flow - kubectl describe for details

User runs 'kubectl describe'

↓

kubectl sends request to API Server

↓

API Server fetches resource details

↓

kubectl receives detailed info

↓

kubectl displays info to user

This flow shows how 'kubectl describe' requests detailed info about a Kubernetes resource and displays it.

Execution Sample

Kubernetes

kubectl describe pod my-pod

Shows detailed information about the pod named 'my-pod'.

Process Table

Step	Action	Input/Condition	Result/Output
1	User runs command	'kubectl describe pod my-pod'	kubectl starts request to API Server
2	kubectl sends request	Request for pod 'my-pod' details	API Server receives request
3	API Server processes	Look up pod 'my-pod' in cluster	Fetch pod details including status, labels, containers, events
4	kubectl receives data	Pod details from API Server	Data ready to display
5	kubectl displays	Pod details data	Detailed pod info shown in terminal
6	End	All info displayed	Command completes

💡 All pod details retrieved and displayed, command ends.

Status Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
Request	None	Request for pod 'my-pod'	Request sent to API Server	Response with pod details	Displayed pod details
Pod Details	None	None	Fetched pod info	Received by kubectl	Shown to user

Key Moments - 2 Insights

Why does 'kubectl describe' show more info than 'kubectl get'?

'kubectl describe' fetches detailed resource info including events and container states, as shown in execution_table step 3 and 5, while 'kubectl get' shows only summary.

What happens if the pod name is wrong?

kubectl sends request (step 2), API Server cannot find pod (step 3), and returns an error, so no details are displayed (step 5).

Visual Quiz - 3 Questions

Look at the execution_table, what happens at step 3?

A kubectl sends request to API Server

B kubectl displays pod info

C API Server fetches pod details

D User runs the command

💡 Hint

Check the 'Action' and 'Result/Output' columns at step 3 in execution_table.

According to variable_tracker, what is the state of 'Pod Details' after step 4?

A Received by kubectl

B None

C Request sent to API Server

D Displayed pod details

💡 Hint

Look at the 'Pod Details' row and the 'After Step 4' column in variable_tracker.

If the pod name is incorrect, which step will fail to find the pod?

A Step 2

B Step 3

C Step 1

D Step 5

💡 Hint

Refer to key_moments explanation about pod name errors and execution_table step 3.

Concept Snapshot

kubectl describe <resource> <name>
Fetches detailed info about a Kubernetes resource.
Shows status, labels, events, container states.
More detailed than 'kubectl get'.
Useful for debugging and inspection.

Full Transcript

The 'kubectl describe' command asks the Kubernetes API Server for detailed information about a resource like a pod. The command sends a request, the API Server looks up the resource, and returns detailed data including status and events. Kubectl then shows this info in the terminal. This helps users see more than just a summary, useful for troubleshooting. If the resource name is wrong, the API Server returns an error and no details are shown.

Practice

1. What does the kubectl describe command primarily show about a Kubernetes resource?

easy

A. Detailed information including status, events, and configuration of the resource

B. Only the YAML configuration of the resource

C. The logs generated by the resource

D. The list of all resources in the cluster

Solution

1. Step 1: Understand the purpose of kubectl describe

   This command provides detailed information about a specific Kubernetes resource, including its current status, configuration details, and recent events.

2. Step 2: Compare with other kubectl commands

   Unlike kubectl get which lists resources or kubectl logs which shows logs, kubectl describe gives a detailed snapshot of the resource's state and events.

3. Final Answer:

   Detailed information including status, events, and configuration of the resource -> Option A

4. Quick Check:

   kubectl describe = detailed resource info [OK]

Hint: Remember: describe = detailed info + events [OK]

Common Mistakes:

• Confusing describe with get for YAML output
• Expecting logs from describe command
• Using describe without specifying resource name

2. Which of the following is the correct syntax to describe a pod named web-server in the default namespace?

easy

A. kubectl describe pod web-server -n default

B. kubectl describe pods web-server default

C. kubectl describe web-server pod -n default

D. kubectl describe pod web-server

Solution

1. Step 1: Identify correct resource type and name syntax

   The command format is kubectl describe <resource-type> <resource-name>. For pods, resource type is pod (singular or plural works but singular is preferred).

2. Step 2: Specify namespace correctly

   To specify the namespace, use the -n or --namespace flag after the resource name. The correct placement is kubectl describe pod web-server -n default.

3. Final Answer:

   kubectl describe pod web-server -n default -> Option A

4. Quick Check:

   Correct syntax = resource type + name + -n namespace [OK]

Hint: Use '-n' flag for namespace after resource name [OK]

Common Mistakes:

• Placing namespace as a positional argument
• Swapping resource name and type order
• Omitting the namespace flag when needed

3. Given the command kubectl describe node worker-node-1, what key information would you expect to see in the output?

medium

A. List of all pods in the cluster

B. Pod logs running on worker-node-1

C. Detailed node status including capacity, conditions, and allocated resources

D. YAML configuration of the node

Solution

1. Step 1: Understand what describing a node shows

   kubectl describe node shows detailed info about the node's status, including CPU and memory capacity, conditions like Ready or NotReady, and resource allocation.

2. Step 2: Differentiate from other outputs

   It does not show pod logs (that's kubectl logs), nor does it list all pods or show YAML (that's kubectl get node -o yaml).

3. Final Answer:

   Detailed node status including capacity, conditions, and allocated resources -> Option C

4. Quick Check:

   Describe node = status + capacity + conditions [OK]

Hint: Describe node shows status and capacity, not logs [OK]

Common Mistakes:

• Expecting pod logs from node describe
• Confusing describe output with get -o yaml
• Thinking it lists all pods in cluster

4. You run kubectl describe pod myapp-pod but get an error: Error from server (NotFound): pods "myapp-pod" not found. What is the most likely cause?

medium

A. You need to add --all-namespaces to describe pods

B. The kubectl describe command does not support pods

C. The Kubernetes cluster is down

D. The pod name is incorrect or does not exist in the current namespace

Solution

1. Step 1: Analyze the error message

   The error says the pod "myapp-pod" was not found. This usually means the pod name is wrong or it does not exist in the current namespace.

2. Step 2: Check command and cluster status

   kubectl describe supports pods, and the cluster being down would cause different errors. Also, --all-namespaces is not required but can help find pods in other namespaces.

3. Final Answer:

   The pod name is incorrect or does not exist in the current namespace -> Option D

4. Quick Check:

   NotFound error = wrong pod name or namespace [OK]

Hint: Check pod name and namespace if NotFound error appears [OK]

Common Mistakes:

• Assuming describe doesn't support pods
• Ignoring namespace context
• Thinking cluster is down without checking

5. You want to check why a deployment named frontend is not creating pods as expected. Which kubectl describe command and output section will help you diagnose the issue?

hard

A. kubectl describe pod frontend; check the Status section for pod readiness

B. kubectl describe deployment frontend; check the Events section for errors

C. kubectl describe service frontend; check the Endpoints section

D. kubectl describe node frontend; check the Capacity section

Solution

1. Step 1: Identify the correct resource to describe

   Since the issue is with a deployment named frontend, you should describe the deployment resource, not pods, services, or nodes.

2. Step 2: Locate the useful output section

   The Events section in the deployment description shows recent errors or warnings related to pod creation or scaling issues, which helps diagnose why pods are not created.

3. Final Answer:

   kubectl describe deployment frontend; check the Events section for errors -> Option B

4. Quick Check:

   Describe deployment + Events = diagnose pod creation issues [OK]

Hint: Check deployment Events for pod creation errors [OK]

Common Mistakes:

• Describing pod instead of deployment
• Checking service or node instead of deployment
• Ignoring Events section in output