kubernetes | configMap

一、ConfigMap 概述

在生产环境中经常会遇到需要修改配置文件的情况，传统的修改方式不仅会影响到服务的正常运行，而且操作步骤也很繁琐。为了解决这个问题，kubernetes 项目从 1.2 版本引入了 ConfigMap 功能，用于将应用的配置信息与程序的分离。这种方式不仅可以实现应用程序被的复用，而且还可以通过不同的配置实现更灵活的功能。在创建容器时，用户可以将应用程序打包为容器镜像后，通过环境变量或者外接挂载文件的方式进行配置注入。 ConfigMap && Secret 是 K8S 中的针对应用的配置中心，它有效的解决了应用挂载的问题，并且支持加密以及热更新等功能，可以说是一个 k8s 提供的一件非常好用的功能。 ConfigMap 功能在 Kubernetes1.2 版本中引入，许多应用程序会从配置文件、命令行参数或环境变量中读取配置信息。ConfigMap API 给我们提供了向容器中注入配置信息的机制，ConfigMap 可以被用来保存单个属性，也可以用来保存整个配置文件或者 JSON 二进制大对象

二、ConfigMap 的创建

（1）使用目录创建

$ ls docs/user-guide/configmap/kubectl/
game.properties
ui.properties

$ cat docs/user-guide/configmap/kubectl/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

$ cat docs/user-guide/configmap/kubectl/ui.properties
color.good=purple
color.bad=yellow
allow.textmode=true
how.nice.to.look=fairlyNice

$ kubectl create configmap game-config --from-file=docs/user-guide/configmap/kubectl

（2）使用文件创建
只要指定为一个文件就可以从单个文件中创建 ConfigMap

$ kubectl create configmap game-config-2 --from-file=docs/user-guide/configmap/kubectl/game.properties
$ kubectl get configmaps game-config-2 -o yaml

--from-file 这个参数可以使用多次，你可以使用两次分別指定上个实例中的那两个配置文件，效果就跟指定整个目录是一样的。

（3）使用字面值创建
使用文字值创建，利用 --from-literal 参数传递配置信息，该参数可以使用多次，格式如下：

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

三、Pod 中使用 ConfigMap

3.1、使用 ConfigMap 来替代环境变量。

configmap-literal.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: literal-config
  namespace: default
data:
  name: dave
  password: pass

# 基于 yaml 文件运行 configmap
kubectl apply -f configmap-literal.yaml

configmap-env.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: env-config
  namespace: default
data:
  log_level: INFO
 
# 基于 yaml 文件运行 configmap
kubectl apply -f configmap-env.yaml

configmap-pod.yaml

apiVersion: v1
kind: Pod
metadata:
  name: cm-env-test-pod
spec:
  containers:
    - name: test-container
      image: centos:7.9.2009
      command: ["/bin/sh", "-c", "env"]
      env:
        - name: USERNAME                # 创建一个环境变量的名字
          valueFrom:                    # 来源
            configMapKeyRef:            # 来源于 configMapKeyRef
              name: literal-config      # 来自于上面创建的 literal-config
              key: name                 # 来自于 name 字段
        - name: PASSWORD
          valueFrom:
            configMapKeyRef:
              name: literal-config
              key: password
      envFrom:                          # 使用 envFrom 字段可以将 env-config 中的所有键值对作为环境变量导入到 Pod 中
        - configMapRef:
            name: env-config
  restartPolicy: Never

根据 yaml 文件创建 pod

kubectl create -f configmap-pod.yaml
kubectl get pod

[root@izl4y01dhbrghjuo3yt3prZ pod]# kubectl logs cm-env-test-pod
HOSTNAME=cm-env-test-pod
KUBERNETES_PORT_443_TCP_PORT=443
KUBERNETES_PORT=tcp://172.21.0.1:443
KUBERNETES_SERVICE_PORT=443
KUBERNETES_SERVICE_HOST=172.21.0.1
PASSWORD=pass
MYAPP_SERVICE_HOST=172.21.10.215
USERNAME=dave
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
PWD=/
log_level=INFO
MYAPP_PORT_80_TCP=tcp://172.21.10.215:80
MYAPP_PORT_80_TCP_PORT=80
SHLVL=1
HOME=/root
MYAPP_PORT_80_TCP_PROTO=tcp
MYAPP_PORT=tcp://172.21.10.215:80
MYAPP_SERVICE_PORT=80
KUBERNETES_PORT_443_TCP_PROTO=tcp
KUBERNETES_SERVICE_PORT_HTTPS=443
KUBERNETES_PORT_443_TCP_ADDR=172.21.0.1
MYAPP_PORT_80_TCP_ADDR=172.21.10.215

3.2、使用 ConfigMap 设置命令行参数

apiVersion: v1
kind: Pod
metadata:
 name: cm-command-dapi-test-pod
spec:
 containers:
   - name: test-container
     image: centos:7.9.2009
     command: [ "/bin/sh", "-c", "echo $(USERNAME) $(PASSWORD)" ]
     env:
       - name: USERNAME
         valueFrom:
           configMapKeyRef:
             name: literal-config
             key: name
       - name: PASSWORD
         valueFrom:
           configMapKeyRef:
             name: literal-config
             key: password
 restartPolicy: Never

kubectl logs cm-command-dapi-test-pod

3.3、通过数据卷插件使用 ConfigMap

apiVersion: v1
kind: Pod
metadata:
  name: cm-volume-test-pod
spec:
  containers:
    - name: test-container
      image: centos:7.9.2009
      command: [ "/bin/sh", "-c", "tail -f /var/log/yum.log" ]  # 持久化运行，使容器保持运行，不会退出。
      volumeMounts:  # 挂载 volume 卷
        - name: config-volume
          mountPath: /etc/config
  volumes:
    - name: config-volume  # 卷的名字叫 config-volume
      configMap:  # 基于 configMap 提供的
        name: literal-config  # 基于名字为 literal-config 的 configMap 提供的
  restartPolicy: Never

kubectl exec -it cm-volume-test-pod -- /bin/bash

进入容器后，执行下列命令，查看挂载的 volume 卷的信息。

[root@cm-volume-test-pod log]# cd /etc/config
[root@cm-volume-test-pod config]# ls
name  password
[root@cm-volume-test-pod config]# cat name
dave[root@cm-volume-test-pod config]#
[root@cm-volume-test-pod config]# cat password
pass[root@cm-volume-test-pod config]#
[root@cm-volume-test-pod config]# ls -l
total 0
lrwxrwxrwx 1 root root 11 Jan  5 04:07 name -> ..data/name
lrwxrwxrwx 1 root root 15 Jan  5 04:07 password -> ..data/password
[root@cm-volume-test-pod config]# cd ..data/
[root@cm-volume-test-pod ..data]# ls
name  password

为什么这里这么设计，因为这里支持热更新。 什么叫热更新呢，就是我现在把 configmap 的对象改变的话，这里的内容也会变化。 注意：这里不是共享，这是注入。 如果共享过多的话，会造成过多的资源损耗。 注入的话就不会有这个问题，先注入 10 个 pod，这 10 个 pod 注入以后，再注入下 10 pod。 什么叫注入，cat 这个文件，重定向到你的目录下，这叫注入。

四、ConfigMap 的热更新

apiVersion: v1
kind: ConfigMap
metadata:
  name: log-config
  namespace: default
data:
  log_level: INFO
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: hot-update
spec:
  replicas: 2
  selector:
    matchLabels:
      run: nginx
  template:
    metadata:
      labels:
        run: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:latest
        imagePullPolicy: IfNotPresent
        ports:
        - containerPort: 80
        volumeMounts:
        - name: config-volume
          mountPath: /etc/config
      volumes:
        - name: config-volume
          configMap:
            name: log-config

# 观察信息
while 2>1;do kubectl exec hot-update-5f9f99b44f-sm7kf -- cat /etc/config/log_level;sleep 1s;date;done

终端 1：

# 修改 data 里的键值 INFO 为 log_level:ERROR
#annotations: 里面的 INFO 为 ERROR
kubectl edit cm log-config

终端 2 查看变化。

4.1、滚动更新触发器

通过手动修改 Pod 的注解（Annotations），强制触发 Deployment 的滚动更新（Rolling Update）。

为什么要这么做？
在 Kubernetes 中，当你修改了 ConfigMap 的内容后：

• 容器内的文件虽然会“热更新”，但应用程序往往并不知道文件变了。
• 如果你的程序不具备自动重新加载配置的能力，你就需要重启 Pod。
• 直接删 Pod 风险大（可能导致服务短暂中断）。

通过 kubectl patch 给 Deployment 打上一个无意义的 version/config 标签，会改变 Pod 模板（Pod Template）的哈希值。Kubernetes 监测到模板变了，就会认为配置已更新，从而启动滚动更新：先启动一个新 Pod（加载了新配置），再删掉一个旧 Pod。

# 查看 yaml 文件
kubectl get deployment hot-update -o yaml

# 更新版本
kubectl patch deployment hot-update --patch '{"spec": {"template": {"metadata": {"annotations": {"version/config": "20190411" }}}}}'

# 再次查看 yaml 文件
kubectl get deployment hot-update -o yaml

spec:
  progressDeadlineSeconds: 600
  replicas: 2
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      run: nginx
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate
  template:
    metadata:
      annotations:
        version/config: "20190411"
      creationTimestamp: null
      labels:
        run: nginx
    spec:
      containers:
      - image: nginx:latest
        imagePullPolicy: IfNotPresent

如果只是想简单地触发重启，而不关心那个具体的日期标签，可以使用更语义化的命令：

kubectl rollout restart deployment hot-update

这个命令的作用与 patch 完全一致，会自动在注解里加上 kubectl.kubernetes.io/restartedAt，实现优雅的滚动重启。

五、ConfigMap 更新后滚动更新 Pod

更新 ConfigMap 目前并不会触发相关 Pod 的滚动更新，可以通过修改 pod annotations 的 方式强制触发滚动更新。

kubectl patch deployment my-nginx --patch '{"spec": {"template": {"metadata": {"annotations": {"version/config": "20190411" }}}}}'

这个例子里我们在 spec.template.metadata.annotations 中添加 version/config , 每次通过修改 version/config 来触发滚动更新。

更新 ConfigMap 后：
使用该 ConfigMap 挂载的 Env 不会同步更新。
使用该 ConfigMap 挂载的 Volume 中的数据需要一段时间（实测大概 10 秒）才能同步更新。