Configure a Pod to Use a ConfigMap

Many applications rely on configuration which is used during either application initialization or runtime. Most of the times there is a requirement to adjust values assigned to configuration parameters. ConfigMaps are the Kubernetes way to inject application pods with configuration data. ConfigMaps allow you to decouple configuration artifacts from image content to keep containerized applications portable. This page provides a series of usage examples demonstrating how to create ConfigMaps and configure Pods using data stored in ConfigMaps.

Before you begin

You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. It is recommended to run this tutorial on a cluster with at least two nodes that are not acting as control plane hosts. If you do not already have a cluster, you can create one by using minikube or you can use one of these Kubernetes playgrounds:

To check the version, enter kubectl version.

Create a ConfigMap

You can use either kubectl create configmap or a ConfigMap generator in kustomization.yaml to create a ConfigMap. Note that kubectl starts to support kustomization.yaml since 1.14.

Create a ConfigMap Using kubectl create configmap

Use the kubectl create configmap command to create ConfigMaps from directories, files, or literal values:

  1. kubectl create configmap <map-name> <data-source>

where <map-name> is the name you want to assign to the ConfigMap and <data-source> is the directory, file, or literal value to draw the data from. The name of a ConfigMap object must be a valid DNS subdomain name.

When you are creating a ConfigMap based on a file, the key in the <data-source> defaults to the basename of the file, and the value defaults to the file content.

You can use kubectl describe or kubectl get to retrieve information about a ConfigMap.

Create ConfigMaps from directories

You can use kubectl create configmap to create a ConfigMap from multiple files in the same directory. When you are creating a ConfigMap based on a directory, kubectl identifies files whose basename is a valid key in the directory and packages each of those files into the new ConfigMap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

For example:

  1. # Create the local directory
  2. mkdir -p configure-pod-container/configmap/
  4. # Download the sample files into `configure-pod-container/configmap/` directory
  5. wget https://kubernetes.io/examples/configmap/game.properties -O configure-pod-container/configmap/game.properties
  6. wget https://kubernetes.io/examples/configmap/ui.properties -O configure-pod-container/configmap/ui.properties
  8. # Create the configmap
  9. kubectl create configmap game-config --from-file=configure-pod-container/configmap/

The above command packages each file, in this case, game.properties and ui.properties in the configure-pod-container/configmap/ directory into the game-config ConfigMap. You can display details of the ConfigMap using the following command:

  1. kubectl describe configmaps game-config

The output is similar to this:

  1. Name:         game-config
  2. Namespace:    default
  3. Labels:       <none>
  4. Annotations:  <none>
  6. Data
  7. ====
  8. game.properties:
  9. ----
  10. enemies=aliens
  11. lives=3
  12. enemies.cheat=true
  13. enemies.cheat.level=noGoodRotten
  14. secret.code.passphrase=UUDDLRLRBABAS
  15. secret.code.allowed=true
  16. secret.code.lives=30
  17. ui.properties:
  18. ----
  19. color.good=purple
  20. color.bad=yellow
  21. allow.textmode=true
  22. how.nice.to.look=fairlyNice

The game.properties and ui.properties files in the configure-pod-container/configmap/ directory are represented in the data section of the ConfigMap.

  1. kubectl get configmaps game-config -o yaml

The output is similar to this:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   creationTimestamp: 2016-02-18T18:52:05Z
  5.   name: game-config
  6.   namespace: default
  7.   resourceVersion: "516"
  8.   uid: b4952dc3-d670-11e5-8cd0-68f728db1985
  9. data:
  10.   game.properties: |
  11.     enemies=aliens
  12.     lives=3
  13.     enemies.cheat=true
  14.     enemies.cheat.level=noGoodRotten
  15.     secret.code.passphrase=UUDDLRLRBABAS
  16.     secret.code.allowed=true
  17.     secret.code.lives=30    
  18.   ui.properties: |
  19.     color.good=purple
  20.     color.bad=yellow
  21.     allow.textmode=true
  22.     how.nice.to.look=fairlyNice

Create ConfigMaps from files

You can use kubectl create configmap to create a ConfigMap from an individual file, or from multiple files.

For example,

  1. kubectl create configmap game-config-2 --from-file=configure-pod-container/configmap/game.properties

would produce the following ConfigMap:

  1. kubectl describe configmaps game-config-2

where the output is similar to this:

  1. Name:         game-config-2
  2. Namespace:    default
  3. Labels:       <none>
  4. Annotations:  <none>
  6. Data
  7. ====
  8. game.properties:
  9. ----
  10. enemies=aliens
  11. lives=3
  12. enemies.cheat=true
  13. enemies.cheat.level=noGoodRotten
  14. secret.code.passphrase=UUDDLRLRBABAS
  15. secret.code.allowed=true
  16. secret.code.lives=30

You can pass in the --from-file argument multiple times to create a ConfigMap from multiple data sources.

  1. kubectl create configmap game-config-2 --from-file=configure-pod-container/configmap/game.properties --from-file=configure-pod-container/configmap/ui.properties

You can display details of the game-config-2 ConfigMap using the following command:

  1. kubectl describe configmaps game-config-2

The output is similar to this:

  1. Name:         game-config-2
  2. Namespace:    default
  3. Labels:       <none>
  4. Annotations:  <none>
  6. Data
  7. ====
  8. game.properties:
  9. ----
  10. enemies=aliens
  11. lives=3
  12. enemies.cheat=true
  13. enemies.cheat.level=noGoodRotten
  14. secret.code.passphrase=UUDDLRLRBABAS
  15. secret.code.allowed=true
  16. secret.code.lives=30
  17. ui.properties:
  18. ----
  19. color.good=purple
  20. color.bad=yellow
  21. allow.textmode=true
  22. how.nice.to.look=fairlyNice

When kubectl creates a ConfigMap from inputs that are not ASCII or UTF-8, the tool puts these into the binaryData field of the ConfigMap, and not in data. Both text and binary data sources can be combined in one ConfigMap. If you want to view the binaryData keys (and their values) in a ConfigMap, you can run kubectl get configmap -o jsonpath='{.binaryData}' <name>.

Use the option --from-env-file to create a ConfigMap from an env-file, for example:

  1. # Env-files contain a list of environment variables.
  2. # These syntax rules apply:
  3. #   Each line in an env file has to be in VAR=VAL format.
  4. #   Lines beginning with # (i.e. comments) are ignored.
  5. #   Blank lines are ignored.
  6. #   There is no special handling of quotation marks (i.e. they will be part of the ConfigMap value)).
  8. # Download the sample files into `configure-pod-container/configmap/` directory
  9. wget https://kubernetes.io/examples/configmap/game-env-file.properties -O configure-pod-container/configmap/game-env-file.properties
  10. wget https://kubernetes.io/examples/configmap/ui-env-file.properties -O configure-pod-container/configmap/ui-env-file.properties
  12. # The env-file `game-env-file.properties` looks like below
  13. cat configure-pod-container/configmap/game-env-file.properties
  14. enemies=aliens
  15. lives=3
  16. allowed="true"
  18. # This comment and the empty line above it are ignored
  1. kubectl create configmap game-config-env-file \
  2.        --from-env-file=configure-pod-container/configmap/game-env-file.properties

would produce the following ConfigMap:

  1. kubectl get configmap game-config-env-file -o yaml

where the output is similar to this:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   creationTimestamp: 2017-12-27T18:36:28Z
  5.   name: game-config-env-file
  6.   namespace: default
  7.   resourceVersion: "809965"
  8.   uid: d9d1ca5b-eb34-11e7-887b-42010a8002b8
  9. data:
  10.   allowed: '"true"'
  11.   enemies: aliens
  12.   lives: "3"

Starting with Kubernetes v1.23, kubectl supports the --from-env-file argument to be specified multiple times to create a ConfigMap from multiple data sources.

  1. kubectl create configmap config-multi-env-files \
  2.         --from-env-file=configure-pod-container/configmap/game-env-file.properties \
  3.         --from-env-file=configure-pod-container/configmap/ui-env-file.properties

would produce the following ConfigMap:

  1. kubectl get configmap config-multi-env-files -o yaml

where the output is similar to this:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   creationTimestamp: 2017-12-27T18:38:34Z
  5.   name: config-multi-env-files
  6.   namespace: default
  7.   resourceVersion: "810136"
  8.   uid: 252c4572-eb35-11e7-887b-42010a8002b8
  9. data:
  10.   allowed: '"true"'
  11.   color: purple
  12.   enemies: aliens
  13.   how: fairlyNice
  14.   lives: "3"
  15.   textmode: "true"

Define the key to use when creating a ConfigMap from a file

You can define a key other than the file name to use in the data section of your ConfigMap when using the --from-file argument:

  1. kubectl create configmap game-config-3 --from-file=<my-key-name>=<path-to-file>

where <my-key-name> is the key you want to use in the ConfigMap and <path-to-file> is the location of the data source file you want the key to represent.

For example:

  1. kubectl create configmap game-config-3 --from-file=game-special-key=configure-pod-container/configmap/game.properties

would produce the following ConfigMap:

  1. kubectl get configmaps game-config-3 -o yaml

where the output is similar to this:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   creationTimestamp: 2016-02-18T18:54:22Z
  5.   name: game-config-3
  6.   namespace: default
  7.   resourceVersion: "530"
  8.   uid: 05f8da22-d671-11e5-8cd0-68f728db1985
  9. data:
  10.   game-special-key: |
  11.     enemies=aliens
  12.     lives=3
  13.     enemies.cheat=true
  14.     enemies.cheat.level=noGoodRotten
  15.     secret.code.passphrase=UUDDLRLRBABAS
  16.     secret.code.allowed=true
  17.     secret.code.lives=30

Create ConfigMaps from literal values

You can use kubectl create configmap with the --from-literal argument to define a literal value from the command line:

  1. kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm

You can pass in multiple key-value pairs. Each pair provided on the command line is represented as a separate entry in the data section of the ConfigMap.

  1. kubectl get configmaps special-config -o yaml

The output is similar to this:

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   creationTimestamp: 2016-02-18T19:14:38Z
  5.   name: special-config
  6.   namespace: default
  7.   resourceVersion: "651"
  8.   uid: dadce046-d673-11e5-8cd0-68f728db1985
  9. data:
  10.   special.how: very
  11.   special.type: charm

Create a ConfigMap from generator

kubectl supports kustomization.yaml since 1.14. You can also create a ConfigMap from generators and then apply it to create the object on the Apiserver. The generators should be specified in a kustomization.yaml inside a directory.

Generate ConfigMaps from files

For example, to generate a ConfigMap from files configure-pod-container/configmap/game.properties

  1. # Create a kustomization.yaml file with ConfigMapGenerator
  2. cat <<EOF >./kustomization.yaml
  3. configMapGenerator:
  4. - name: game-config-4
  5.   files:
  6.   - configure-pod-container/configmap/game.properties
  7. EOF

Apply the kustomization directory to create the ConfigMap object.

  1. kubectl apply -k .
  2. configmap/game-config-4-m9dm2f92bt created

You can check that the ConfigMap was created like this:

  1. kubectl get configmap
  2. NAME                       DATA   AGE
  3. game-config-4-m9dm2f92bt   1      37s
  6. kubectl describe configmaps/game-config-4-m9dm2f92bt
  7. Name:         game-config-4-m9dm2f92bt
  8. Namespace:    default
  9. Labels:       <none>
  10. Annotations:  kubectl.kubernetes.io/last-applied-configuration:
  11.                 {"apiVersion":"v1","data":{"game.properties":"enemies=aliens\nlives=3\nenemies.cheat=true\nenemies.cheat.level=noGoodRotten\nsecret.code.p...
  13. Data
  14. ====
  15. game.properties:
  16. ----
  17. enemies=aliens
  18. lives=3
  19. enemies.cheat=true
  20. enemies.cheat.level=noGoodRotten
  21. secret.code.passphrase=UUDDLRLRBABAS
  22. secret.code.allowed=true
  23. secret.code.lives=30
  24. Events:  <none>

Note that the generated ConfigMap name has a suffix appended by hashing the contents. This ensures that a new ConfigMap is generated each time the content is modified.

Define the key to use when generating a ConfigMap from a file

You can define a key other than the file name to use in the ConfigMap generator. For example, to generate a ConfigMap from files configure-pod-container/configmap/game.properties with the key game-special-key

  1. # Create a kustomization.yaml file with ConfigMapGenerator
  2. cat <<EOF >./kustomization.yaml
  3. configMapGenerator:
  4. - name: game-config-5
  5.   files:
  6.   - game-special-key=configure-pod-container/configmap/game.properties
  7. EOF

Apply the kustomization directory to create the ConfigMap object.

  1. kubectl apply -k .
  2. configmap/game-config-5-m67dt67794 created

Generate ConfigMaps from Literals

To generate a ConfigMap from literals special.type=charm and special.how=very, you can specify the ConfigMap generator in kustomization.yaml as

  1. # Create a kustomization.yaml file with ConfigMapGenerator
  2. cat <<EOF >./kustomization.yaml
  3. configMapGenerator:
  4. - name: special-config-2
  5.   literals:
  6.   - special.how=very
  7.   - special.type=charm
  8. EOF

Apply the kustomization directory to create the ConfigMap object.

  1. kubectl apply -k .
  2. configmap/special-config-2-c92b5mmcf2 created

Define container environment variables using ConfigMap data

Define a container environment variable with data from a single ConfigMap

  1. Define an environment variable as a key-value pair in a ConfigMap:

    1. kubectl create configmap special-config --from-literal=special.how=very

  2. Assign the special.how value defined in the ConfigMap to the SPECIAL_LEVEL_KEY environment variable in the Pod specification.

    pods/pod-single-configmap-env-variable.yaml Configure a Pod to Use a ConfigMap - 图1

    1. apiVersion: v1
    2.    kind: Pod
    3.    metadata:
    4.      name: dapi-test-pod
    5.    spec:
    6.      containers:
    7.        - name: test-container
    8.          image: registry.k8s.io/busybox
    9.          command: [ "/bin/sh", "-c", "env" ]
    10.          env:
    11.            # Define the environment variable
    12.            - name: SPECIAL_LEVEL_KEY
    13.              valueFrom:
    14.                configMapKeyRef:
    15.                  # The ConfigMap containing the value you want to assign to SPECIAL_LEVEL_KEY
    16.                  name: special-config
    17.                  # Specify the key associated with the value
    18.                  key: special.how
    19.      restartPolicy: Never

    Create the Pod:

    1. kubectl create -f https://kubernetes.io/examples/pods/pod-single-configmap-env-variable.yaml

    Now, the Pod’s output includes environment variable SPECIAL_LEVEL_KEY=very.

Define container environment variables with data from multiple ConfigMaps

  • As with the previous example, create the ConfigMaps first.

    configmap/configmaps.yaml Configure a Pod to Use a ConfigMap - 图2

    1. apiVersion: v1
    2.   kind: ConfigMap
    3.   metadata:
    4.     name: special-config
    5.     namespace: default
    6.   data:
    7.     special.how: very
    8.   ---
    9.   apiVersion: v1
    10.   kind: ConfigMap
    11.   metadata:
    12.     name: env-config
    13.     namespace: default
    14.   data:
    15.     log_level: INFO

    Create the ConfigMap:

    1. kubectl create -f https://kubernetes.io/examples/configmap/configmaps.yaml

  • Define the environment variables in the Pod specification.

    pods/pod-multiple-configmap-env-variable.yaml Configure a Pod to Use a ConfigMap - 图3

    1. apiVersion: v1
    2.   kind: Pod
    3.   metadata:
    4.     name: dapi-test-pod
    5.   spec:
    6.     containers:
    7.       - name: test-container
    8.         image: registry.k8s.io/busybox
    9.         command: [ "/bin/sh", "-c", "env" ]
    10.         env:
    11.           - name: SPECIAL_LEVEL_KEY
    12.             valueFrom:
    13.               configMapKeyRef:
    14.                 name: special-config
    15.                 key: special.how
    16.           - name: LOG_LEVEL
    17.             valueFrom:
    18.               configMapKeyRef:
    19.                 name: env-config
    20.                 key: log_level
    21.     restartPolicy: Never

    Create the Pod:

    1. kubectl create -f https://kubernetes.io/examples/pods/pod-multiple-configmap-env-variable.yaml

    Now, the Pod’s output includes environment variables SPECIAL_LEVEL_KEY=very and LOG_LEVEL=INFO.

Configure all key-value pairs in a ConfigMap as container environment variables

Note: This functionality is available in Kubernetes v1.6 and later.

  • Create a ConfigMap containing multiple key-value pairs.

    configmap/configmap-multikeys.yaml Configure a Pod to Use a ConfigMap - 图4

    1. apiVersion: v1
    2.   kind: ConfigMap
    3.   metadata:
    4.     name: special-config
    5.     namespace: default
    6.   data:
    7.     SPECIAL_LEVEL: very
    8.     SPECIAL_TYPE: charm

    Create the ConfigMap:

    1. kubectl create -f https://kubernetes.io/examples/configmap/configmap-multikeys.yaml

  • Use envFrom to define all of the ConfigMap’s data as container environment variables. The key from the ConfigMap becomes the environment variable name in the Pod.

    pods/pod-configmap-envFrom.yaml Configure a Pod to Use a ConfigMap - 图5

    1. apiVersion: v1
    2.   kind: Pod
    3.   metadata:
    4.     name: dapi-test-pod
    5.   spec:
    6.     containers:
    7.       - name: test-container
    8.         image: registry.k8s.io/busybox
    9.         command: [ "/bin/sh", "-c", "env" ]
    10.         envFrom:
    11.         - configMapRef:
    12.             name: special-config
    13.     restartPolicy: Never

    Create the Pod:

    1. kubectl create -f https://kubernetes.io/examples/pods/pod-configmap-envFrom.yaml

    Now, the Pod’s output includes environment variables SPECIAL_LEVEL=very and SPECIAL_TYPE=charm.

Use ConfigMap-defined environment variables in Pod commands

You can use ConfigMap-defined environment variables in the command and args of a container using the $(VAR_NAME) Kubernetes substitution syntax.

For example, the following Pod specification

pods/pod-configmap-env-var-valueFrom.yaml Configure a Pod to Use a ConfigMap - 图6

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: dapi-test-pod
  5. spec:
  6.   containers:
  7.     - name: test-container
  8.       image: registry.k8s.io/busybox
  9.       command: [ "/bin/echo", "$(SPECIAL_LEVEL_KEY) $(SPECIAL_TYPE_KEY)" ]
  10.       env:
  11.         - name: SPECIAL_LEVEL_KEY
  12.           valueFrom:
  13.             configMapKeyRef:
  14.               name: special-config
  15.               key: SPECIAL_LEVEL
  16.         - name: SPECIAL_TYPE_KEY
  17.           valueFrom:
  18.             configMapKeyRef:
  19.               name: special-config
  20.               key: SPECIAL_TYPE
  21.   restartPolicy: Never

created by running

  1. kubectl create -f https://kubernetes.io/examples/pods/pod-configmap-env-var-valueFrom.yaml

produces the following output in the test-container container:

  1. very charm

Add ConfigMap data to a Volume

As explained in Create ConfigMaps from files, when you create a ConfigMap using --from-file, the filename becomes a key stored in the data section of the ConfigMap. The file contents become the key’s value.

The examples in this section refer to a ConfigMap named special-config, shown below.

configmap/configmap-multikeys.yaml Configure a Pod to Use a ConfigMap - 图7

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   name: special-config
  5.   namespace: default
  6. data:
  7.   SPECIAL_LEVEL: very
  8.   SPECIAL_TYPE: charm

Create the ConfigMap:

  1. kubectl create -f https://kubernetes.io/examples/configmap/configmap-multikeys.yaml

Populate a Volume with data stored in a ConfigMap

Add the ConfigMap name under the volumes section of the Pod specification. This adds the ConfigMap data to the directory specified as volumeMounts.mountPath (in this case, /etc/config). The command section lists directory files with names that match the keys in ConfigMap.

pods/pod-configmap-volume.yaml Configure a Pod to Use a ConfigMap - 图8

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: dapi-test-pod
  5. spec:
  6.   containers:
  7.     - name: test-container
  8.       image: registry.k8s.io/busybox
  9.       command: [ "/bin/sh", "-c", "ls /etc/config/" ]
  10.       volumeMounts:
  11.       - name: config-volume
  12.         mountPath: /etc/config
  13.   volumes:
  14.     - name: config-volume
  15.       configMap:
  16.         # Provide the name of the ConfigMap containing the files you want
  17.         # to add to the container
  18.         name: special-config
  19.   restartPolicy: Never

Create the Pod:

  1. kubectl create -f https://kubernetes.io/examples/pods/pod-configmap-volume.yaml

When the pod runs, the command ls /etc/config/ produces the output below:

  1. SPECIAL_LEVEL
  2. SPECIAL_TYPE

Caution: If there are some files in the /etc/config/ directory, they will be deleted.

Note: Text data is exposed as files using the UTF-8 character encoding. To use some other character encoding, use binaryData.

Add ConfigMap data to a specific path in the Volume

Use the path field to specify the desired file path for specific ConfigMap items. In this case, the SPECIAL_LEVEL item will be mounted in the config-volume volume at /etc/config/keys.

pods/pod-configmap-volume-specific-key.yaml Configure a Pod to Use a ConfigMap - 图9

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: dapi-test-pod
  5. spec:
  6.   containers:
  7.     - name: test-container
  8.       image: registry.k8s.io/busybox
  9.       command: [ "/bin/sh","-c","cat /etc/config/keys" ]
  10.       volumeMounts:
  11.       - name: config-volume
  12.         mountPath: /etc/config
  13.   volumes:
  14.     - name: config-volume
  15.       configMap:
  16.         name: special-config
  17.         items:
  18.         - key: SPECIAL_LEVEL
  19.           path: keys
  20.   restartPolicy: Never

Create the Pod:

  1. kubectl create -f https://kubernetes.io/examples/pods/pod-configmap-volume-specific-key.yaml

When the pod runs, the command cat /etc/config/keys produces the output below:

  1. very

Caution: Like before, all previous files in the /etc/config/ directory will be deleted.

Project keys to specific paths and file permissions

You can project keys to specific paths and specific permissions on a per-file basis. The Secrets user guide explains the syntax.

Understanding ConfigMaps and Pods

The ConfigMap API resource stores configuration data as key-value pairs. The data can be consumed in pods or provide the configurations for system components such as controllers. ConfigMap is similar to Secrets, but provides a means of working with strings that don’t contain sensitive information. Users and system components alike can store configuration data in ConfigMap.

Note: ConfigMaps should reference properties files, not replace them. Think of the ConfigMap as representing something similar to the Linux /etc directory and its contents. For example, if you create a Kubernetes Volume from a ConfigMap, each data item in the ConfigMap is represented by an individual file in the volume.

The ConfigMap’s data field contains the configuration data. As shown in the example below, this can be simple — like individual properties defined using --from-literal — or complex — like configuration files or JSON blobs defined using --from-file.

  1. apiVersion: v1
  2. kind: ConfigMap
  3. metadata:
  4.   creationTimestamp: 2016-02-18T19:14:38Z
  5.   name: example-config
  6.   namespace: default
  7. data:
  8.   # example of a simple property defined using --from-literal
  9.   example.property.1: hello
  10.   example.property.2: world
  11.   # example of a complex property defined using --from-file
  12.   example.property.file: |-
  13.     property.1=value-1
  14.     property.2=value-2
  15.     property.3=value-3

Restrictions

  • You must create the ConfigMap object before you reference it in a Pod specification. Alternatively, mark the ConfigMap reference as optional in the Pod spec (see Optional ConfigMaps). If you reference a ConfigMap that doesn’t exist and you don’t mark the reference as optional, the Pod won’t start. Similarly, references to keys that don’t exist in the ConfigMap will also prevent the Pod from starting, unless you mark the key references as optional.

  • If you use envFrom to define environment variables from ConfigMaps, keys that are considered invalid will be skipped. The pod will be allowed to start, but the invalid names will be recorded in the event log (InvalidVariableNames). The log message lists each skipped key. For example:

    1. kubectl get events

    The output is similar to this:

    1. LASTSEEN FIRSTSEEN COUNT NAME          KIND  SUBOBJECT  TYPE      REASON                            SOURCE                MESSAGE
    2. 0s       0s        1     dapi-test-pod Pod              Warning   InvalidEnvironmentVariableNames   {kubelet, 127.0.0.1}  Keys [1badkey, 2alsobad] from the EnvFrom configMap default/myconfig were skipped since they are considered invalid environment variable names.

  • ConfigMaps reside in a specific Namespace. A ConfigMap can only be referenced by pods residing in the same namespace.

  • You can’t use ConfigMaps for static pods, because the Kubelet does not support this.

Optional ConfigMaps

You can mark a reference to a ConfigMap as optional in a Pod specification. If the ConfigMap doesn’t exist, the configuration for which it provides data in the Pod (e.g. environment variable, mounted volume) will be empty. If the ConfigMap exists, but the referenced key is non-existent the data is also empty.

For example, the following Pod specification marks an environment variable from a ConfigMap as optional:

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: dapi-test-pod
  5. spec:
  6.   containers:
  7.     - name: test-container
  8.       image: gcr.io/google_containers/busybox
  9.       command: [ "/bin/sh", "-c", "env" ]
  10.       env:
  11.         - name: SPECIAL_LEVEL_KEY
  12.           valueFrom:
  13.             configMapKeyRef:
  14.               name: a-config
  15.               key: akey
  16.               optional: true # mark the variable as optional
  17.   restartPolicy: Never

If you run this pod, and there is no ConfigMap named a-config, the output is empty. If you run this pod, and there is a ConfigMap named a-config but that ConfigMap doesn’t have a key named akey, the output is also empty. If you do set a value for akey in the a-config ConfigMap, this pod prints that value and then terminates.

You can also mark the volumes and files provided by a ConfigMap as optional. Kubernetes always creates the mount paths for the volume, even if the referenced ConfigMap or key doesn’t exist. For example, the following Pod specification marks a volume that references a ConfigMap as optional:

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4.   name: dapi-test-pod
  5. spec:
  6.   containers:
  7.     - name: test-container
  8.       image: gcr.io/google_containers/busybox
  9.       command: [ "/bin/sh", "-c", "ls /etc/config" ]
  10.       volumeMounts:
  11.       - name: config-volume
  12.         mountPath: /etc/config
  13.   volumes:
  14.     - name: config-volume
  15.       configMap:
  16.         name: no-config
  17.         optional: true # mark the source ConfigMap as optional
  18.   restartPolicy: Never

Mounted ConfigMaps are updated automatically

When a mounted ConfigMap is updated, the projected content is eventually updated too. This applies in the case where an optionally referenced ConfigMap comes into existence after a pod has started.

The kubelet checks whether the mounted ConfigMap is fresh on every periodic sync. However, it uses its local TTL-based cache for getting the current value of the ConfigMap. As a result, the total delay from the moment when the ConfigMap is updated to the moment when new keys are projected to the pod can be as long as kubelet sync period (1 minute by default) + TTL of ConfigMaps cache (1 minute by default) in kubelet.

Note: A container using a ConfigMap as a subPath volume will not receive ConfigMap updates.

What’s next