ConfigMap在K8S中经常会使用到，它能使容器镜像和配置内容解耦，它可以绑定在volume上供容器访问，它的创建和使用也是灵活多样，这篇文章翻译自Kubernetes官网，详细演示了如何创建ConfigMap和如何使用ConfigMap配置Pod，内容比较全面，希望能帮助到大家。

创建ConfigMap

可以使用 kubectl create configmap 或 kustomization.yaml 中的 ConfigMap 生成器来创建 ConfigMap。 请注意，kubectl 从 1.14 开始支持 kustomization.yaml。

使用kubectl create configmap

使用 kubectl create configmap 命令可以从目录、文件或文字值创建 ConfigMap。

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

其中 <map-name> 是您要分配给 ConfigMap 的名称，<data-source> 是从中提取数据的目录、文件或文字值。 ConfigMap 对象的名称必须是有效的 DNS 子域名。

基于文件创建ConfigMap时，<data-source>中的key默认为文件的basename，value默认为文件内容。

您可以使用 kubectl describe 或 kubectl get 来检索有关 ConfigMap 的信息。

从目录创建ConfigMap

您可以使用 kubectl create configmap 从同一目录中的多个文件创建一个 ConfigMap。 当你基于目录创建 ConfigMap 时，kubectl 会识别基本名称是目录中有效键的文件，并将这些文件中的每一个打包到新的 ConfigMap 中。 除常规文件外的任何目录条目都将被忽略（例如子目录、符号链接、设备、管道等）。例如：

# Create the local directory
mkdir -p configure-pod-container/configmap/

# Download the sample files into `configure-pod-container/configmap/` directory
wget https://kubernetes.io/examples/configmap/game.properties -O configure-pod-container/configmap/game.properties
wget https://kubernetes.io/examples/configmap/ui.properties -O configure-pod-container/configmap/ui.properties

# Create the configmap
kubectl create configmap game-config --from-file=configure-pod-container/configmap/

上述命令将 configure-pod-container/configmap/ 目录中的每个文件（在本例中为 game.properties 和 ui.properties）打包到 game-config ConfigMap 中。 你可以使用以下命令显示 ConfigMap 的详细信息：

kubectl describe configmaps game-config

输入结果类似如下：

Name:         game-config
Namespace:    default
Labels:       <none>
Annotations:  <none>

Data
====
game.properties:
----
enemies=aliens
lives=3
enemies.cheat=true
enemies.cheat.level=noGoodRotten
secret.code.passphrase=UUDDLRLRBABAS
secret.code.allowed=true
secret.code.lives=30
ui.properties:
----
color.good=purple
color.bad=yellow
allow.textmode=true
how.nice.to.look=fairlyNice

configure-pod-container/configmap/ 目录中的 game.properties 和 ui.properties 文件在 ConfigMap 的数据部分中表示。

kubectl get configmaps game-config -o yaml

输出如下:

apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2016-02-18T18:52:05Z
  name: game-config
  namespace: default
  resourceVersion: "516"
  uid: b4952dc3-d670-11e5-8cd0-68f728db1985
data:
  game.properties: |
    enemies=aliens
    lives=3
    enemies.cheat=true
    enemies.cheat.level=noGoodRotten
    secret.code.passphrase=UUDDLRLRBABAS
    secret.code.allowed=true
    secret.code.lives=30    
  ui.properties: |
    color.good=purple
    color.bad=yellow
    allow.textmode=true
    how.nice.to.look=fairlyNice    

从文件创建ConfigMap

可以使用 kubectl create configmap 从单个文件或多个文件创建 ConfigMap。例如：

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

使用kubectl describe可以查看

kubectl describe configmaps game-config-2

输出如下:

Name:         game-config-2
Namespace:    default
Labels:       <none>
Annotations:  <none>

Data
====
game.properties:
----
enemies=aliens
lives=3
enemies.cheat=true
enemies.cheat.level=noGoodRotten
secret.code.passphrase=UUDDLRLRBABAS
secret.code.allowed=true
secret.code.lives=30

我们可以多次传入 --from-file 参数以从多个数据源创建 ConfigMap。

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

使用以下命令显示 game-config-2 ConfigMap 的详细信息：

kubectl describe configmaps game-config-2

输出如下：

Name:         game-config-2
Namespace:    default
Labels:       <none>
Annotations:  <none>

Data
====
game.properties:
----
enemies=aliens
lives=3
enemies.cheat=true
enemies.cheat.level=noGoodRotten
secret.code.passphrase=UUDDLRLRBABAS
secret.code.allowed=true
secret.code.lives=30
ui.properties:
----
color.good=purple
color.bad=yellow
allow.textmode=true
how.nice.to.look=fairlyNice

当 kubectl 从非 ASCII 或 UTF-8 输入创建 ConfigMap 时，该工具会将这些放入 ConfigMap 的 binaryData 字段中，而不是数据中。 文本和二进制数据源都可以组合在一个 ConfigMap 中。 如果要查看 ConfigMap 中的 binaryData 键（及其值），可以运行 kubectl get configmap -o jsonpath='{.binaryData}' <name>。

从环境变量文件中创建ConfigMap

使用选项 --from-env-file 从 env-file 创建一个 ConfigMap，例如：

# Env-files contain a list of environment variables.
# These syntax rules apply:
#   Each line in an env file has to be in VAR=VAL format.
#   Lines beginning with # (i.e. comments) are ignored.
#   Blank lines are ignored.
#   There is no special handling of quotation marks (i.e. they will be part of the ConfigMap value)).

# Download the sample files into `configure-pod-container/configmap/` directory
wget https://kubernetes.io/examples/configmap/game-env-file.properties -O configure-pod-container/configmap/game-env-file.properties

# The env-file `game-env-file.properties` looks like below
cat configure-pod-container/configmap/game-env-file.properties
enemies=aliens
lives=3
allowed="true"

# This comment and the empty line above it are ignored

运行下面的两个命令将创建如下的ConfigMap

kubectl create configmap game-config-env-file \
       --from-env-file=configure-pod-container/configmap/game-env-file.properties
kubectl get configmap game-config-env-file -o yaml

输出如下：

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

注意：多次传递 --from-env-file 以从多个数据源创建 ConfigMap 时，仅使用最后一个 env-file。

如下实例：

# Download the sample files into `configure-pod-container/configmap/` directory
wget https://kubernetes.io/examples/configmap/ui-env-file.properties -O configure-pod-container/configmap/ui-env-file.properties

# Create the configmap
kubectl create configmap config-multi-env-files \
        --from-env-file=configure-pod-container/configmap/game-env-file.properties \
        --from-env-file=configure-pod-container/configmap/ui-env-file.properties
kubectl get configmap config-multi-env-files -o yaml

输出如下：

apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2017-12-27T18:38:34Z
  name: config-multi-env-files
  namespace: default
  resourceVersion: "810136"
  uid: 252c4572-eb35-11e7-887b-42010a8002b8
data:
  color: purple
  how: fairlyNice
  textmode: "true"

从文件中创建ConfigMap时设定key

使用 --from-file 参数时，您可以定义要在 ConfigMap 的数据部分中使用的文件名以外的键：

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

其中 <my-key-name> 是您要在 ConfigMap 中使用的键，<path-to-file> 是您希望该键表示的数据源文件的位置。
例如:

kubectl create configmap game-config-3 --from-file=game-special-key=configure-pod-container/configmap/game.properties
kubectl get configmaps game-config-3 -o yaml

将产生如下的输出:

apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2016-02-18T18:54:22Z
  name: game-config-3
  namespace: default
  resourceVersion: "530"
  uid: 05f8da22-d671-11e5-8cd0-68f728db1985
data:
  game-special-key: |
    enemies=aliens
    lives=3
    enemies.cheat=true
    enemies.cheat.level=noGoodRotten
    secret.code.passphrase=UUDDLRLRBABAS
    secret.code.allowed=true
    secret.code.lives=30    

从文字值创建ConfigMap

可以使用带有 --from-literal 参数的 kubectl create configmap 从命令行定义文字值：

kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm
kubectl get configmaps special-config -o yaml

产生输出如下：

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

从Generator创建ConfigMap

kubectl 从 1.14 开始支持 kustomization.yaml。 您还可以从Generator创建一个 ConfigMap，然后应用它在 Apiserver 上创建对象。 Generator应在目录内的 kustomization.yaml 中指定。

从文件中产生ConfigMap

例如，从文件 configure-pod-container/configmap/game.properties 生成一个 ConfigMap

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

应用 kustomization 目录来创建 ConfigMap 对象。

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

使用以下命令来check ConfigMap内容:

kubectl get configmap
NAME                       DATA   AGE
game-config-4-m9dm2f92bt   1      37s


kubectl describe configmaps/game-config-4-m9dm2f92bt
Name:         game-config-4-m9dm2f92bt
Namespace:    default
Labels:       <none>
Annotations:  kubectl.kubernetes.io/last-applied-configuration:
                {"apiVersion":"v1","data":{"game.properties":"enemies=aliens\nlives=3\nenemies.cheat=true\nenemies.cheat.level=noGoodRotten\nsecret.code.p...

Data
====
game.properties:
----
enemies=aliens
lives=3
enemies.cheat=true
enemies.cheat.level=noGoodRotten
secret.code.passphrase=UUDDLRLRBABAS
secret.code.allowed=true
secret.code.lives=30
Events:  <none>

从文件中产生ConfigMap定义键

你可以定义要在 ConfigMap 生成器中使用的文件名以外的键。 例如，要从文件 configure-pod-container/configmap/game.properties 中生成一个 ConfigMap，其key为 game-special-key。

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

应用 kustomization 目录来创建 ConfigMap 对象。

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

从文字生成 ConfigMaps

如下实例:

# Create a kustomization.yaml file with ConfigMapGenerator
cat <<EOF >./kustomization.yaml
configMapGenerator:
- name: special-config-2
  literals:
  - special.how=very
  - special.type=charm
EOF

应用 kustomization 目录来创建 ConfigMap 对象。

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

在Pod中应用ConfigMap

容器的环境变量中使用ConfigMap data

1）从单个ConfigMap的Data中定义容器环境变量
如下实例，
第一步，创建ConfigMap

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

第二步，在Pod specification中使用ConfigMap中定义的值赋给环境变量

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      command: [ "/bin/sh", "-c", "env" ]
      env:
        # Define the environment variable
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              # The ConfigMap containing the value you want to assign to SPECIAL_LEVEL_KEY
              name: special-config
              # Specify the key associated with the value
              key: special.how
  restartPolicy: Never

从多个ConfigMap中定义容器环境变量

实例如下：
第一步，声明多个ConfigMaps

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  special.how: very
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: env-config
  namespace: default
data:
  log_level: INFO

第二步，创建ConfigMaps

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

第三步，在pod specification中使用ConfigMap中的Data

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      command: [ "/bin/sh", "-c", "env" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.how
        - name: LOG_LEVEL
          valueFrom:
            configMapKeyRef:
              name: env-config
              key: log_level
  restartPolicy: Never

配置在ConfigMap中所有的key-value 键值对作为容器的环境变量

实例如下：
第一步，声明ConfigMap

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  SPECIAL_LEVEL: very
  SPECIAL_TYPE: charm

第二步，创建ConfigMap

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

第三步，使用envFrom定义ConfigMap中所有data作为容器的环境变量。

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      command: [ "/bin/sh", "-c", "env" ]
      envFrom:
      - configMapRef:
          name: special-config
  restartPolicy: Never

第四步，创建POD

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

现在Pod中的环境变量包括SPECIAL_LEVEL=very 和 SPECIAL_TYPE=charm.

在Pod命令中使用ConfigMap定义的环境变量

实例如下:

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      command: [ "/bin/echo", "$(SPECIAL_LEVEL_KEY) $(SPECIAL_TYPE_KEY)" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: SPECIAL_LEVEL
        - name: SPECIAL_TYPE_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: SPECIAL_TYPE
  restartPolicy: Never

增加ConfigMap data到volume

上面的实例中演示了从文件中创建ConfigMaps，文件名成为了key，文件内容成为了键值。
第一步，创建ConfigMap

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  SPECIAL_LEVEL: very
  SPECIAL_TYPE: charm

第二步，使用ConfigMap里的存储的数据绑定到volume
在 Pod specification的volume部分下添加 ConfigMap 名称。 这会将 ConfigMap 数据添加到指定为 volumeMounts.mountPath 的目录（在本例中为 /etc/config）。 命令部分列出了名称与 ConfigMap 中的键匹配的目录文件。

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      command: [ "/bin/sh", "-c", "ls /etc/config/" ]
      volumeMounts:
      - name: config-volume
        mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap:
        # Provide the name of the ConfigMap containing the files you want
        # to add to the container
        name: special-config
  restartPolicy: Never

创建Pod

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

当pod运行后，命令 ls /etc/config/产生下面的输出

SPECIAL_LEVEL
SPECIAL_TYPE

注意：如果在/etc/config目录下有相同的文件，他们将被删除。文件格式是UTF-8,为了用其他字符编码，用binaryData。

增加特定路径下的data到volume

实例如下：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      command: [ "/bin/sh","-c","cat /etc/config/keys" ]
      volumeMounts:
      - name: config-volume
        mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap:
        name: special-config
        items:
        - key: SPECIAL_LEVEL
          path: keys
  restartPolicy: Never

创建Pod

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

当pod运行后，命令 ls /etc/config/产生下面的输出

SPECIAL_LEVEL

可选的References

ConfigMap Reference可以被标记为“可选”。 如果 ConfigMap 不存在，则挂载的卷将为空。 如果 ConfigMap 存在，但引用的键不存在，则安装点下方将不存在路径。

挂载的ConfigMap会自动更新

当挂载的ConfigMap 更新时，映射内容最终也会更新。 这适用于在 pod 启动后存在可选引用的 ConfigMap 的情况。
Kubelet 在每次定期同步时检查挂载的 ConfigMap 是否是最新的。 但是，它使用其本地基于TTL的缓存来获取 ConfigMap 的当前值。 因此，从更新 ConfigMap 到将新key投射到Pod的总延迟可以达到kubelet同步周期（默认为 1 分钟）+ ConfigMaps 缓存的 TTL（默认为 1 分钟） )。 在 kubelet 中，您可以通过更新 pod 的注释之一来触发立即刷新。

理解ConfigMap和Pods

ConfigMap API 资源将配置数据存储为键值对。 数据可以在 pod 中使用，也可以为控制器等系统组件提供配置。 ConfigMap类似于Secrets，但提供了一种处理不包含敏感信息的字符串的方法。 用户和系统组件都可以在ConfigMap中存储配置数据。

注意：ConfigMaps应该引用属性文件，而不是替换它们。 将 ConfigMap 视为类似于 Linux /etc 目录及其内容的表示。 例如，如果您从 ConfigMap 创建 Kubernetes 卷，则 ConfigMap 中的每个数据项都由卷中的单个文件表示。
ConfigMap的数据字段包含配置数据。 如下例所示，这可以很简单，比如使用 --from-literal 定义的单个属性，也可以很复杂，比如使用 --from-file 定义的配置文件或 JSON blob。

apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2016-02-18T19:14:38Z
  name: example-config
  namespace: default
data:
  # example of a simple property defined using --from-literal
  example.property.1: hello
  example.property.2: world
  # example of a complex property defined using --from-file
  example.property.file: |-
    property.1=value-1
    property.2=value-2
    property.3=value-3  

限制

• 在 Pod specification中引用它之前，您必须创建一个 ConfigMap（除非将 ConfigMap 标记为“可选”）。 如果引用不存在的 ConfigMap，则 Pod 将不会启动。 同样，对 ConfigMap 中不存在的键的引用将阻止 pod 启动。

• 如果使用 envFrom 从 ConfigMaps 定义环境变量，则会跳过被认为无效的键。 Pod 将被允许启动，但无效名称将记录在事件日志中 (InvalidVariableNames)。 日志消息列出了每个跳过的键。 例如：

kubectl get events

输出类似结果：

LASTSEEN FIRSTSEEN COUNT NAME          KIND  SUBOBJECT  TYPE      REASON                            SOURCE                MESSAGE
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.

• ConfigMap驻留在特定的命名空间中。 ConfigMap 只能被驻留在同一命名空间中的 pod 引用。
• 不能将 ConfigMaps 用于静态Pod，因为Kubelet不支持此功能。