Annotations vs labels in Kubernetes - CLI Comparison

Introduction

Kubernetes uses labels and annotations to add extra information to objects. Labels help group and select objects, while annotations store non-identifying metadata.

When you want to organize pods by environment like development or production using labels.

When you need to add a description or contact info to a pod without affecting its selection.

When you want to filter services or deployments based on labels for updates or scaling.

When you want to store build or version details on a pod without changing its behavior.

When you want to track deployment history or debugging info using annotations.

Config File - pod.yaml

pod.yaml

apiVersion: v1
kind: Pod
metadata:
  name: example-pod
  labels:
    environment: production
    app: my-app
  annotations:
    description: "This pod runs the main application."
    contact: "[e-mail]"
spec:
  containers:
  - name: my-container
    image: nginx:1.23.3

metadata.labels are key-value pairs used to identify and select this pod for grouping or filtering.

metadata.annotations store extra information that does not affect pod selection or behavior.

Commands

This command creates the pod with the specified labels and annotations so Kubernetes can manage it accordingly.

Terminal

kubectl apply -f pod.yaml

Expected Output

pod/example-pod created

This command lists pods and shows their labels, helping you see how pods are grouped.

Terminal

kubectl get pods --show-labels

Expected Output

NAME          READY   STATUS    RESTARTS   AGE     LABELS

example-pod   1/1     Running   0          10s     environment=production,app=my-app

→

--show-labels - Displays labels of each pod in the list

This command shows detailed information about the pod, including annotations which are not shown in the basic list.

Terminal

kubectl describe pod example-pod

Expected Output

Name:         example-pod

Namespace:    default

Labels:       environment=production

              app=my-app

Annotations:  description=This pod runs the main application.

              contact=[e-mail]

Status:       Running

Containers:

  my-container:

    Image:  nginx:1.23.3

    State:  Running

    Ready:  True

Key Concept

Labels are for identifying and selecting objects, while annotations store extra information that does not affect selection or behavior.

Common Mistakes

Using annotations when you need to select or filter objects.

Annotations are not indexed and cannot be used to select or group objects, so filtering will fail.

Use labels for any information you want to filter or select objects by.

Putting large or sensitive data in labels.

Labels have size limits and are visible in selectors, so large or sensitive data can cause errors or leaks.

Store large or sensitive metadata in annotations instead.

Summary

Labels help group and select Kubernetes objects like pods.

Annotations store extra metadata that does not affect object selection.

Use kubectl commands to apply, view labels, and describe annotations on pods.

Practice

1. What is the primary purpose of labels in Kubernetes?

easy

A. To group and select objects for operations like deployments and services

B. To store large binary data inside objects

C. To provide detailed descriptions for human readers only

D. To encrypt sensitive information within the cluster

Solution

1. Step 1: Understand labels' role

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

2. Step 2: Differentiate from annotations

   Annotations store metadata but are not used for selecting or grouping objects.

3. Final Answer:

   To group and select objects for operations like deployments and services -> Option A

4. Quick Check:

   Labels = grouping and selection [OK]

Hint: Labels are for grouping; annotations are for extra info [OK]

Common Mistakes:

• Confusing annotations as selectors
• Thinking labels store large data
• Assuming labels encrypt data

2. Which of the following is the correct syntax to add a label named env=production to a pod YAML?

easy

A. metadata:
annotations:
env: production

B. spec:
labels:
env: production

C. metadata:
labels:
- env=production

D. metadata:
labels:
env: production

Solution

1. Step 1: Locate correct YAML section

   Labels belong under metadata.labels in Kubernetes YAML.

2. Step 2: Check syntax format

   Labels are key-value pairs, not lists or under spec.

3. Final Answer:

   metadata: labels: env: production -> Option D

4. Quick Check:

   Labels under metadata.labels with key: value [OK]

Hint: Labels go under metadata.labels as key-value pairs [OK]

Common Mistakes:

• Putting labels under spec section
• Using annotations instead of labels
• Writing labels as a list instead of map

3. Given this pod YAML snippet, what will kubectl get pods -l app=web return?

metadata:
  labels:
    app: web
  annotations:
    description: "Frontend web server"

medium

A. The command will fail due to syntax error

B. The pod will not be listed because annotations are ignored

C. The pod will be listed because it has label app=web

D. The pod will be listed only if annotation description exists

Solution

1. Step 1: Understand label selector behavior

   The command kubectl get pods -l app=web lists pods with label app=web.

2. Step 2: Check pod labels and annotations

   The pod has label app: web, so it matches the selector. Annotations do not affect selection.

3. Final Answer:

   The pod will be listed because it has label app=web -> Option C

4. Quick Check:

   Label selector matches label, annotations ignored [OK]

Hint: Label selectors ignore annotations, only match labels [OK]

Common Mistakes:

• Thinking annotations affect label selectors
• Assuming command fails due to annotations
• Confusing labels and annotations roles

4. You want to add extra metadata to a deployment without affecting its selection. Which is the correct fix if you mistakenly added this under metadata.labels instead of metadata.annotations?

metadata:
  labels:
    description: "Handles user login"

medium

A. Move the key-value pair under metadata.annotations instead of labels

B. Keep it under labels but rename key to 'desc'

C. Remove the key-value pair entirely

D. Add the key-value pair under spec.containers

Solution

1. Step 1: Identify misuse of labels

   Labels affect selection and grouping; adding descriptive info there can cause unintended behavior.

2. Step 2: Correct placement for metadata

   Annotations are meant for extra metadata that does not affect selection, so move the key-value pair there.

3. Final Answer:

   Move the key-value pair under metadata.annotations instead of labels -> Option A

4. Quick Check:

   Metadata info belongs in annotations, not labels [OK]

Hint: Put extra info in annotations, not labels [OK]

Common Mistakes:

• Using labels for descriptive metadata
• Renaming keys instead of moving
• Removing useful metadata

5. You have a service that selects pods with label tier=backend. You want to add a note about the pod's version without affecting service selection. Which YAML snippet correctly applies this?

hard

A. metadata:
labels:
tier: backend
version: "v2.1"

B. metadata:
labels:
tier: backend
annotations:
version: "v2.1"

C. metadata:
annotations:
tier: backend
version: "v2.1"

D. spec:
labels:
tier: backend
annotations:
version: "v2.1"

Solution

1. Step 1: Identify label for selection

   The service selects pods with label tier=backend, so this label must be present under metadata.labels.

2. Step 2: Add version note without affecting selection

   Version info is metadata and should go under metadata.annotations to avoid changing label selectors.

3. Final Answer:

   metadata: labels: tier: backend annotations: version: "v2.1" -> Option B

4. Quick Check:

   Labels for selection, annotations for extra info [OK]

Hint: Keep selectors in labels; notes in annotations [OK]

Common Mistakes:

• Putting version as label and changing selectors
• Putting tier in annotations losing selection
• Placing labels or annotations under spec