很多應用程序需要一些配置通過組合的配置文件，命令行參數和環境變量。這些配置應該與鏡像內容分離以保持容器化應用程序的可移植性。ConfigMap API資源提供了將配置數據注入容器的機制，同時保持容器不受kubernetes的影響。ConfigMap可用于存儲細粒度信息如單個屬性，或粗粒度信息如整個配置文件或JSON對象。

ConfigMap概述

ConfigMap API資源保存配置數據的鍵值對，可以在pods中使用或者可以用于存儲系統組件的配置數據。ConfigMap類似于Secrets,但是旨在更方便的使用不包含敏感信息的字符串。

注意：ConfigMap不打算充當屬性文件的替換者。你可以認為類似于/etc目錄，以及Linux計算機上的文件。一個例子是從ConfigMap創建一個Kubernetes卷，其中ConfigMap的數據項變成一個新的文件。

例如下面的例子:

kind: ConfigMap
apiVersion: v1
metadata:
  creationTimestamp: 2016-02-18T19:14:38Z
  name: example-config
  namespace: default
data:
  example.property.1: hello
  example.property.2: world
  example.property.file: |-
    property.1=value-1
    property.2=value-2
    property.3=value-3

data字段包含配置信息。可以看到ConfigMap可以用于細粒度的單個屬性，或者是配置文件的內容。

配置數據在pods中有多種使用方式。ConfigMap有以下幾種使用方式：

1.填充環境變量的值

2.設置容器內的命令行參數

3.填充卷的配置文件

用戶和系統組建都可以在ConfigMap中存儲配置數據。

新建ConfigMap

可以使用kubectl create configmap 命令行非常容易的從字面值，文件或目錄中創建configmaps。

讓我們嘗試用不同的方式創建一個ConfigMap:

從目錄創建

比如說我們有一個目錄其中包含一些已經已經包含要填充ConfigMap數據的文件：

$ ls docs/user-guide/configmap/kubectl/
game.properties
ui.properties

$ cat docs/user-guide/configmap/kubectl/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 docs/user-guide/configmap/kubectl/ui.properties
color.good=purple
color.bad=yellow
allow.textmode=true
how.nice.to.look=fairlyNice

kubectl create configmap 可用于創建一個保存此目錄中每個文件內容的ConfigMap:

$ kubectl create configmap game-config --from-file=docs/user-guide/configmap/kubectl

當 --from-file指向一個目錄，每個目錄中的文件直接用于填充ConfigMap中的key,key的名稱是文件名稱，key的值是這個文件的內容。讓我們看看上面命令創建的ConfigMap：

$ kubectl describe configmaps game-config
Name:           game-config
Namespace:      default
Labels:         <none>
Annotations:    <none>

Data
====
game.properties:        158 bytes
ui.properties:          83 bytes

可以看到map中的兩個key是從我們指向的kubectl的目錄中的文件名創建的。因為這些建的內容可能很大，kubectl describe你只能看到他們key的名稱和大小。如果想看這些key的值，可以通過kubectl get獲取：

$ kubectl get configmaps game-config -o yaml

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: 2016-02-18T18:34:05Z
  name: game-config
  namespace: default
  resourceVersion: "407"
  selfLink: /api/v1/namespaces/default/configmaps/game-config
  uid: 30944725-d66e-11e5-8cd0-68f728db1985

從文件創建

也可以通過--from-file指定文件，并將他多次傳遞給kubectc。下面的命令和上面的示例產生相同的結果：

$ kubectl create configmap game-config-2 --from-file=docs/user-guide/configmap/kubectl/game.properties --from-file=docs/user-guide/configmap/kubectl/ui.properties

$ kubectl get configmaps game-config-2 -o yaml

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: 2016-02-18T18:52:05Z
  name: game-config-2
  namespace: default
  resourceVersion: "516"
  selfLink: /api/v1/namespaces/default/configmaps/game-config-2
  uid: b4952dc3-d670-11e5-8cd0-68f728db1985

我們可以通過key=value表達式為每個文件設置key：

--from-file=game-special-key=docs/user-guide/configmap/kubectl/game.properties：

$ kubectl create configmap game-config-3 --from-file=game-special-key=docs/user-guide/configmap/kubectl/game.properties

$ kubectl get configmaps game-config-3 -o yaml

apiVersion: v1
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
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

通過字面值創建

也可以通過kubectl create configmap創建ConfigMap使用字面值。--from-literal選項使用一個key=value語法，允許直接在命令行中直接提供字面值：

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

$ kubectl get configmaps special-config -o yaml

apiVersion: v1
data:
  special.how: very
  special.type: charm
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

pods使用ConfigMap

用例：在環境變量中使用ConfigMap

ConfigMap可用于填充各個環境變量或者整個使用。例如下面的例子：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  special.how: very
  special.type: charm

apiVersion: v1
kind: ConfigMap
metadata:
  name: env-config
  namespace: default
data:
  log_level: INFO

可以在pod中這樣使用ConfigMap的鍵：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: gcr.io/google_containers/busybox
      command: [ "/bin/sh", "-c", "env" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.how
        - name: SPECIAL_TYPE_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.type
      envFrom:
        - configMapRef:
            name: env-config
  restartPolicy: Never

當這個pod運行起來的時候，它輸出包含下面的行：

SPECIAL_LEVEL_KEY=very
SPECIAL_TYPE_KEY=charm
log_level=INFO

可選ConfigMap在環境變量中

有些情況環境變量不是總是需要。這些環境變量可以標記為可選的在pods：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: gcr.io/google_containers/busybox
      command: [ "/bin/sh", "-c", "env" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: a-config
              key: akey
              optional: true
  restartPolicy: Never

當這個pod運行，輸出是空的。

設置命令行參數用ConfigMap

ConfigMaps可以用于設置容器里面的命令行參數的值。這是使用Kubernetes替換$(value)語法完成的。考慮ConfigMap：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  special.how: very
  special.type: charm

為了把值注入到命令行，我們必須使用我們作為環境變量的鍵，例如上一個例子。我們可以參考在容器內命令行使用$(VAR_NAME)語法：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: gcr.io/google_containers/busybox
      command: [ "/bin/sh", "-c", "echo $(SPECIAL_LEVEL_KEY) $(SPECIAL_TYPE_KEY)" ]
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.how
        - name: SPECIAL_TYPE_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.type
  restartPolicy: Never

當pod運行起來的時候，從test-container容器的輸出會是：

very charm

用例：使用ConfigMap通過卷插件

ConfigMaps也可以在卷內使用。再次返回我們的示例：

apiVersion: v1
kind: ConfigMap
metadata:
  name: special-config
  namespace: default
data:
  special.how: very
  special.type: charm

在卷中使用ConfigMap我們有幾個不同的選項。最基礎的方式是填充卷文件，鍵值是文件名內容是鍵對應的值：

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

當這個pod運行起來，會輸出下面的內容：

very

我們還可以控制卷中的路徑通過ConfigMap鍵映射：

apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: gcr.io/google_containers/busybox
      command: [ "/bin/sh","-c","cat /etc/config/path/to/special-key" ]
      volumeMounts:
      - name: config-volume
        mountPath: /etc/config
  volumes:
    - name: config-volume
      configMap:
        name: special-config
        items:
        - key: special.how
          path: path/to/special-key
  restartPolicy: Never

當這個pod運行起來，會輸出下面：

very

映射key指定的路徑和權限

你可以在每個文件基礎上指定key映射的特定路徑和權限。Secrets用戶指南介紹語法。

可選ConfigMap通過卷插件

卷和文件也可以標記為可選。ConfigMap或指定的鍵不一定存在。將始終創建這些項目的掛載路徑。

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

當pod運行起來，輸出將是空。

真實的示例：配置Redis

讓我看一個真實示例：使用ConfigMap配置redis。加入我們想用推薦的配置注入redis作為緩存。redis的配置文件應該包含：

maxmemory 2mb
maxmemory-policy allkeys-lru

這個文件在docs/user-guide/configmap/redis，我們可以用下面的命令新建一個ConfigMap：

$ kubectl create configmap example-redis-config --from-file=docs/user-guide/configmap/redis/redis-config

$ kubectl get configmap example-redis-config -o yaml

apiVersion: v1
data:
  redis-config: |
    maxmemory 2mb
    maxmemory-policy allkeys-lru
kind: ConfigMap
metadata:
  creationTimestamp: 2016-03-30T18:14:41Z
  name: example-redis-config
  namespace: default
  resourceVersion: "24686"
  selfLink: /api/v1/namespaces/default/configmaps/example-redis-config
  uid: 460a2b6e-f6a3-11e5-8ae5-42010af00002

現在我們新建一個pod使用這個配置：

apiVersion: v1
kind: Pod
metadata:
  name: redis
spec:
  containers:
  - name: redis
    image: kubernetes/redis:v1
    env:
    - name: MASTER
      value: "true"
    ports:
    - containerPort: 6379
    resources:
      limits:
        cpu: "0.1"
    volumeMounts:
    - mountPath: /redis-master-data
      name: data
    - mountPath: /redis-master
      name: config
  volumes:
    - name: data
      emptyDir: {}
    - name: config
      configMap:
        name: example-redis-config
        items:
        - key: redis-config
          path: redis.conf

注意，這個pod有一個ConfigMap卷，它將example-redis-config ConfigMap的redis-config鍵的值放入一個名為redis.conf的文件中。這個卷是掛載到redis容器里面的/redis-master目錄里面，我們的配置文件在/redis-master/redis.conf，這個redis注解點在鏡像里面的配置文件。

$ kubectl create -f docs/user-guide/configmap/redis/redis-pod.yaml

運行kubectl exec進入到這個pod里面并運行redis-cli工具，可以檢查我們的配置是否正確應用：

$ kubectl exec -it redis redis-cli
127.0.0.1:6379> CONFIG GET maxmemory
1) "maxmemory"
2) "2097152"
127.0.0.1:6379> CONFIG GET maxmemory-policy
1) "maxmemory-policy"
2) "allkeys-lru"

限制

ConfigMap必須在pod消耗他之前創建，除非被標記為可選。對于不存在的ConfigMap將阻止它啟動。控制器可能被寫入以容忍丟失數據，可以個根據具體情況查看通過ConfigMap配置的各個組件。

通過configMapKeyRef引用命名ConfigMap中不存在的鍵將阻止他的啟動。

ConfigMaps用于填充環境變量通過envFrom,它們被認為具有無效的環境變量名稱的鍵將跳過這些鍵。該pod被允許啟動。將會有一個事件，原因是InvalidVariabelNames,該消息包含被跳過的無效的鍵的列表。該示例顯示一個pod它指的是 default/myconfig ConfigMap包含兩個無效的鍵,1badkey和2alsobad。

$ kubectl.sh get events
LASTSEEN   FIRSTSEEN   COUNT     NAME            KIND      SUBOBJECT                         TYPE      REASON
0s         0s          1         dapi-test-pod   Pod                                         Warning   InvalidEnvironmentVariableNames   kubelet, 127.0.0.1      Keys [1badkey, 2alsobad] from the EnvFrom configMap default/myconfig were skipped since they are considered invalid environment variable names.

ConfigMap駐留到namespace里面。他們可以被引用和pod相同的namespace。ConfigMap配額大小是一個計劃功能。

kubelet僅支持pod使用ConfigMap獲取從API server。這包括使用kubectl創建每個pod,或者間接通過副本控制器。