Yin的笔记本

ConfigMap - 按照配置文件在容器中生成环境变量

2020-08-08 06:07:01 Kubernetes原理概念实操服务器运维Kubernetes对象

ConfigMap 允许您将配置文件与镜像文件分离，以使容器化的应用程序具有可移植性。

ConfigMap存在的主要意义是在容器中生成一系列环境变量而达到对容器进行配置的目的。

由于是生成环境变量，所以ConfigMap的输入以键值对为固定格式，后缀名一般为.properties。就像这样：

enemies=aliens
lives=3
enemies.cheat=true
enemies.cheat.level=noGoodRotten
secret.code.passphrase=UUDDLRLRBABAS
secret.code.allowed=true
secret.code.lives=30
1
2
3
4
5
6
7

# ConfigMap的查看

以yaml格式输出ConfigMap

kubectl get configmaps <map-name> -o yaml
1

# ConfigMap的创建

# 用指令创建ConfigMap

kubectl create configmap <map-name> <data-source>
1

其中， <map-name> 是要分配给 ConfigMap 的名称，<data-source> 是要从中提取数据的目录，文件或者文字值。

数据源对应于 ConfigMap 中的 key-value (键值对)

  • key = 您在命令行上提供的文件名或者密钥
  • value = 您在命令行上提供的文件内容或者文字值

# 直接在命令行指定ConfigMap

kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm
1

这个指令会生成：

kubectl get configmaps special-config -o yaml
1
apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2016-02-18T19:14:38Z
  name: special-config
  namespace: default
  resourceVersion: "651"
  selfLink: /api/v1/namespaces/default/configmaps/special-config
  uid: dadce046-d673-11e5-8cd0-68f728db1985
data:
  special.how: very
  special.type: charm
1
2
3
4
5
6
7
8
9
10
11
12

# 从文件创建ConfigMap

比如将开头那个配置文件保存为game.properties，那么我就可以从文件创建一个ConfigMap，例如命名为game-config：

kubectl create configmap game-config --from-file=./game.properties
1

# 从文件夹创建ConfigMap

比如我又有一个ui.properties的配置文件，我想将它与game.properties一起创建配置，那就可以把他们一起放在某个目录下，比如./conf，然后从文件夹创建ConfigMap：

kubectl create configmap game-config --from-file=./conf
1

上面的指令等效于：

kubectl create configmap game-config --from-file=./conf/game.properties --from-file=./conf/ui.properties
1

它们都生成如下ConfigMap：

kubectl get configmaps game-config -o yaml
1
apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2016-02-18T18:52:05Z
  name: game-config
  namespace: default
  resourceVersion: "516"
  selfLink: /api/v1/namespaces/default/configmaps/game-config
  uid: b4952dc3-d670-11e5-8cd0-68f728db1985
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
#注意上面game.properties和ui.properties后面的这个竖线“|”表面后面是一个字符串，不要把他当成键值对
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

可以看到game.properties和ui.properties一起生成了ConfigMap。

# 指定ConfigMap data中的key

当然，最终生成的data中配置文件的key是可以改变的：

kubectl create configmap game-config-1 --from-file=game-special-key=./conf/game.properties
1

它会生成如下ConfigMap：

kubectl get configmaps game-config-1 -o yaml
1
apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: 2016-02-18T18:54:22Z
  name: game-config-3
  namespace: default
  resourceVersion: "530"
  selfLink: /api/v1/namespaces/default/configmaps/game-config-3
  uid: 05f8da22-d671-11e5-8cd0-68f728db1985
data:
  game-special-key: |
    enemies=aliens
    lives=3
    enemies.cheat=true
    enemies.cheat.level=noGoodRotten
    secret.code.passphrase=UUDDLRLRBABAS
    secret.code.allowed=true
    secret.code.lives=30
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# configMapGenerator

configMapGenerator是一种固定格式的yaml文件，代替指令生成ConfigMap。

使用configMapGenerator文件生成 ConfigMap 对象的指令是：

kubectl apply -k <yaml文件或目录>
1

如果使用目录，则目录下的每个configMapGenerator文件都生成一个 ConfigMap。

# 直接在configMapGenerator指定ConfigMap

使用这个文件生成ConfigMap：

configMapGenerator:
- name: special-config-2
  literals:
  - special.how=very
  - special.type=charm
1
2
3
4
5

等效于：

kubectl create configmap special-config --from-literal=special.how=very --from-literal=special.type=charm
1

# configMapGenerator从文件创建ConfigMap

使用这个文件生成ConfigMap：

configMapGenerator:
- name: game-config-4
  files:
  - ./game.properties
1
2
3
4

等效于：

kubectl create configmap game-config --from-file=./game.properties
1

# 指定ConfigMap data中的key

使用这个文件生成ConfigMap：

configMapGenerator:
- name: game-config-5
  files:
  - game-special-key=./conf/game.properties
1
2
3
4

等效于：

kubectl create configmap game-config-1 --from-file=game-special-key=./conf/game.properties
1

# 用标准方式生成ConfigMap

标准方式就是《Kubernetes(k8s)对象》里面介绍的方式：

apiVersion: v1
kind: ConfigMap
metadata:
  name: <指定ConfigMap名称>
  namespace: <指定ConfigMap作用的namespace>
data:
  <ConfigMap数据>
1
2
3
4
5
6
7

例如：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  special.how: very
  special.type: charm
1
2
3
4
5
6
7
8

# ConfigMap的使用

# 使用 ConfigMap 生成环境变量

以两个ConfigMap为例：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  special.how: very
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: env-config
  namespace: default
data:
  log_level: INFO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 用 ConfigMap 中的value值定义容器环境变量

比如，若要令容器中的环境变量$SPECIAL_LEVEL_KEY值为special-config中的special.how定义值，并令$LOG_LEVEL值为env-config中的log_level定义值，那么应该：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      env:
        - name: SPECIAL_LEVEL_KEY #指定环境变量的键
          valueFrom: #指定其值从何而来
            configMapKeyRef: #指定其值来源于ConfigMap
              name: special-config #指定其值来源于ConfigMap中的special-config
              key: special.how #指定其值来源于ConfigMap中的special-config中的special.how
        - name: LOG_LEVEL #指定环境变量的键
          valueFrom: #指定其值从何而来
            configMapKeyRef: #指定其值来源于ConfigMap
              name: env-config #指定其值来源于ConfigMap中的env-config
              key: log_level #指定其值来源于ConfigMap中的env-config中的log_level
      ...
    ...
  ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 用 ConfigMap 定义容器环境变量

K8s当然也可以一次性将ConfigMap中的所有数据导入为容器的环境变量。比如，上面的Pod等同于：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  SPECIAL_LEVEL: very
  SPECIAL_TYPE: charm
---
apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      envFrom:
      - configMapRef:
          name: special-config
      ...
    ...
  ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# 使用存储在 ConfigMap 中的数据填充数据卷

# 直接用 ConfigMap 填充数据卷

将ConfigMap用volumes挂载到容器里面即是使用 ConfigMap 中的数据填充数据卷。在被填充的数据卷中，ConfigMap中所定义的data字段下的每一个键都会生成一个文件，文件内容即其值。

以这个ConfigMap为例：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

K8S可以使用ConfigMap填充数据卷：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      volumeMounts:
      - name: config-volume
        mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap: #指定填充所用的configMap
        name: special-config #指定填充所用的configMap名称
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

在这个容器中可以看到被填充的数据卷里面有两个文件，其内容为其在ConfigMap中的值：

$ ls /etc/config/
game.properties
ui.properties
$ cat /etc/config/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
$ cat /etc/config/ui.properties
color.good=purple
color.bad=yellow
allow.textmode=true
how.nice.to.look=fairlyNice
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 用 ConfigMap 填充数据卷的指定路径

还是上面那个例子。我想把game.properties填充到game文件里面，而把ui.properties填充到ui文件里面：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      volumeMounts:
      - name: config-volume
        mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap: #指定填充所用的configMap
        name: special-config #指定填充所用的configMap名称
        items:
        - key: game.properties
          path: game
        - key: ui.properties
          path: ui
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在这个容器中可以看到被填充的数据卷里面的两个文件的文件名和上面不一样了：

$ ls /etc/config/
game
ui
$ cat /etc/config/game
enemies=aliens
lives=3
enemies.cheat=true
enemies.cheat.level=noGoodRotten
secret.code.passphrase=UUDDLRLRBABAS
secret.code.allowed=true
secret.code.lives=30
$ cat /etc/config/ui
color.good=purple
color.bad=yellow
allow.textmode=true
how.nice.to.look=fairlyNice
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Comments Powered by GitHub & Vssue
Login with GitHub account to leave a comment

Loading comments...