ConfigMaps
ConfigMap 是一种 API 对象,用来将非机密性的数据保存到键值对中。使用时, Pod 可以将其用作环境变量、命令行参数或者存储卷中的配置文件。
ConfigMap 将你的环境配置信息和容器镜像解耦,便于应用配置的修改。
在实际的项目中,开发人员是不应该关心一些配置信息的,比如数据库的地址、用户名、密码等。
ConfigMap 对象
ConfigMap 是一个让你可以存储其他对象所需要使用的配置的 API 对象。 和其他 Kubernetes 对象都有一个 spec 不同的是,ConfigMap 使用 data 和 binaryData 字段。这些字段能够接收键-值对作为其取值。data 和 binaryData 字段都是可选的。data 字段设计用来保存 UTF-8 字符串,而 binaryData 则被设计用来保存二进制数据作为 base64 编码的字串。
ConfigMap 的名字必须是一个合法的 DNS 子域名。
data 或 binaryData 字段下面的每个键的名称都必须由字母数字字符或者 -、_ 或 . 组成。在 data 下保存的键名不可以与在 binaryData 下出现的键名有重叠。
从 v1.19 开始,可以添加一个 immutable 字段到 ConfigMap 定义中, 创建不可变更的 ConfigMap。
创建ConfigMap 资源
创建ConfigMap对象的方法有两种
- 命令式命令
# 字面量
kubectl create configmap NAME --from-literal=key1=value1 --from-literal=key2=value2
# 从文件加载
kubectl create configmap NAME --from-file=[key=]/PATH/TO/FILE
# 从目录加载,在这种情况下,kubectl 会为文件夹中的每个文件单独创建条目,仅限于那些文件名可作为合法 ConfigMap 键名的文件
kubectl create configmap NAME --from-file=[key=]/PATH/TO/DIR/
- 配置文件
命令式:kubectl create -f
声明式:kubectl apply -f
提示:基于文件内容生成时,可以使用命令式命令以dry-run模式生成并保存
kubectl get cm -n kube-system
apiVersion: v1
kind: ConfigMap
metadata:
name: coredns
namespace: kube-system
data:
Corefile: |
.:53 {
errors
health {
lameduck 5s
}
ready
kubernetes cluster.local in-addr.arpa ip6.arpa {
pods insecure
fallthrough in-addr.arpa ip6.arpa ttl 30
}
prometheus :9153
forward . /etc/resolv.conf {
max_concurrent 1000
}
cache 30
loop
reload
loadbalance
}
# 命令式命令示例:
kubectl create configmap nginx-confs --from-file=./nginx-conf.d/myserver.conf --from-file=status.cfg=./nginx-conf.d/myserver-status.cfg
# 配置文件
apiVersion: v1
kind: ConfigMap
metadata:
name: nginx-confs
namespace: default
data:
status.cfg: |
location /nginx-status {
stub_status on;
access_log off;
}
myserver.conf: |
server {
listen 8080;
server_name www.ik8s.io;
include /etc/nginx/conf.d/myserver-*.cfg;
location / {
root /usr/share/nginx/html;
}
}
ConfigMaps 和 Pods
前提:Pod 和 ConfigMap 必须要在同一个 namespace 中。
Pod 可以有以下四种方式来引用一个 ConfigMap:
- 在容器命令和参数内
- 容器的环境变量
- 在只读卷里面添加一个文件,让应用来读取
- 编写代码在 Pod 中运行,使用 Kubernetes API 来读取 ConfigMap
这些不同的方法适用于不同的数据使用方式。 对前三个方法,kubelet 使用 ConfigMap 中的数据在 Pod 中启动容器。
第四种方法意味着你必须编写代码才能读取 ConfigMap 和它的数据。然而, 由于你是直接使用 Kubernetes API,因此只要 ConfigMap 发生更改, 你的应用就能够通过订阅来获取更新,并且在这样的情况发生的时候做出反应。 通过直接进入 Kubernetes API,这个技术也可以让你能够获取到不同的名字空间里的 ConfigMap。
下面是一个 ConfigMap 的示例:
apiVersion: v1
kind: ConfigMap
metadata:
name: cm-demo
namespace: default
data:
# 类属性键;每一个键都映射到一个简单的值
DBHOST: "192.168.100.100"
DBNAME: "root"
在 Pod 中通过环境变量引用
apiVersion: v1
kind: Pod
metadata:
name: my-pod
namespace: default
spec:
containers:
- name: my-container
image: nginx # 这里使用 nginx 作为示例,实际使用时应替换为需要的镜像
env:
# 定义环境变量
- name: DBHOST # 请注意这里和 ConfigMap 中的键名是不一样的
valueFrom:
configMapKeyRef:
name: cm-demo # 这个值来自 ConfigMap
key: DBHOST # 需要取值的键
- name: DBNAME
valueFrom:
configMapKeyRef:
name: cm-demo
key: DBNAME
restartPolicy: Always
也可以直接将一整个 ConfigMap 直接引用到 Pod 中。
apiVersion: v1
kind: Pod
metadata:
name: my-pod
namespace: default
spec:
containers:
- name: my-container
image: nginx # 这里使用 nginx 作为示例,实际使用时应替换为需要的镜像
envFrom:
- configMapRef:
name: cm-demo
restartPolicy: Always
在 Pod 中将 ConfigMap 当做文件使用
要在一个 Pod 的存储卷中使用 ConfigMap:
- 创建一个 ConfigMap 对象或者使用现有的 ConfigMap 对象。多个 Pod 可以引用同一个 ConfigMap。
- 修改 Pod 定义,在
spec.volumes[]下添加一个卷。 为该卷设置任意名称,之后将spec.volumes[].configMap.name字段设置为对你的 ConfigMap 对象的引用。 - 为每个需要该 ConfigMap 的容器添加一个
.spec.containers[].volumeMounts[]。 设置.spec.containers[].volumeMounts[].readOnly=true并将.spec.containers[].volumeMounts[].mountPath设置为一个未使用的目录名, ConfigMap 的内容将出现在该目录中。 - 更改你的镜像或者命令行,以便程序能够从该目录中查找文件。ConfigMap 中的每个
data键会变成mountPath下面的一个文件名。
apiVersion: v1
kind: Pod
metadata:
name: mypod
namespace: default
spec:
containers:
- name: mypod
image: redis
volumeMounts:
- name: foo
mountPath: "/etc/foo"
readOnly: true
volumes:
- name: foo
configMap:
name: cm-demo
将 ConfigMap 当做文件的情况下,如果 ConfigMap 中的内容发生了变化,在一定时间后,会自动同步到 Pod 中。更新的时间跨度可能与 kubelet 的同步周期加上高速缓存的传播延迟相等。 这里的传播延迟取决于所选的高速缓存类型 (分别对应 watch 操作的传播延迟、高速缓存的 TTL 时长或者 0)。
以环境变量方式使用的 ConfigMap 数据不会被自动更新。 更新这些数据需要重新启动 Pod。
示例
apiVersion: v1
kind: ConfigMap
metadata:
name: pg-init-script
......
data:
CreateDB.sql: |-
CREATE TABLE text (
id serial PRIMARY KEY,
text VARCHAR ( 100 ) UNIQUE NOT NULL
);
这段 ConfigMap 主要描述了两个重要的信息。首先,ConfigMap 的名称为 pg-init-script,它是这段 ConfigMap 名称标识。其次,data 字段指定了 Key 和 Value 键值对,在这个例子中,CreateDB.sql 实际上是 Key,Value 值是一段 SQL 代码,这段 SQL 代码非常简单,它创建一个 text 表,并定义了 id 和 text 字段。
这段 ConfigMap 其实就可以认为是业务的配置文件,当我们将这段 ConfigMap 应用到集群之后,就可以在工作负载中进行引用了。引用的方式可以参考示例应用 Postgres Deployment:
apiVersion: apps/v1
kind: Deployment
metadata:
name: Postgres
......
spec:
......
template:
......
spec:
containers:
- name: Postgres
image: Postgres
volumeMounts:
- name: sqlscript
mountPath: /docker-entrypoint-initdb.d
......
volumes:
- name: sqlscript
configMap:
name: pg-init-script
容器的 /docker-entrypoint-initdb.d 目录将会出现 CreateDB.sql 文件,内容是 ConfigMap 的 SQL 语句,这个文件是通过 ConfigMap 挂载的方式“动态注入”到容器内的。