概念
ConfigMap是一种 API 对象,使用时, Pods 可以将其用作环境变量、命令行参数或者存储卷中的配置文件。ConfigMap将配置和Pod解耦,更易于配置文件的更改和管理。ConfigMap 并不提供保密或者加密功能。 如果你想存储的数据是机密的,请使用Secret。
模板
ConfigMap 使用 data 和 binaryData 字段。这些字段能够接收键-值对作为其取值。data 和 binaryData 字段都是可选的。
- data 字段设计用来保存 UTF-8 字符串,指定文件、目录或者键值对。
- binaryData 则被设计用来保存二进制数据作为 base64 编码的字串。
由于一般命令行指定目录或文件,所以没有yaml模板。
从 v1.19 开始,你可以添加一个 immutable 字段到 ConfigMap 定义中, 创建不可变更的 ConfigMap。
实战
创建
基于目录
命令
# 创建本地目录 mkdir configmap # 将示例文件下载到 `configmap` 目录 wget https://kubernetes.io/examples/configmap/game.properties -O configmap/game.properties wget https://kubernetes.io/examples/configmap/ui.properties -O configmap/ui.properties # 创建 configmap kubectl create configmap -n killer game-config --from-file=configmap/
结果
查看一下下载的文件的内容
查看下configmap
命令
kubectl get configmap -n killer
结果
apiVersion: v1 items: - apiVersion: v1 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 kind: ConfigMap metadata: creationTimestamp: "2022-07-10T18:02:16Z" name: game-config namespace: killer resourceVersion: "330866" selfLink: /api/v1/namespaces/killer/configmaps/game-config uid: a9551dbc-f42b-47c0-b44d-5b80256b7ff1 kind: List metadata: resourceVersion: "" selfLink: ""
基于文件
命令
kubectl create configmap -n killer ui-config --from-file=configmap/ui.properties
结果
创建环境变量
game-env-file.properties内容如下:
enemies=aliens
lives=3
allowed=“true”
命令
kubectl create configmap game-config-env-file -n killer --from-env-file=configmap/game-env-file.properties
结果
从 Kubernetes 1.23 版本开始,kubectl 支持多次指定 --from-env-file 参数来从多个数据源创建 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
还有通过生成器和字面值创建configmap,由于一般配置比较多,还是使用目录或文件更方便,这里就不展示了。
使用
环境变量
使用 envFrom 将所有 ConfigMap 的数据定义为容器环境变量,ConfigMap 中的键成为 Pod 中的环境变量名称。
命令
env-test.yaml文件内容如下:
apiVersion: v1 kind: Pod metadata: name: env-test-pod spec: containers: - name: env-test-pod image: busybox imagePullPolicy: IfNotPresent command: [ "/bin/sh", "-c", "env" ] envFrom: - configMapRef: name: game-config-env-file restartPolicy: Never
结果
可以看到刚才的文件中的键值对确实成为了Pod中的环境变量。
挂载
覆盖
注意:这种挂载方式会覆盖目录
busybox的/usr下有sbin目录
命令
volume-test.yaml文件内容如下:
apiVersion: v1 kind: Pod metadata: name: volume-test-pod spec: containers: - name: test-container image: busybox imagePullPolicy: IfNotPresent command: [ "/bin/sh","-c","cd /usr && ls && cat /usr/keys" ] volumeMounts: - name: config-volume mountPath: /usr volumes: - name: config-volume configMap: name: game-config items: - key: game.properties path: keys restartPolicy: Never
kubectl create -f volume-test.yaml -n killer
结果
可以看到,只有keys文件,没有sbin目录了。
subPath
如果你想挂载的目录下有其他的目录或文件,可以使用这种方式。
命令
subpath-test.yaml
apiVersion: v1 kind: Pod metadata: name: subpath-test-pod spec: containers: - name: test-container image: busybox imagePullPolicy: IfNotPresent command: [ "/bin/sh","-c","cd /usr && ls && cat /usr/keys" ] volumeMounts: - name: config-volume mountPath: /usr/keys subPath: usr/keys volumes: - name: config-volume configMap: name: game-config items: - key: game.properties path: usr/keys restartPolicy: Never
注意:前面不要加**/**
kubectl create -f subpath-test.yaml -n killer
结果
更新
以subPath方式挂载时,configmap更新,容器不会更新。
解决方式,一是把文件挂载到一个空目录,然后使用ln链接过去。而是如果你的k8s版本>=1.9,可以使用参考中的reloader。
edit
命令
kubectl edit cm ui-config -n killer
结果
replace
命令
先导出yaml
kubectl get cm ui-config -n killer -o yaml > ui-config.yaml
修改内容,将red改为black
使用replace命令
kubectl replace -f ui-config.yaml -n killer
结果
删除
命令
kubectl delete cm ui-config -n killer
结果
ConfigMap 注意要点
- ConfigMap 文件的大小。虽然说 ConfigMap 文件没有大小限制,但是在 ETCD 里面,数据的写入是有大小限制的,现在是限制在1MB 以内;
- pod 引入 ConfigMap 的时候,必须是相同的 Namespace中的 ConfigMap,前面其实可以看到,ConfigMap.metadata 里面是有 namespace 字段的;
- pod 引用的ConfigMap,假如这个 ConfigMap 不存在,那么这个 pod 是无法创建成功的,其实这也表示在创建 pod 前,必须先把要引用的 ConfigMap 创建好;
- 使用 envFrom 的方式。把 ConfigMap 里面所有的信息导入成环境变量时,如果 ConfigMap 里有些 key 是无效的,比如 key 的名字里面带有数字,那么这个环境变量其实是不会注入容器的,它会被忽略。但是这个 pod 本身是可以创建的。这个和第三点是不一样的方式,是 ConfigMap 文件存在基础上,整体导入成环境变量的一种形式。
- 什么样的 pod 才能使用 ConfigMap?这里只有通过 K8s api 创建的 pod 才能使用 ConfigMap,比如说通过用命令行 kubectl 来创建的 pod,肯定是可以使用 ConfigMap 的,但其他方式创建的 pod,比如说 kubelet 通过 manifest 创建的 static pod,它是不能使用 ConfigMap 的。
- 热更新需要ln或者使用参考中的reloader
更多k8s相关内容,请看文章:k8s学习-思维导图与学习笔记
参考
更多k8s相关内容,请看文章:k8s学习-思维导图与学习笔记