k8s -- ConfigMap

Posted 2023-05-07

参考技术A

ConfigMap顾名思义，是用于保存配置数据的键值对，可以用来保存单个属性，也可以保存配置文件。Secret可以为Pod提供密码、Token、私钥等敏感数据；对于一些非敏感数据，比如应用的配置信息，则可以使用ConfigMap。

ConfigMap的创建和使用方式与Secret非常类似，主要的不同是以明文的形式存放

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

上面的命令创建了一个名为special-config，拥有一条key为special.how，value为very的键值对数据。

上面的命令从一个env文件读取键值对，然后存入一个名为special-config的ConfigMap中。

上面的命令读取config目录下的所有文件，以文件名为key，文件内容为value，存入名为special-config的ConfigMap中。

Pod可以通过三种方式来使用ConfigMap，分别为：

注意！！

首先创建两个ConfigMap，分别名为special-config和env-config：

然后以环境变量方式引用：

当pod运行结束后，它的输出如下：

将ConfigMap用作命令行参数时，需要先把ConfigMap的数据保存在环境变量中，然后通过$(VAR_NAME)的方式引用环境变量。

当pod运行结束后，它的输出如下：

将创建的ConfigMap直接挂载至Pod的/etc/config目录下，其中每一个key-value键值对都会生成一个文件，key为文件名，value为内容。

当Pod结束后会输出：

将创建的ConfigMap中special.how这个key挂载到/etc/config目录下的一个相对路径/keys/special.level。如果存在同名文件，直接覆盖。其他的key不挂载。

当Pod结束后会输出：

在一般情况下 configmap 挂载文件时，会先覆盖掉挂载目录，然后再将 congfigmap 中的内容作为文件挂载进行。如果想不对原来的文件夹下的文件造成覆盖，只是将 configmap 中的每个 key，按照文件的方式挂载到目录下，可以使用 subpath 参数。

Pod 配置管理：configMap

文章目录

• • ConfigMap概述
  • 创建 ConfigMap 资源对象
  • • 通过 YAML 文件方式创建
  • 在 pod 中使用 ConfigMap
  • • 通过环境变量使用 ConfigMap
    • 通过 volumeMounts 使用 ConfigMap
  • 使用 ConfigMap 注意事项

ConfigMap概述

ConfigMap 以一个或多个 key:value 的形式保存在 kubernetes 系统中供应用使用，既可以用于表示一个变量的值，也可以用于表示一个完整配置文件的内容。

创建 ConfigMap 资源对象

通过 YAML 文件方式创建

下面的例子展示了将几个应用所需的变量定义为 ConfigMap 的用法：

apiVersion: v1
kind: ConfigMap
metadate: 
  name: cm-appvars
data:
  apploglevel: info
  appdatadir: /var/data

---

下面的例子展示了将两个配置文件 server.xml 和 logging.properties 定义为 ConfigMap 的用法，设置 Key 为配置文件的别名，value 则是配置文件的全部文本内容。

apiVersion: v1
kind: ConfigMap
metadate: 
  name: cm-appvars2
data:
  key-serverxml: |
    123
    456
    789
  key-loggingproperties: "
    987
    654
    321
    "

---

在 pod 中使用 ConfigMap

通过环境变量使用 ConfigMap

apiVersion: v1
kind: Pod
metadate:
  name: cm-test-pod
spec:
  containers:
  - name: cm-test
    image: busybox
    command: [ "/bin/sh", "-c", "env | grep APP" ]
    env:
    - name: APPLOGLEVEL	# 定义环境变量的名称
      valueFrom:
        configMapKeyRef:
          name: cm-appvars	# 取自cm-appvars
          key: apploglevel	# 取那个 configMap 的这个 data
    - name: APPDATADIR
      valueFrom:
        configMapKeyRef:
          name: cm-appvars
          key: appdatadir

部署了 pod 之后可以通过：

kubectl logs pod/cm-test-pod

查看运行日志（由于我的 k8s 集群崩了，所以我不想再搭建了）。

---

kubernetes 从 1.6 版本开始引入了一个新字段：envFrom，实现了在 Pod 环境中将 ConfigMap（Secret 也可以） 中所有定义的 key=value 自动生成环境变量。

apiVersion: v1
kind: Pod
metadate:
  name: cm-test-pod
spec:
  containers:
  - name: cm-test
    image: busybox
    command: [ "/bin/sh", "-c", "env | grep APP" ]
    envFrom:
    - configMapRef:
      name: cm-appvars	# 根据 cm-appvars 中的 key=value 自动生成环境变量

环境变量的命名受 POSIX 命名规范约束，不能以数字开头。如果包含非法字符，系统将跳过该条件变量的创建，并记录一个 event 来提示环境变量无法生成，但不阻止 Pod 的启动。

---

通过 volumeMounts 使用 ConfigMap

apiVersion: v1
kind: Pod
metadate:
  name: cm-test-pod
spec:
  containers:
  - name: cm-test
    image: busybox
    command: [ "/bin/sh", "-c", "ls /configmap" ]
    volumeMounts: 
    - name: serverxml	# 引用 volume 的名称
      mountPath: /configmap	# 挂载到容器内部的目录
  volumes:
  - name: serverxml	# 定义 volume 名称
    configMap:
      name: cm-appvars2	# 使用cm-appvars2
      items:	# 选择几项
      - key: key-serverxml
        path: server.xml	# 将 server.xml 文件名进行挂载
      - key: key-loggingproperties
        path: logging.properties

如果在引用 ConfigMap 的时候不指定 items，那就是全选选中 ConfigMap 中 data 的所有 key-value。

apiVersion: v1
kind: Pod
metadate:
  name: cm-test-pod
spec:
  containers:
  - name: cm-test
    image: busybox
    command: [ "/bin/sh", "-c", "ls /configmap" ]
    volumeMounts: 
    - name: serverxml	# 引用 volume 的名称
      mountPath: /configmap	# 挂载到容器内部的目录
  volumes:
  - name: serverxml	# 定义 volume 名称
    configMap:
      name: cm-appvars2	# 使用cm-appvars2

---

使用 ConfigMap 注意事项

1、ConfigMap 必须要在 pod 之前创建出来
2、注意无效事项，在 describe 中不一定是报错，但是 pod 启动失败不一定不是因为这个不是报错的原因
3、ConfigMap 受命名空间限制，只能被同空间的 pod 引用
4、无法用于 静态 pod