ConfigMap

k8s 用 ConfigMap 以 key-value 的形式來儲存非敏感資料，提供 pod 讀取環境變數、命令參數或以 volume 讀取設定資料。

ConfigMap 主要是用來儲存設定參數類型小資料，若是要儲存大量資料應使用 volume 或是接資料庫。接下來以範例來看看 ConfigMap 的使用方式。

1. 定義 pod 所需環境變數
2. 在 pod 命令中讀取 ConfigMap
3. ConfigMap 加入 volume 中使用

定義 pod 所需環境變數

這邊使用兩個 ConfigMap、設定檔為 configmaps.yaml。

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

建立 ConfigMap。

kubectl create -f configmaps.yaml

configmap/special-config created
configmap/env-config created

查看 ConfigMap 內容。

kubectl get configmap

NAME               DATA   AGE
env-config         1      34s
kube-root-ca.crt   1      7d
special-config     1      34s

special-config

kubectl describe configmap special-config

Name:         special-config
Namespace:    default
Labels:       <none>
Annotations:  <none>

Data
====
special.how:
----
very

BinaryData
====

Events:  <none>

env-config。

kubectl describe configmap env-config
Name:         env-config
Namespace:    default
Labels:       <none>
Annotations:  <none>

Data
====
log_level:
----
INFO

BinaryData
====

Events:  <none>

在 pod 設定檔 pod-multiple-configmap-env-variable.yaml 中定義環境變數 SPECIAL_LEVEL_KEY 與 LOG_LEVEL。

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: registry.k8s.io/busybox
      command: [ "/bin/sh", "-c", "env" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.how
        - name: LOG_LEVEL
          valueFrom:
            configMapKeyRef:
              name: env-config
              key: log_level
  restartPolicy: Never

• 第一個 configMapKeyRef：定義參考使用的 ConfigMap(special-config)，底下的 name 則是 ConfigMap 的名稱，key 為 configMap 中的 special.how，即環境變數 SPECIAL_LEVEL_KEY 的值為 ConfigMap 中的 special.how 的 very
• 第二個 configMapKeyRef：定義參考使用的 ConfigMap(env-config)，環境變數 LOG_LEVEL 的值為 ConfigMap 中的 log_level 的 INFO

建立 pod。

kubectl create -f pod-multiple-configmap-env-variable.yaml

pod/dapi-test-pod created

在 pod 命令中讀取 ConfigMap

一開始先刪除剛才的 pod 跟 ConfigMap，--now 表示立即刪除 Pod。

kubectl delete pod dapi-test-pod --now

pod "dapi-test-pod" deleted

kubectl delete configmap special-config env-config --now

configmap "special-config" deleted
configmap "env-config" deleted

定義 configmap-multikeys.yaml。

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  SPECIAL_LEVEL: very
  SPECIAL_TYPE: charm

建立 ConfigMap。

kubectl create -f configmap-multikeys.yaml

configmap/special-config created

定義 pod pod-configmap-env-var-valueFrom.yaml。

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: registry.k8s.io/busybox
      command: [ "/bin/echo", "$(SPECIAL_LEVEL_KEY) $(SPECIAL_TYPE_KEY)" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: SPECIAL_LEVEL
        - name: SPECIAL_TYPE_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: SPECIAL_TYPE
  restartPolicy: Never

• 可以看到在 command 中的 $(SPECIAL_LEVEL_KEY) 與 $(SPECIAL_TYPE_KEY)，分別對應 special-config 這個 ConfigMap 中的 SPECIAL_LEVEL 與 SPECIAL_TYPE 值。

建立 pod。

kubectl create -f pod-configmap-env-var-valueFrom.yaml

pod/dapi-test-pod created

查看容器中 echo 的環境變數。

kubectl logs dapi-test-pod

very charm

刪除 pod。

kubectl delete pod dapi-test-pod --now

pod "dapi-test-pod" deleted

ConfigMap 加入 volume 中使用

建立 pod pod-configmap-volume.yaml。

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: registry.k8s.io/busybox
      command: [ "/bin/sh", "-c", "ls /etc/config/" ]
      volumeMounts:
      - name: config-volume
        mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap:
        name: special-config
  restartPolicy: Never

• 在 volumes 下使用 configMap，會將該 ConfigMap 加入到 volumeMounts 指定的 mountPath 目錄下。分別為 SPECIAL_LEVEL 和 SPECIAL_TYPE 檔案，待會會出書 pod 中容器的 log。

建立 pod。

kubectl create -f pod-configmap-volume.yaml

pod/dapi-test-pod created

查看輸出。

kubectl logs dapi-test-pod

SPECIAL_LEVEL
SPECIAL_TYPE

參考來源

1.Kubernetes - Configure a Pod to Use a ConfigMap Configure a Pod to Use a ConfigMap