• ConfigMap
  • ConfigMap概览
  • 创建ConfigMaps
    • 使用目录创建
    • 使用文件创建
    • 使用字面值创建
  • Pod中使用ConfigMap

    ConfigMap

    其实ConfigMap功能在Kubernetes1.2版本的时候就有了,许多应用程序会从配置文件、命令行参数或环境变量中读取配置信息。这些配置信息需要与docker image解耦,你总不能每修改一个配置就重做一个image吧?ConfigMap API给我们提供了向容器中注入配置信息的机制,ConfigMap可以被用来保存单个属性,也可以用来保存整个配置文件或者JSON二进制大对象。

    ConfigMap概览

    ConfigMap API资源用来保存key-value pair配置数据,这个数据可以在pods里使用,或者被用来为像controller一样的系统组件存储配置数据。虽然ConfigMap跟Secrets类似,但是ConfigMap更方便的处理不含敏感信息的字符串。 注意:ConfigMaps不是属性配置文件的替代品。ConfigMaps只是作为多个properties文件的引用。你可以把它理解为Linux系统中的/etc目录,专门用来存储配置文件的目录。下面举个例子,使用ConfigMap配置来创建Kuberntes Volumes,ConfigMap中的每个data项都会成为一个新文件。

    1. kind: ConfigMap
    2. apiVersion: v1
    3. metadata:
    4. creationTimestamp: 2016-02-18T19:14:38Z
    5. name: example-config
    6. namespace: default
    7. data:
    8. example.property.1: hello
    9. example.property.2: world
    10. example.property.file: |-
    11. property.1=value-1
    12. property.2=value-2
    13. property.3=value-3

    data一栏包括了配置数据,ConfigMap可以被用来保存单个属性,也可以用来保存一个配置文件。 配置数据可以通过很多种方式在Pods里被使用。ConfigMaps可以被用来:

    1. 设置环境变量的值
    2. 在容器里设置命令行参数
    3. 在数据卷里面创建config文件

    用户和系统组件两者都可以在ConfigMap里面存储配置数据。

    其实不用看下面的文章,直接从kubectl create configmap -h的帮助信息中就可以对ConfigMap究竟如何创建略知一二了。

    1. Examples:
    2. # Create a new configmap named my-config based on folder bar
    3. kubectl create configmap my-config --from-file=path/to/bar
    4. # Create a new configmap named my-config with specified keys instead of file basenames on disk
    5. kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
    6. # Create a new configmap named my-config with key1=config1 and key2=config2
    7. kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2

    创建ConfigMaps

    可以使用该命令,用给定值、文件或目录来创建ConfigMap。

    1. kubectl create configmap

    使用目录创建

    比如我们已经有个了包含一些配置文件,其中包含了我们想要设置的ConfigMap的值:

    1. $ ls docs/user-guide/configmap/kubectl/
    2. game.properties
    3. ui.properties
    4. $ cat docs/user-guide/configmap/kubectl/game.properties
    5. enemies=aliens
    6. lives=3
    7. enemies.cheat=true
    8. enemies.cheat.level=noGoodRotten
    9. secret.code.passphrase=UUDDLRLRBABAS
    10. secret.code.allowed=true
    11. secret.code.lives=30
    12. $ cat docs/user-guide/configmap/kubectl/ui.properties
    13. color.good=purple
    14. color.bad=yellow
    15. allow.textmode=true
    16. how.nice.to.look=fairlyNice

    使用下面的命令可以创建一个包含目录中所有文件的ConfigMap。

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

    —from-file指定在目录下的所有文件都会被用在ConfigMap里面创建一个键值对,键的名字就是文件名,值就是文件的内容。

    让我们来看一下这个命令创建的ConfigMap:

    1. $ kubectl describe configmaps game-config
    2. Name: game-config
    3. Namespace: default
    4. Labels: <none>
    5. Annotations: <none>
    6. Data
    7. ====
    8. game.properties: 158 bytes
    9. ui.properties: 83 bytes

    我们可以看到那两个key是从kubectl指定的目录中的文件名。这些key的内容可能会很大,所以在kubectl describe的输出中,只能够看到键的名字和他们的大小。 如果想要看到键的值的话,可以使用kubectl get

    1. $ kubectl get configmaps game-config -o yaml

    我们以yaml格式输出配置。

    1. apiVersion: v1
    2. data:
    3. game.properties: |
    4. enemies=aliens
    5. lives=3
    6. enemies.cheat=true
    7. enemies.cheat.level=noGoodRotten
    8. secret.code.passphrase=UUDDLRLRBABAS
    9. secret.code.allowed=true
    10. secret.code.lives=30
    11. ui.properties: |
    12. color.good=purple
    13. color.bad=yellow
    14. allow.textmode=true
    15. how.nice.to.look=fairlyNice
    16. kind: ConfigMap
    17. metadata:
    18. creationTimestamp: 2016-02-18T18:34:05Z
    19. name: game-config
    20. namespace: default
    21. resourceVersion: "407"
    22. selfLink: /api/v1/namespaces/default/configmaps/game-config
    23. uid: 30944725-d66e-11e5-8cd0-68f728db1985

    使用文件创建

    刚才使用目录创建的时候我们—from-file指定的是一个目录,只要指定为一个文件就可以从单个文件中创建ConfigMap。

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

    —from-file这个参数可以使用多次,你可以使用两次分别指定上个实例中的那两个配置文件,效果就跟指定整个目录是一样的。

    使用字面值创建

    使用文字值创建,利用—from-literal参数传递配置信息,该参数可以使用多次,格式如下;

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

    Pod中使用ConfigMap

    使用ConfigMap来替代环境变量

    ConfigMap可以被用来填入环境变量。看下下面的ConfigMap。

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

    我们可以在Pod中这样使用ConfigMap:

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4. name: dapi-test-pod
    5. spec:
    6. containers:
    7. - name: test-container
    8. image: gcr.io/google_containers/busybox
    9. command: [ "/bin/sh", "-c", "env" ]
    10. env:
    11. - name: SPECIAL_LEVEL_KEY
    12. valueFrom:
    13. configMapKeyRef:
    14. name: special-config
    15. key: special.how
    16. - name: SPECIAL_TYPE_KEY
    17. valueFrom:
    18. configMapKeyRef:
    19. name: special-config
    20. key: special.type
    21. envFrom:
    22. - configMapRef:
    23. name: env-config
    24. restartPolicy: Never

    这个Pod运行后会输出如下几行:

    1. SPECIAL_LEVEL_KEY=very
    2. SPECIAL_TYPE_KEY=charm
    3. log_level=INFO

    用ConfigMap设置命令行参数

    ConfigMap也可以被使用来设置容器中的命令或者参数值。它使用的是Kubernetes的$(VAR_NAME)替换语法。我们看下下面这个ConfigMap。

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

    为了将ConfigMap中的值注入到命令行的参数里面,我们还要像前面那个例子一样使用环境变量替换语法${VAR_NAME)。(其实这个东西就是给Docker容器设置环境变量,以前我创建镜像的时候经常这么玩,通过docker run的时候指定-e参数修改镜像里的环境变量,然后docker的CMD命令再利用该$(VAR_NAME)通过sed来修改配置文件或者作为命令行启动参数。)

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4. name: dapi-test-pod
    5. spec:
    6. containers:
    7. - name: test-container
    8. image: gcr.io/google_containers/busybox
    9. command: [ "/bin/sh", "-c", "echo $(SPECIAL_LEVEL_KEY) $(SPECIAL_TYPE_KEY)" ]
    10. env:
    11. - name: SPECIAL_LEVEL_KEY
    12. valueFrom:
    13. configMapKeyRef:
    14. name: special-config
    15. key: special.how
    16. - name: SPECIAL_TYPE_KEY
    17. valueFrom:
    18. configMapKeyRef:
    19. name: special-config
    20. key: special.type
    21. restartPolicy: Never

    运行这个Pod后会输出:

    1. very charm

    通过数据卷插件使用ConfigMap

    ConfigMap也可以在数据卷里面被使用。还是这个ConfigMap。

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

    在数据卷里面使用这个ConfigMap,有不同的选项。最基本的就是将文件填入数据卷,在这个文件中,键就是文件名,键值就是文件内容:

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4. name: dapi-test-pod
    5. spec:
    6. containers:
    7. - name: test-container
    8. image: gcr.io/google_containers/busybox
    9. command: [ "/bin/sh", "-c", "cat /etc/config/special.how" ]
    10. volumeMounts:
    11. - name: config-volume
    12. mountPath: /etc/config
    13. volumes:
    14. - name: config-volume
    15. configMap:
    16. name: special-config
    17. restartPolicy: Never

    运行这个Pod的输出是very

    我们也可以在ConfigMap值被映射的数据卷里控制路径。

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4. name: dapi-test-pod
    5. spec:
    6. containers:
    7. - name: test-container
    8. image: gcr.io/google_containers/busybox
    9. command: [ "/bin/sh","-c","cat /etc/config/path/to/special-key" ]
    10. volumeMounts:
    11. - name: config-volume
    12. mountPath: /etc/config
    13. volumes:
    14. - name: config-volume
    15. configMap:
    16. name: special-config
    17. items:
    18. - key: special.how
    19. path: path/to/special-key
    20. restartPolicy: Never

    运行这个Pod后的结果是very