应用程序的运行可能会依赖一些配置,而这些配置又是可能会随着需求产生变化的,如果我们的应用程序架构不是应用和配置分离的,那么就会存在当我们需要去修改某些配置项的属性时需要重新构建镜像文件的窘境。现在,ConfigMap组件可以很好的帮助我们实现应用和配置分离,避免因为修改配置项而重新构建镜像。
ConfigMap 用于保存配置数据的键值对,可以用来保存单个属性,也可以用来保存配置文件。ConfigMap 跟 Secret 很类似,但它可以更方便地处理不包含敏感信息的字符串。
Kubernetes 版本 | Core API 版本 |
v1.5+ | core/v1 |
可以使用 kubectl create configmap
从文件、目录或者 key-value 字符串创建等创建 ConfigMap。也可以通过 kubectl create -f file
创建。
$ kubectl create configmap special-config --from-literal=special.how=veryconfigmap "special-config" created$ kubectl get configmap special-config -o go-template='{{.data}}'map[special.how:very]
$ echo -e "a=b\nc=d" | tee config.enva=bc=d$ kubectl create configmap special-config --from-env-file=config.envconfigmap "special-config" created$ kubectl get configmap special-config -o go-template='{{.data}}'map[a:b c:d]
$ mkdir config$ echo a>config/a$ echo b>config/b$ kubectl create configmap special-config --from-file=config/configmap "special-config" created$ kubectl get configmap special-config -o go-template='{{.data}}'map[a:ab:b]
apiVersion: v1kind: ConfigMapmetadata:name: special-confignamespace: defaultdata:special.how: veryspecial.type: charm
$ kubectl create -f config.yamlconfigmap "special-config" created
ConfigMap 可以通过三种方式在 Pod 中使用,三种分别方式为:设置环境变量、设置容器命令行参数以及在 Volume 中直接挂载文件或目录。
注意
ConfigMap 必须在 Pod 引用它之前创建
使用
envFrom
时,将会自动忽略无效的键Pod 只能使用同一个命名空间内的 ConfigMap
首先创建 ConfigMap:
$ kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm$ kubectl create configmap env-config --from-literal=log_level=INFO
apiVersion: v1kind: Podmetadata:name: test-podspec:containers:- name: test-containerimage: gcr.io/google_containers/busyboxcommand: ["/bin/sh", "-c", "env"]env:- name: SPECIAL_LEVEL_KEYvalueFrom:configMapKeyRef:name: special-configkey: special.how- name: SPECIAL_TYPE_KEYvalueFrom:configMapKeyRef:name: special-configkey: special.typeenvFrom:- configMapRef:name: env-configrestartPolicy: Never
当 Pod 结束后会输出
SPECIAL_LEVEL_KEY=verySPECIAL_TYPE_KEY=charmlog_level=INFO
将 ConfigMap 用作命令行参数时,需要先把 ConfigMap 的数据保存在环境变量中,然后通过 $(VAR_NAME)
的方式引用环境变量.
apiVersion: v1kind: Podmetadata:name: dapi-test-podspec:containers:- name: test-containerimage: gcr.io/google_containers/busyboxcommand: ["/bin/sh", "-c", "echo $(SPECIAL_LEVEL_KEY) $(SPECIAL_TYPE_KEY)" ]env:- name: SPECIAL_LEVEL_KEYvalueFrom:configMapKeyRef:name: special-configkey: special.how- name: SPECIAL_TYPE_KEYvalueFrom:configMapKeyRef:name: special-configkey: special.typerestartPolicy: Never
当 Pod 结束后会输出
very charm
将创建的 ConfigMap 直接挂载至 Pod 的 / etc/config 目录下,其中每一个 key-value 键值对都会生成一个文件,key 为文件名,value 为内容
apiVersion: v1kind: Podmetadata:name: vol-test-podspec:containers:- name: test-containerimage: gcr.io/google_containers/busyboxcommand: ["/bin/sh", "-c", "cat /etc/config/special.how"]volumeMounts:- name: config-volumemountPath: /etc/configvolumes:- name: config-volumeconfigMap:name: special-configrestartPolicy: Never
当 Pod 结束后会输出
very
将创建的 ConfigMap 中 special.how 这个 key 挂载到 / etc/config 目录下的一个相对路径 / keys/special.level。如果存在同名文件,直接覆盖。其他的 key 不挂载
apiVersion: v1kind: Podmetadata:name: dapi-test-podspec:containers:- name: test-containerimage: gcr.io/google_containers/busyboxcommand: ["/bin/sh","-c","cat /etc/config/keys/special.level"]volumeMounts:- name: config-volumemountPath: /etc/configvolumes:- name: config-volumeconfigMap:name: special-configitems:- key: special.howpath: keys/special.levelrestartPolicy: Never
当 Pod 结束后会输出
very
ConfigMap 支持同一个目录下挂载多个 key 和多个目录。例如下面将 special.how 和 special.type 通过挂载到 / etc/config 下。并且还将 special.how 同时挂载到 / etc/config2 下。
apiVersion: v1kind: Podmetadata:name: dapi-test-podspec:containers:- name: test-containerimage: gcr.io/google_containers/busyboxcommand: ["/bin/sh","-c","sleep 36000"]volumeMounts:- name: config-volumemountPath: /etc/config- name: config-volume2mountPath: /etc/config2volumes:- name: config-volumeconfigMap:name: special-configitems:- key: special.howpath: keys/special.level- key: special.typepath: keys/special.type- name: config-volume2configMap:name: special-configitems:- key: special.howpath: keys/special.levelrestartPolicy: Never
# ls /etc/config/keys/special.level special.type# ls /etc/config2/keys/special.level# cat /etc/config/keys/special.levelvery# cat /etc/config/keys/special.typecharm
在一般情况下 configmap 挂载文件时,会先覆盖掉挂载目录,然后再将 congfigmap 中的内容作为文件挂载进行。如果想不对原来的文件夹下的文件造成覆盖,只是将 configmap 中的每个 key,按照文件的方式挂载到目录下,可以使用 subpath 参数。
apiVersion: v1kind: Podmetadata:name: dapi-test-podspec:containers:- name: test-containerimage: nginxcommand: ["/bin/sh","-c","sleep 36000"]volumeMounts:- name: config-volumemountPath: /etc/nginx/special.howsubPath: special.howvolumes:- name: config-volumeconfigMap:name: special-configitems:- key: special.howpath: special.howrestartPolicy: Never
[email protected]:/# ls /etc/nginx/conf.d fastcgi_params koi-utf koi-win mime.types modules nginx.conf scgi_params special.how uwsgi_params win-utf[email protected]:/# cat /etc/nginx/special.howvery
参考文档: