ConfigMap
应用程序的运行可能会依赖一些配置,而这些配置又是可能会随着需求产生变化的,如果我们的应用程序架构不是应用和配置分离的,那么就会存在当我们需要去修改某些配置项的属性时需要重新构建镜像文件的窘境。现在,ConfigMap组件可以很好的帮助我们实现应用和配置分离,避免因为修改配置项而重新构建镜像。
ConfigMap 用于保存配置数据的键值对,可以用来保存单个属性,也可以用来保存配置文件。ConfigMap 跟 Secret 很类似,但它可以更方便地处理不包含敏感信息的字符串。

API 版本对照表

Kubernetes 版本
Core API 版本
v1.5+
core/v1

ConfigMap 创建

可以使用 kubectl create configmap 从文件、目录或者 key-value 字符串创建等创建 ConfigMap。也可以通过 kubectl create -f file 创建。

从 key-value 字符串创建

1
$ kubectl create configmap special-config --from-literal=special.how=very
2
configmap "special-config" created
3
$ kubectl get configmap special-config -o go-template='{{.data}}'
4
map[special.how:very]
Copied!

从 env 文件创建

1
$ echo -e "a=b\nc=d" | tee config.env
2
a=b
3
c=d
4
$ kubectl create configmap special-config --from-env-file=config.env
5
configmap "special-config" created
6
$ kubectl get configmap special-config -o go-template='{{.data}}'
7
map[a:b c:d]
Copied!

从目录创建

1
$ mkdir config
2
$ echo a>config/a
3
$ echo b>config/b
4
$ kubectl create configmap special-config --from-file=config/
5
configmap "special-config" created
6
$ kubectl get configmap special-config -o go-template='{{.data}}'
7
map[a:a
8
b:b
9
]
Copied!

从文件 Yaml/Json 文件创建

1
apiVersion: v1
2
kind: ConfigMap
3
metadata:
4
name: special-config
5
namespace: default
6
data:
7
special.how: very
8
special.type: charm
Copied!
1
$ kubectl create -f config.yaml
2
configmap "special-config" created
Copied!

ConfigMap 使用

ConfigMap 可以通过三种方式在 Pod 中使用,三种分别方式为:设置环境变量、设置容器命令行参数以及在 Volume 中直接挂载文件或目录。
注意
    ConfigMap 必须在 Pod 引用它之前创建
    使用 envFrom 时,将会自动忽略无效的键
    Pod 只能使用同一个命名空间内的 ConfigMap
首先创建 ConfigMap:
1
$ kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm
2
$ kubectl create configmap env-config --from-literal=log_level=INFO
Copied!

用作环境变量

1
apiVersion: v1
2
kind: Pod
3
metadata:
4
name: 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: special-config
15
key: special.how
16
- name: SPECIAL_TYPE_KEY
17
valueFrom:
18
configMapKeyRef:
19
name: special-config
20
key: special.type
21
envFrom:
22
- configMapRef:
23
name: env-config
24
restartPolicy: Never
Copied!
当 Pod 结束后会输出
1
SPECIAL_LEVEL_KEY=very
2
SPECIAL_TYPE_KEY=charm
3
log_level=INFO
Copied!

用作命令行参数

将 ConfigMap 用作命令行参数时,需要先把 ConfigMap 的数据保存在环境变量中,然后通过 $(VAR_NAME) 的方式引用环境变量.
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", "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.how
16
- name: SPECIAL_TYPE_KEY
17
valueFrom:
18
configMapKeyRef:
19
name: special-config
20
key: special.type
21
restartPolicy: Never
Copied!
当 Pod 结束后会输出
1
very charm
Copied!

使用 volume 将 ConfigMap 作为文件或目录直接挂载

将创建的 ConfigMap 直接挂载至 Pod 的 / etc/config 目录下,其中每一个 key-value 键值对都会生成一个文件,key 为文件名,value 为内容
1
apiVersion: v1
2
kind: Pod
3
metadata:
4
name: vol-test-pod
5
spec:
6
containers:
7
- name: test-container
8
image: gcr.io/google_containers/busybox
9
command: ["/bin/sh", "-c", "cat /etc/config/special.how"]
10
volumeMounts:
11
- name: config-volume
12
mountPath: /etc/config
13
volumes:
14
- name: config-volume
15
configMap:
16
name: special-config
17
restartPolicy: Never
Copied!
当 Pod 结束后会输出
1
very
Copied!
将创建的 ConfigMap 中 special.how 这个 key 挂载到 / etc/config 目录下的一个相对路径 / keys/special.level。如果存在同名文件,直接覆盖。其他的 key 不挂载
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","cat /etc/config/keys/special.level"]
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.how
19
path: keys/special.level
20
restartPolicy: Never
Copied!
当 Pod 结束后会输出
1
very
Copied!
ConfigMap 支持同一个目录下挂载多个 key 和多个目录。例如下面将 special.how 和 special.type 通过挂载到 / etc/config 下。并且还将 special.how 同时挂载到 / etc/config2 下。
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","sleep 36000"]
10
volumeMounts:
11
- name: config-volume
12
mountPath: /etc/config
13
- name: config-volume2
14
mountPath: /etc/config2
15
volumes:
16
- name: config-volume
17
configMap:
18
name: special-config
19
items:
20
- key: special.how
21
path: keys/special.level
22
- key: special.type
23
path: keys/special.type
24
- name: config-volume2
25
configMap:
26
name: special-config
27
items:
28
- key: special.how
29
path: keys/special.level
30
restartPolicy: Never
Copied!
1
# ls /etc/config/keys/
2
special.level special.type
3
# ls /etc/config2/keys/
4
special.level
5
# cat /etc/config/keys/special.level
6
very
7
# cat /etc/config/keys/special.type
8
charm
Copied!

使用 subpath 将 ConfigMap 作为单独的文件挂载到目录

在一般情况下 configmap 挂载文件时,会先覆盖掉挂载目录,然后再将 congfigmap 中的内容作为文件挂载进行。如果想不对原来的文件夹下的文件造成覆盖,只是将 configmap 中的每个 key,按照文件的方式挂载到目录下,可以使用 subpath 参数。
1
apiVersion: v1
2
kind: Pod
3
metadata:
4
name: dapi-test-pod
5
spec:
6
containers:
7
- name: test-container
8
image: nginx
9
command: ["/bin/sh","-c","sleep 36000"]
10
volumeMounts:
11
- name: config-volume
12
mountPath: /etc/nginx/special.how
13
subPath: special.how
14
volumes:
15
- name: config-volume
16
configMap:
17
name: special-config
18
items:
19
- key: special.how
20
path: special.how
21
restartPolicy: Never
Copied!
1
[email protected]:/# ls /etc/nginx/
2
conf.d fastcgi_params koi-utf koi-win mime.types modules nginx.conf scgi_params special.how uwsgi_params win-utf
3
[email protected]:/# cat /etc/nginx/special.how
4
very
Copied!

不可变 ConfigMap

不可变 ConfigMap 在 v1.21.0 进入稳定版本。
当集群包含大量 ConfigMap 和 Secret 时,大量的 watch 事件会急剧增加 kube-apiserver 的负载,并会导致错误配置过快传播到整个集群。在这种情况中,给不需要经常修改的 ConfigMap 和 Secret 设置 immutable: true 就可以避免类似的问题。
不可变 ConfigMap 的好处包括:
    保护应用,使之免受意外更新所带来的负面影响。
    通过大幅降低对 kube-apiserver 的压力提升集群性能,这是因为 Kubernetes 会关闭不可变 ConfigMap 的监视操作。
1
apiVersion: v1
2
kind: ConfigMap
3
metadata:
4
...
5
data:
6
...
7
immutable: true
Copied!

参考文档

最近更新 6mo ago