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.