kubectl explain for API reference in Kubernetes - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the command to get API details for pods.

Kubernetes

kubectl explain [1]

Drag options to blanks, or click blank then click option'

Apods

Bservices

Cnodes

Ddeployments

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'services' instead of 'pods' will show service API details.

The command kubectl explain pods shows the API reference for pods.

2fill in blank

medium

Complete the command to get detailed info about pod spec.

Kubernetes

kubectl explain pods.[1]

Drag options to blanks, or click blank then click option'

Acontainers

Bstatus

Cmetadata

Dspec

Attempts:

3 left

💡 Hint

Common Mistakes

Choosing 'status' shows current state, not the spec details.

kubectl explain pods.spec shows the specification details of a pod.

3fill in blank

hard

Fix the command to explain the container field inside pod spec.

Kubernetes

kubectl explain pods.spec.[1]

Drag options to blanks, or click blank then click option'

AcontainerList

Bcontainers

Ccontainer

DcontainerSpec

Attempts:

3 left

💡 Hint

Common Mistakes

Using singular 'container' causes an error because the field is plural.

The correct field is containers (plural) inside pod spec.

4fill in blank

hard

Fill both blanks to explain the image field inside containers.

Kubernetes

kubectl explain pods.spec.[1].[2]

Drag options to blanks, or click blank then click option'

Acontainers

Bimage

Ccontainer

Dimages

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'container' or 'images' will cause errors because they are incorrect field names.

The correct path is pods.spec.containers.image to explain the image field.

5fill in blank

hard

Fill all three blanks to explain the resource limits inside container resources.

Kubernetes

kubectl explain pods.spec.containers.[1].[2].[3]

Drag options to blanks, or click blank then click option'

Aresources

Blimits

Crequests

Dmemory

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'requests' instead of 'limits' will show requested resources, not limits.

The full path is pods.spec.containers.resources.limits.memory to explain memory limits.

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