Immutable ConfigMaps in Kubernetes - Mini Project: Build & Apply

Immutable ConfigMaps

📖 Scenario: You are managing configuration for a web application running on Kubernetes. To prevent accidental changes to configuration data, you want to create an immutable ConfigMap. This means once created, the ConfigMap cannot be changed, ensuring stability and safety.

🎯 Goal: Create an immutable ConfigMap in Kubernetes with specific data, add a label to it, and verify its immutability by printing the ConfigMap details.

📋 What You'll Learn

Create a ConfigMap named app-config with data keys APP_MODE set to production and LOG_LEVEL set to info

Add a label environment: production to the ConfigMap

Set the ConfigMap to be immutable

Print the ConfigMap YAML to verify the configuration

💡 Why This Matters

🌍 Real World

Immutable ConfigMaps are used in production Kubernetes environments to ensure configuration data does not change unexpectedly, which helps maintain application stability.

💼 Career

Understanding how to create and manage immutable ConfigMaps is important for DevOps engineers and Kubernetes administrators to enforce configuration safety and best practices.

1

Create the initial ConfigMap data

Create a ConfigMap YAML named app-config.yaml with apiVersion set to v1, kind set to ConfigMap, and metadata.name set to app-config. Add data with keys APP_MODE set to production and LOG_LEVEL set to info.

Kubernetes

# Create a ConfigMap YAML with name 'app-config' and data keys 'APP_MODE' and 'LOG_LEVEL'
# Your code here

Hint

Use YAML syntax to define the ConfigMap with the required fields and data keys.

2

Add a label to the ConfigMap

Add a labels section under metadata with the label environment: production in the app-config.yaml file.

Kubernetes

apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
  # Add labels here
  # Your code here
data:
  APP_MODE: production
  LOG_LEVEL: info

Hint

Indent the labels section properly under metadata.

3

Make the ConfigMap immutable

Add the field immutable: true under the root level of the ConfigMap YAML in app-config.yaml to make the ConfigMap immutable.

Kubernetes

apiVersion: v1
kind: ConfigMap
metadata:
  name: app-config
  labels:
    environment: production
# Add immutable field below
# Your code here
data:
  APP_MODE: production
  LOG_LEVEL: info

Hint

The immutable field is a sibling to metadata and data.

4

Print the ConfigMap YAML

Run the command kubectl apply -f app-config.yaml to create the ConfigMap, then run kubectl get configmap app-config -o yaml to print the ConfigMap YAML and verify it is immutable.

Kubernetes

# Run kubectl commands to apply and print the ConfigMap
# Your code here

Hint

Use kubectl apply -f app-config.yaml to create the ConfigMap and kubectl get configmap app-config -o yaml to see its details.

Practice

1. What is the main purpose of setting immutable: true in a Kubernetes ConfigMap?

easy

A. To delete the ConfigMap automatically after use

B. To allow automatic updates to the ConfigMap

C. To encrypt the ConfigMap data

D. To prevent any changes to the ConfigMap after creation

Solution

1. Step 1: Understand the role of immutable: true

   This setting makes the ConfigMap read-only after creation, preventing accidental or unauthorized changes.

2. Step 2: Compare with other options

   Options A, B, and D describe behaviors unrelated to immutability: automatic deletion, updates, or encryption are not controlled by this flag.

3. Final Answer:

   To prevent any changes to the ConfigMap after creation -> Option D

4. Quick Check:

   Immutable ConfigMap = No changes allowed [OK]

Hint: Immutable means no changes allowed after creation [OK]

Common Mistakes:

• Thinking immutable allows updates
• Confusing immutability with encryption
• Assuming immutable deletes the ConfigMap

2. Which of the following is the correct syntax to create an immutable ConfigMap in Kubernetes YAML?

easy

A. apiVersion: v1
kind: ConfigMap
metadata:
name: my-config
spec:
immutable: true
data:
key: value

B. apiVersion: v1
kind: ConfigMap
metadata:
name: my-config
immutable: true
data:
key: value

C. immutable: true
metadata:
name: my-config
data:
key: value

D. spec:
immutable: true
data:
key: value

Solution

1. Step 1: Identify correct placement of immutable: true

   In Kubernetes, immutable is a top-level field for ConfigMaps, at the same level as metadata and data.

2. Step 2: Validate YAML structure

   apiVersion: v1 kind: ConfigMap metadata: name: my-config immutable: true data: key: value correctly places immutable: true at top-level with proper indentation and includes required fields like apiVersion, kind, and metadata.

3. Final Answer:

   apiVersion: v1 kind: ConfigMap metadata: name: my-config immutable: true data: key: value -> Option B

4. Quick Check:

   Immutable at top-level with metadata and data [OK]

Hint: Immutable: true at top-level after metadata [OK]

Common Mistakes:

• Adding unnecessary spec section
• Putting immutable under metadata
• Missing apiVersion or kind fields

3. Given this YAML snippet for a ConfigMap with immutable: true:

apiVersion: v1
kind: ConfigMap
metadata:
  name: example-config
immutable: true
data:
  setting: old_value

What happens if you try to update setting to new_value using kubectl apply?

medium

A. The update fails with an error about immutable field

B. The update succeeds and the ConfigMap changes to new_value

C. The ConfigMap is deleted and recreated with new_value

D. The update is ignored silently, keeping old_value

Solution

1. Step 1: Understand immutable ConfigMap behavior on update

   When immutable: true is set, Kubernetes rejects any update to the ConfigMap data.

2. Step 2: Predict kubectl apply result

   Trying to change setting triggers an error indicating the ConfigMap is immutable and cannot be modified.

3. Final Answer:

   The update fails with an error about immutable field -> Option A

4. Quick Check:

   Immutable ConfigMap update = error [OK]

Hint: Immutable ConfigMaps reject updates with error [OK]

Common Mistakes:

• Expecting updates to succeed
• Thinking ConfigMap auto-recreates on update
• Assuming silent ignore of changes

4. You tried to update an immutable ConfigMap but got an error. What is the best way to apply new configuration changes?

medium

A. Edit the existing ConfigMap directly with kubectl edit

B. Delete the existing ConfigMap and create a new one with updated data

C. Create a new ConfigMap with a different name and update workloads to use it

D. Remove the immutable flag and then update the ConfigMap

Solution

1. Step 1: Understand immutable ConfigMap update restrictions

   Immutable ConfigMaps cannot be changed. Editing or removing the flag is not allowed on existing objects.

2. Step 2: Choose best practice for updates

   Creating a new ConfigMap with a new name and updating workloads to reference it ensures stability and traceability.

3. Final Answer:

   Create a new ConfigMap with a different name and update workloads to use it -> Option C

4. Quick Check:

   Immutable update = new ConfigMap + workload update [OK]

Hint: Create new ConfigMap and update pods to use it [OK]

Common Mistakes:

• Trying to edit immutable ConfigMap directly
• Deleting ConfigMap without updating workloads
• Removing immutable flag on existing ConfigMap

5. You have a deployment using an immutable ConfigMap named app-config-v1. You need to update configuration safely without downtime. What is the best approach?

hard

A. Create app-config-v2 ConfigMap with new data, update deployment to use it, then rollout pods gradually

B. Update app-config-v1 directly and restart pods immediately

C. Delete app-config-v1 and create a new ConfigMap with the same name and updated data

D. Patch the deployment to ignore ConfigMap changes and keep using old config

Solution

1. Step 1: Recognize immutable ConfigMap update constraints

   Direct updates to app-config-v1 are not possible due to immutability, so options B and C are invalid.

2. Step 2: Apply best practice for zero downtime updates

   Create a new ConfigMap app-config-v2 with updated data, update the deployment to use it, and rollout pods gradually to avoid downtime.

3. Final Answer:

   Create app-config-v2 ConfigMap, update deployment, rollout gradually -> Option A

4. Quick Check:

   Immutable update = new ConfigMap + gradual rollout [OK]

Hint: Use new ConfigMap and gradual rollout for zero downtime [OK]

Common Mistakes:

• Trying to update immutable ConfigMap directly
• Deleting ConfigMap without updating deployment
• Ignoring config changes in deployment