Organizing with recommended labels in Kubernetes - Commands & Configuration

Introduction

When you run many applications in Kubernetes, it can get hard to find and manage them. Labels help you organize and group your resources so you can easily find and control them.

When you want to group all parts of an application together for easy management.

When you need to filter and find specific resources like pods or services quickly.

When you want to apply updates or changes only to certain parts of your cluster.

When you want to track which environment (like development or production) a resource belongs to.

When you want to identify the version of an application running in your cluster.

Config File - pod.yaml

pod.yaml

apiVersion: v1
kind: Pod
metadata:
  name: example-pod
  labels:
    app.kubernetes.io/name: my-app
    app.kubernetes.io/version: "1.0"
    app.kubernetes.io/component: frontend
    app.kubernetes.io/part-of: my-application
    app.kubernetes.io/managed-by: kubectl
spec:
  containers:
  - name: nginx
    image: nginx:1.23.3
    ports:
    - containerPort: 80

This YAML file creates a Pod named example-pod with recommended labels under metadata.labels. Each label helps identify the app's name, version, component, the larger application it belongs to, and the tool managing it. These labels make it easier to organize and select resources later.

Commands

This command creates the pod with the labels defined in the YAML file. Applying the file tells Kubernetes to make this pod available in the cluster.

Terminal

kubectl apply -f pod.yaml

Expected Output

pod/example-pod created

This command lists all pods and shows their labels so you can verify the labels were applied correctly.

Terminal

kubectl get pods --show-labels

Expected Output

NAME          READY   STATUS    RESTARTS   AGE     LABELS

example-pod   1/1     Running   0          10s     app.kubernetes.io/name=my-app,app.kubernetes.io/version=1.0,app.kubernetes.io/component=frontend,app.kubernetes.io/part-of=my-application,app.kubernetes.io/managed-by=kubectl

→

--show-labels - Displays labels assigned to each pod in the list

This command filters pods to show only those with the label app.kubernetes.io/name=my-app, helping you find all pods belonging to this app.

Terminal

kubectl get pods -l app.kubernetes.io/name=my-app

Expected Output

NAME          READY   STATUS    RESTARTS   AGE

example-pod   1/1     Running   0          15s

→

-l - Filters resources by label selector

Key Concept

If you remember nothing else from this pattern, remember: labels are key-value tags that help you organize, find, and manage Kubernetes resources easily.

Common Mistakes

Using inconsistent or non-standard label keys and values.

It makes it hard to filter and group resources because labels won't match expected patterns.

Use the recommended label keys like app.kubernetes.io/name and app.kubernetes.io/version consistently.

Forgetting to apply labels in the resource YAML before creating it.

Without labels, you cannot filter or organize resources effectively later.

Always add meaningful labels under metadata.labels before applying the resource.

Using labels only on some resources but not all related ones.

This breaks grouping and makes it hard to manage the whole application as one unit.

Apply consistent labels to all related resources like pods, services, and deployments.

Summary

Create Kubernetes resources with recommended labels under metadata.labels to organize them.

Use kubectl commands with --show-labels and -l flags to view and filter resources by labels.

Consistent labeling helps manage, update, and find resources easily in your cluster.

Practice

1. What is the main purpose of using recommended labels in Kubernetes?

easy

A. To encrypt data stored in Kubernetes secrets

B. To increase the CPU and memory limits of pods

C. To automatically update Kubernetes versions

D. To organize and categorize Kubernetes objects consistently

Solution

1. Step 1: Understand what labels do in Kubernetes

   Labels are key-value pairs used to organize and select Kubernetes objects.

2. Step 2: Identify the role of recommended labels

   Recommended labels provide a standard way to name, version, and categorize resources for easier management.

3. Final Answer:

   To organize and categorize Kubernetes objects consistently -> Option D

4. Quick Check:

   Labels organize resources = A [OK]

Hint: Labels help group and find resources easily [OK]

Common Mistakes:

• Confusing labels with resource limits
• Thinking labels update Kubernetes versions
• Mixing labels with data encryption

2. Which of the following is the correct syntax to add a recommended label app.kubernetes.io/name: myapp to a pod YAML?

easy

A. metadata:
labels:
app.kubernetes.io/name: myapp

B. spec:
labels:
app.kubernetes.io/name: myapp

C. metadata:
annotations:
app.kubernetes.io/name: myapp

D. spec:
annotations:
app.kubernetes.io/name: myapp

Solution

1. Step 1: Identify where labels belong in Kubernetes YAML

   Labels are defined under metadata.labels in resource manifests.

2. Step 2: Check the options for correct placement

   metadata: labels: app.kubernetes.io/name: myapp correctly places the label under metadata.labels. Labels belong under metadata, not spec, and should use labels not annotations.

3. Final Answer:

   metadata: labels: app.kubernetes.io/name: myapp -> Option A

4. Quick Check:

   Labels go under metadata.labels = B [OK]

Hint: Labels always go under metadata.labels in YAML [OK]

Common Mistakes:

• Putting labels under spec instead of metadata
• Confusing labels with annotations
• Incorrect indentation in YAML

3. Given this pod YAML snippet, what label selector would match this pod?

metadata:
  labels:
    app.kubernetes.io/name: frontend
    app.kubernetes.io/version: v1

medium

A. app.kubernetes.io/name=backend

B. app.kubernetes.io/name=frontend

C. app.kubernetes.io/version=v2

D. app.kubernetes.io/component=frontend

Solution

1. Step 1: Read the pod's labels

   The pod has labels app.kubernetes.io/name: frontend and app.kubernetes.io/version: v1.

2. Step 2: Match the selector to the labels

   Only app.kubernetes.io/name=frontend matches the label key and value exactly. The other options use mismatched keys or values.

3. Final Answer:

   app.kubernetes.io/name=frontend -> Option B

4. Quick Check:

   Selector matches label key and value = C [OK]

Hint: Selector must exactly match label key and value [OK]

Common Mistakes:

• Using wrong label values
• Confusing label keys
• Using non-existent labels in selector

4. You applied this YAML but your pod is not selected by the service selector:

metadata:
  labels:
    app.kubernetes.io/name: frontend
spec:
  containers:
  - name: app
    image: nginx

What is the likely problem?

medium

A. The service selector does not match the pod labels

B. Labels are under spec instead of metadata

C. The container image is incorrect

D. The label key is missing the recommended prefix

Solution

1. Step 1: Check the pod labels

   The pod has label app.kubernetes.io/name: frontend under metadata.labels, which is correct.

2. Step 2: Understand why the service selector might fail

   If the service selector does not exactly match the pod's labels, the pod won't be selected. The problem is likely a mismatch in the service selector, not the pod labels or container image.

3. Final Answer:

   The service selector does not match the pod labels -> Option A

4. Quick Check:

   Selector must match pod labels = D [OK]

Hint: Service selector must exactly match pod labels [OK]

Common Mistakes:

• Assuming label keys are incorrect when they are correct
• Thinking labels belong under spec
• Blaming container image for selector issues

5. You want to organize your Kubernetes resources using recommended labels for app name, version, and component. Which set of labels should you apply to a backend service named api version v2?

hard

A. app: api
ver: v2
comp: backend

B. name: api
version: v2
component: backend

C. app.kubernetes.io/name: api
app.kubernetes.io/version: v2
app.kubernetes.io/component: backend

D. app.kubernetes.io/name: api
app.kubernetes.io/version: v1
app.kubernetes.io/component: backend

Solution

1. Step 1: Identify the recommended label keys

   Recommended labels use the prefix app.kubernetes.io/ followed by keys like name, version, and component.

2. Step 2: Match the correct values for the backend service

   The service is named api, version v2, and component backend. app.kubernetes.io/name: api app.kubernetes.io/version: v2 app.kubernetes.io/component: backend correctly uses recommended keys and values. Other options either lack the app.kubernetes.io/ prefix or use the wrong version (v1).

3. Final Answer:

   app.kubernetes.io/name: api app.kubernetes.io/version: v2 app.kubernetes.io/component: backend -> Option C

4. Quick Check:

   Use recommended keys with correct values = A [OK]

Hint: Use full recommended label keys with correct values [OK]

Common Mistakes:

• Using short or incorrect label keys
• Applying wrong version value
• Omitting the recommended prefix