Kubernetes 0-1 了解ConfigMap

2024-03-26 22:56:58

几乎所有的应用都需要配置信息，在K8S部署应用，最佳实践是将应用的配置信息（环境变量或者配置文件）和程序本身分离，这样配置信息的更新和复用都可以更简单，也使得程序更加灵活。

Kubernetes允许将配置选项分离到单独的资源对象ConfigMap中，本质上是一个键值对映射，值可以是一个短string串，也可以是一个完整的配置文件。

本篇主要介绍ConfigMap资源的创建和使用。

ConfigMap的创建

可以直接通过kubectl create configmap命令创建，也可以先编写configmap的yaml文件再使用kubectl apply -f <filename>创建，推荐使用后者。

单行命令创建ConfigMap

创建一个键值对的ConfigMap：

kubectl create configmap first-config --from-literal=user=admin

创建完成之后，使用kubectl describe configmap first-config查看，可以看到这个configmap的键值内容。

可以使用多组--from-literal=<key>=<value>参数，在configmap中定义多组键值对。

创建一个文件内容的ConfigMap

假如我当前有一个配置文件app.json，文件内容如下：

{
  "App": "MyApp",
  "Version": "v1.0"
}

使用以下命令创建ConfigMap：

kubectl create configmap second-config --from-file=app.json

创建完成之后，使用kubectl describe configmap second-config查看configmap的键值内容：

默认使用文件名称app.json作为键值对的key，也可以通过--from-file=app_config=app.json指定key为app_config；

可以使用多组--from-file=<key>=<filename>参数，在configmap中定义多组文件；

--from-file=后面可以直接跟某个文件路径，这样会将目录下的所有文件引入到ConfigMap;

--from-literal和--from-file可以共同使用，键值合并。

删除创建的first-config和second-config：

kubectl delete configmap first-config
kubectl delete configmap second-config

基于资源清单文件创建ConfigMap

创建一个键值对的ConfigMap：

首先定义ConfigMap的资源文件first-config.yaml，定义如下：

vim first-config.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: first-config
data:
  user: "admin"

使用kubectl apply命令创建ConfigMap资源：

kubectl apply -f first-config.yaml

创建完成之后，使用kubectl describe configmap first-config查看，可以看到这个configmap的键值内容，结果与上文第一次创建的first-configmap是一致的。

可以在data下定义多组键值对。

创建一个文件内容的ConfigMap

首先定义ConfigMap的资源文件second-config.yaml，定义如下：

vim second-config.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: second-config
data:
  app.json: |
    {
      "App": "MyApp",
      "Version": "v1.0"
    }

使用kubectl apply命令创建ConfigMap资源：

kubectl apply -f second-config.yaml

创建完成之后，使用kubectl describe configmap second-config查看，可以看到这个configmap的键值内容，结果与上文第一次创建的second-configmap是一致的。

可以在data下定义多组文件，也可以和键值对一起定义；

其本质也是键值对，只是value为多行格式的文本内容；

对value有格式要求，”|“接换行并且文件内容的每行按照key都往后退格。

删除创建的first-config和second-config：

kubectl delete configmap first-config
kubectl delete configmap second-config

ConfigMap的使用

我们创建了ConfigMap后，我们的Pod资源就可以利用了。主要有两种方式使用ConfigMap：

使用ConfigMap作为容器的环境变量
使用ConfigMap作为Volume向容器提供文件

使用ConfigMap作为容器的环境变量

假如有一个名为first-config的ConfigMap，里面包含了一个键为user，我想将这个ConfigMap中user键用到我的环境变量USER_NAME中，可以使用如下方式：

...
env:
- name: USER_NAME
  valueFrom:
    configMapKeyRef:
      name: first-config
      key: user
...

如果有一个名为second-configConfigMap中包含多个键如HOST，PORT，USER_NAME，PASSWORD，我想将这个ConfigMap中所有的键都用到我的环境变量中，可以使用如下方式：

...
spec:
  container:
  - image: <some-image>
    envFrom:
    - prefix: DB_
      configMapRef:
        name: second-config
...

容器将会生成DB_HOST，DB_PORT，DB_USER_NAME，DB_PASSWORD四个环境变量，prefix也可以不配置，则直接使用ConfigMap的键。

注意：

configMapRef与上面configMapKeyRef的区别；
如果ConfigMap中有一个为USER-NAME键，那么将不会生成DB_USER-NAME的环境变量，因为DB_USER-NAME不是一个合法的环境变量名称。

使用ConfigMap作为Volume向容器提供文件

从这里开始，结合实际演练可能效果会好一点。

我仍然使用med1tator/helloweb:v1镜像运行模拟应用程序，程序的代码在这：https://github.com/Med1tator/for-docker

这个应用程序根目录下存在mysettings/app.json和mysettings/secret.json两个配置文件，需要提前说明的是这个镜像中已经存在了这两个文件，并且文件内容如下：

我现在将这两个配置文件放在我的ConfigMap中，并且内容与镜像中略微区别，用于区分程序读取配置源自ConfigMap，然后使用Volume的形式将文件挂载到应用中去。

首先，定义ConfigMap文件如下：

vim helloweb-mysettings.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: helloweb-mysettings
data:
  app.json: |
    {
      "App":"Hello Web [From ConfigMap]",
      "Version":"v1 [From ConfigMap]"
    }  
  secret.json: |
    {
      "UserName":"admin [From ConfigMap]",
      "Password":"123456 [From ConfigMap]"
    }

定义Pod文件如下：

vim helloweb-pod.yaml

apiVersion: v1
kind: Pod
metadata:
  name: helloweb
spec:
  containers:
  - name: helloweb
    image: med1tator/helloweb:v1
    ports:
      - containerPort: 80
    volumeMounts:
      - mountPath: /app/mysettings
        name: helloweb-mysettings
  volumes:
  - name:  helloweb-mysettings
    configMap:
      name: helloweb-mysettings

Apply资源：

kubectl apply -f helloweb-mysettings.yaml
kubectl apply -f helloweb-pod.yaml

等待helloweb的Pod起来之后，我们调用http://<pod-ip>/configuration/mysettings查看挂载的配置文件是否生效：

helloweb应用访问/configuration/mysettings会获取app.json和secret.json里面的总共四个配置项，然后输出到客户端。

可以看到，已经获取到了ConfigMap里面的配置，进入容器也可以看到里面的问题件内容：

修改ConfigMap自动更新挂载文件

现在，如果我想要修改我的配置，比如我的密码修改成了abcdefg，我不用重新启动Pod，我只需要修改ConfigMap文件：

apiVersion: v1
kind: ConfigMap
metadata:
  name: helloweb-mysettings
data:
  app.json: |
    {
      "App":"Hello Web [From ConfigMap]",
      "Version":"v1 [From ConfigMap]"
    }  
  secret.json: |
    {
      "UserName":"admin [From ConfigMap]",
      "Password":"abcdefg [From ConfigMap]"
    }

然后重新Apply资源：

kubectl apply -f helloweb-mysettings.yaml

配置文件的更新需要1-2分钟的时间，我们可以连续观察文件的更新情况：

可以看到，过段时间后配置文件更新了。

这里遇到了一个小问题，继续访问/configuration/mysettings，应用程序并没有热更新，但是我使用hostPath的Volume形式挂载时，修改配置文件是可以热更新的，希望有缘人能给我解答吧。

多文件目录下挂载单个文件

在实际的应用中，可能secret.json的变动更为频繁，而app.json文件几乎不会变动，我现在只想使用ConfigMap传递secret.json文件，而不再传递app.json，这时，修改ConfigMap文件如下：

apiVersion: v1
kind: ConfigMap
metadata:
  name: helloweb-mysettings
data:
  secret.json: |
    {
      "UserName":"admin [From ConfigMap]",
      "Password":"123456 [From ConfigMap]"
    }

然后，重新Apply资源:

kubectl apply -f helloweb-mysettings.yaml

这时候，我们继续访问/configuration/mysettings：

很遗憾的发现，我们的app.json的配置项都失效了，我们接着去容器中一探究竟：

原来，app.json文件已经不存在了。

大概推测一下可以知道，如果使用ConfigMap挂载到容器的一个目录，那么该目录会被ConfigMap所覆盖。那么如果只挂载单个目录呢？使用subPath！

修改Pod文件如下：

apiVersion: v1
kind: Pod
metadata:
  name: helloweb
spec:
  containers:
  - name: helloweb
    image: med1tator/helloweb:v1
    ports:
      - containerPort: 80
    volumeMounts:
      - mountPath: /app/mysettings/secret.json
        name: helloweb-mysettings
        subPath: secret.json
  volumes:
  - name:  helloweb-mysettings
    configMap:
      name: helloweb-mysettings

mountPath是容器中目标文件路径；

subPath是ConfgMap文件的Key值。

然后，重新Apply资源:

kubectl delete -f helloweb-pod.yaml
kubectl apply -f helloweb-pod.yaml

等待Pod运行后，我们访问/configuration/mysettings，并查看mysettings目录下文件：

可以看到成功的挂载secret.json文件而没有挂载app.json文件，[From ConfigMap]就是证明。

需要额外注意的是，在使用过程中发现，使用subPath挂载单文件的话，ConfigMap的更新不会同步更新到容器对应文件中。这时候的解决办法是一个目录只存放一个配置文件，然后ConfigMap挂载到目录。

如果一个ConfigMap（app-config）中定义了多个文件（app1.json、app2.json），但是app1-pod中只会使用到app1.json，可以使用如下方式：

...
      volumeMounts:
      - mountPath: /config/path
        name: helloweb-mysettings
  volumes:
  - name:  app-config
    configMap:
      name: app-config
      items:
      - key: app1.json
        path: app.json

items的key用于指定ConfigMap的key，path则可以定义为程序中的文件名。

码农公寓