Immutable ConfigMaps in Kubernetes - Commands & Configuration

Introduction

ConfigMaps store configuration data for applications in Kubernetes. Making ConfigMaps immutable prevents accidental changes, ensuring stable and predictable app behavior.

When you want to prevent accidental updates to configuration data that could disrupt running applications.

When multiple pods share the same configuration and you want to ensure consistency without changes.

When you want to improve security by disallowing modifications to sensitive configuration after deployment.

When you want to avoid frequent reloads or restarts caused by ConfigMap changes.

When you want to track configuration changes by creating new ConfigMaps instead of editing existing ones.

Config File - immutable-configmap.yaml

immutable-configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: example-config
immutable: true
data:
  app.properties: |
    log_level=info
    max_connections=100

This file creates a ConfigMap named example-config with two configuration settings.

The key immutable: true makes this ConfigMap unchangeable after creation.

The data section holds the configuration values used by applications.

Commands

This command creates the immutable ConfigMap in the Kubernetes cluster using the configuration file.

Terminal

kubectl apply -f immutable-configmap.yaml

Expected Output

configmap/example-config created

This command retrieves the full YAML definition of the ConfigMap to verify it was created and is immutable.

Terminal

kubectl get configmap example-config -o yaml

Expected Output

apiVersion: v1

data:

  app.properties: |-

    log_level=info

    max_connections=100

immutable: true

kind: ConfigMap

metadata:

  creationTimestamp: "2024-06-01T12:00:00Z"

  name: example-config

  namespace: default

  resourceVersion: "12345"

  uid: 123e4567-e89b-12d3-a456-426614174000

→

-o yaml - Outputs the ConfigMap in YAML format for detailed inspection

This command attempts to edit the immutable ConfigMap, which should fail to prevent changes.

Terminal

kubectl edit configmap example-config

Expected Output

error: ConfigMap "example-config" is immutable and cannot be updated

Key Concept

If you remember nothing else from this pattern, remember: setting immutable: true on a ConfigMap locks its data to prevent accidental or unauthorized changes.

Common Mistakes

Trying to edit an immutable ConfigMap directly with kubectl edit.

The edit command fails because the ConfigMap is locked and cannot be changed after creation.

Create a new ConfigMap with a different name and update your pods to use the new ConfigMap.

Not setting immutable: true and accidentally changing ConfigMap data causing app instability.

Without immutability, ConfigMaps can be changed anytime, which may cause unexpected app behavior or reloads.

Set immutable: true to lock the ConfigMap and enforce controlled updates.

Summary

Create a ConfigMap with the immutable: true field to lock its data.

Verify the ConfigMap is immutable by retrieving it with kubectl get.

Attempting to edit an immutable ConfigMap will fail, enforcing stability.

To update configuration, create a new ConfigMap and update pods accordingly.

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