kubectl explain for API reference in Kubernetes - Practice Problems & Coding Challenges

Challenge - 5 Problems

💻 Command Output

intermediate

Understanding kubectl explain output for Pod spec

What is the output of the command kubectl explain pod.spec.containers?

Kubernetes

kubectl explain pod.spec.containers

A

DESCRIPTION:
  List of containers belonging to the pod. Containers can be added or removed dynamically.

FIELDS:
  image   <string>   Image name to use for this container
  name    <string>   Name of the container
  ports   <[]>       List of ports to expose from the container

B

DESCRIPTION:
  PodSpec is a description of a pod.

FIELDS:
  containers   <[]>   List of containers belonging to the pod

C

DESCRIPTION:
  List of containers belonging to the pod. Containers cannot currently be added or removed.

FIELDS:
  image   <string>   Image name to use for this container
  name    <string>   Name of the container
  ports   <[]>       List of ports to expose from the container

D

DESCRIPTION:
  List of containers belonging to the pod. Containers cannot currently be added or removed.

FIELDS:
  image   <int>      Image ID
  name    <string>   Name of the container
  ports   <[]>       List of ports to expose from the container

💡 Hint

Focus on the description of containers in a pod and their mutability.

The 'kubectl explain pod.spec.containers' command shows the description and fields of the containers list in a pod spec. Containers cannot currently be added or removed dynamically, and the fields include image (string), name (string), and ports (list).

🧠 Conceptual

intermediate

Purpose of kubectl explain command

What is the main purpose of the kubectl explain command in Kubernetes?

A To show detailed documentation about Kubernetes API resources and their fields.

B To apply configuration changes to Kubernetes resources.

C To list all running pods in the cluster.

D To delete Kubernetes resources by name.

💡 Hint

Think about how you learn the structure of Kubernetes objects.

kubectl explain helps users understand the schema and fields of Kubernetes API objects by showing their documentation.

❓ Troubleshoot

advanced

Troubleshooting kubectl explain with invalid resource

What error message will you get if you run kubectl explain invalidresource?

Kubernetes

kubectl explain invalidresource

A Error from server (Forbidden): User is not authorized to access this resource

B Error from server (NotFound): the server could not find the requested resource

C No resources found.

D Error: unknown command "invalidresource" for "kubectl"

💡 Hint

Consider what happens when the resource name does not exist in the API.

kubectl explain queries the API for the resource schema. If the resource does not exist, the server returns a NotFound error.

✅ Best Practice

advanced

Using kubectl explain for nested fields

Which command correctly explains the nested field spec.template.spec.containers of a Deployment resource?

A kubectl explain deployment.spec.containers

B kubectl explain deployment.template.spec.containers

C kubectl explain deployment containers

D kubectl explain deployment.spec.template.spec.containers

💡 Hint

Remember the full path to containers inside a Deployment spec.

The containers field is nested inside spec.template.spec in a Deployment. The full path must be specified to get the correct explanation.

🔀 Workflow

expert

Using kubectl explain to find required fields for a Service

You want to create a Service resource but need to know which fields are required under spec. Which command sequence helps you find this information efficiently?

A kubectl explain service --recursive | grep REQUIRED

B kubectl explain service.spec | grep required

C kubectl explain service.spec.ports

D kubectl explain service.spec --recursive | grep REQUIRED

💡 Hint

Use recursive explanation to see all nested fields and their requirements.

Using 'kubectl explain service --recursive' shows all fields including nested ones. Filtering with grep for 'REQUIRED' highlights required fields under spec.

Practice

1. What is the main purpose of the kubectl explain command in Kubernetes?

easy

A. To delete resources from the Kubernetes cluster

B. To show detailed information about Kubernetes resources and their fields

C. To deploy applications to the Kubernetes cluster

D. To monitor the status of running pods

Solution

1. Step 1: Understand the command's function

   kubectl explain is used to get detailed descriptions of Kubernetes resource types and their fields.

2. Step 2: Compare with other kubectl commands

   Deploying, deleting, or monitoring resources are done with other commands like kubectl apply, kubectl delete, and kubectl get.

3. Final Answer:

   To show detailed information about Kubernetes resources and their fields -> Option B

4. Quick Check:

   kubectl explain = Show resource details [OK]

Hint: Remember: explain means show details, not change state [OK]

Common Mistakes:

• Confusing explain with apply or delete commands
• Thinking it shows live resource status
• Assuming it deploys or removes resources

2. Which of the following is the correct syntax to get information about the spec field of a Pod using kubectl explain?

easy

A. kubectl explain pod-spec

B. kubectl explain pod/spec

C. kubectl explain pod.spec

D. kubectl explain pod spec

Solution

1. Step 1: Recall dot notation usage

   To explore nested fields, kubectl explain uses dot notation like resource.field.

2. Step 2: Check each option's syntax

   Only kubectl explain pod.spec uses the correct dot notation. Others use invalid separators or spaces.

3. Final Answer:

   kubectl explain pod.spec -> Option C

4. Quick Check:

   Dot notation = resource.field [OK]

Hint: Use dot (.) to explore nested fields in kubectl explain [OK]

Common Mistakes:

• Using dash (-) or slash (/) instead of dot (.)
• Adding spaces between resource and field
• Trying to use multiple separators together

3. What output will you get when running kubectl explain deployment.spec.replicas?

medium

A. Description of the replicas field showing it defines the number of pod replicas

B. Error: resource 'deployment.spec.replicas' not found

C. List of all deployments in the cluster

D. YAML manifest of the deployment resource

Solution

1. Step 1: Understand the command structure

   kubectl explain deployment.spec.replicas queries the nested field replicas inside spec of a Deployment resource.

2. Step 2: Know what kubectl explain returns

   It returns a description of the field, not resource lists or YAML manifests.

3. Final Answer:

   Description of the replicas field showing it defines the number of pod replicas -> Option A

4. Quick Check:

   kubectl explain nested field = field description [OK]

Hint: kubectl explain nested.field shows field description, not resource data [OK]

Common Mistakes:

• Expecting resource list or YAML output
• Assuming it shows live cluster data
• Thinking it returns an error for valid nested fields

4. You run kubectl explain pod.spec.containers but get an error saying the field does not exist. What is the most likely cause?

medium

A. You misspelled the resource or field name

B. The cluster does not have any pods running

C. kubectl explain cannot show nested fields

D. You need to add the --recursive flag to see nested fields

Solution

1. Step 1: Check command usage

   kubectl explain pod.spec.containers is valid syntax to explore nested fields.

2. Step 2: Identify common error reasons

   An error usually means a typo in resource or field name, not cluster state or missing flags.

3. Final Answer:

   You misspelled the resource or field name -> Option A

4. Quick Check:

   Typo in field/resource name = error [OK]

Hint: Check spelling carefully when kubectl explain errors occur [OK]

Common Mistakes:

• Assuming cluster state affects explain command
• Thinking --recursive is required for nested fields
• Ignoring typos in resource or field names

5. You want to write a YAML file for a Service resource and need to understand the spec.ports field. Which command will give you detailed information about this field and its subfields?

hard

A. kubectl explain service.spec.ports --verbose

B. kubectl explain service.spec.ports --all

C. kubectl explain service.spec.ports --details

D. kubectl explain service.spec.ports --recursive

Solution

1. Step 1: Identify the correct flag for nested details

   The --recursive flag shows detailed info about the field and all nested subfields.

2. Step 2: Verify other options

   Flags like --all, --details, or --verbose are not valid for kubectl explain.

3. Final Answer:

   kubectl explain service.spec.ports --recursive -> Option D

4. Quick Check:

   Use --recursive to see nested field details [OK]

Hint: Add --recursive to see all nested fields explained [OK]

Common Mistakes:

• Using invalid flags like --all or --verbose
• Not using --recursive and missing subfield info
• Confusing kubectl explain with kubectl get