很多應(yīng)用程序需要一些配置通過組合的配置文件膝宁,命令行參數(shù)和環(huán)境變量潮罪。這些配置應(yīng)該與鏡像內(nèi)容分離以保持容器化應(yīng)用程序的可移植性阅畴。ConfigMap API資源提供了將配置數(shù)據(jù)注入容器的機(jī)制盯滚,同時(shí)保持容器不受kubernetes的影響定页。ConfigMap可用于存儲(chǔ)細(xì)粒度信息如單個(gè)屬性趟薄,或粗粒度信息如整個(gè)配置文件或JSON對(duì)象。
ConfigMap概述
ConfigMap API資源保存配置數(shù)據(jù)的鍵值對(duì)典徊,可以在pods中使用或者可以用于存儲(chǔ)系統(tǒng)組件的配置數(shù)據(jù)杭煎。ConfigMap類似于Secrets,但是旨在更方便的使用不包含敏感信息的字符串。
注意:ConfigMap不打算充當(dāng)屬性文件的替換者卒落。你可以認(rèn)為類似于/etc目錄羡铲,以及Linux計(jì)算機(jī)上的文件。一個(gè)例子是從ConfigMap創(chuàng)建一個(gè)Kubernetes卷儡毕,其中ConfigMap的數(shù)據(jù)項(xiàng)變成一個(gè)新的文件也切。
例如下面的例子:
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可以用于細(xì)粒度的單個(gè)屬性雷恃,或者是配置文件的內(nèi)容。
配置數(shù)據(jù)在pods中有多種使用方式费坊。ConfigMap有以下幾種使用方式:
1.填充環(huán)境變量的值
2.設(shè)置容器內(nèi)的命令行參數(shù)
3.填充卷的配置文件
用戶和系統(tǒng)組建都可以在ConfigMap中存儲(chǔ)配置數(shù)據(jù)倒槐。
新建ConfigMap
可以使用kubectl create configmap
命令行非常容易的從字面值,文件或目錄中創(chuàng)建configmaps葵萎。
讓我們嘗試用不同的方式創(chuàng)建一個(gè)ConfigMap:
從目錄創(chuàng)建
比如說我們有一個(gè)目錄其中包含一些已經(jīng)已經(jīng)包含要填充ConfigMap數(shù)據(jù)的文件:
$ 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
可用于創(chuàng)建一個(gè)保存此目錄中每個(gè)文件內(nèi)容的ConfigMap:
$ kubectl create configmap game-config --from-file=docs/user-guide/configmap/kubectl
當(dāng) --from-file指向一個(gè)目錄导犹,每個(gè)目錄中的文件直接用于填充ConfigMap中的key,key的名稱是文件名稱,key的值是這個(gè)文件的內(nèi)容羡忘。讓我們看看上面命令創(chuàng)建的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中的兩個(gè)key是從我們指向的kubectl的目錄中的文件名創(chuàng)建的谎痢。因?yàn)檫@些建的內(nèi)容可能很大,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
從文件創(chuàng)建
也可以通過--from-file指定文件,并將他多次傳遞給kubectc滨嘱。下面的命令和上面的示例產(chǎn)生相同的結(jié)果:
$ 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表達(dá)式為每個(gè)文件設(shè)置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
通過字面值創(chuàng)建
也可以通過kubectl create configmap
創(chuàng)建ConfigMap使用字面值峰鄙。--from-literal選項(xiàng)使用一個(gè)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
用例:在環(huán)境變量中使用ConfigMap
ConfigMap可用于填充各個(gè)環(huán)境變量或者整個(gè)使用太雨。例如下面的例子:
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
當(dāng)這個(gè)pod運(yùn)行起來的時(shí)候吟榴,它輸出包含下面的行:
SPECIAL_LEVEL_KEY=very
SPECIAL_TYPE_KEY=charm
log_level=INFO
可選ConfigMap在環(huán)境變量中
有些情況環(huán)境變量不是總是需要。這些環(huán)境變量可以標(biāo)記為可選的在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
當(dāng)這個(gè)pod運(yùn)行囊扳,輸出是空的吩翻。
設(shè)置命令行參數(shù)用ConfigMap
ConfigMaps可以用于設(shè)置容器里面的命令行參數(shù)的值。這是使用Kubernetes替換$(value)語法完成的锥咸∠料梗考慮ConfigMap:
apiVersion: v1
kind: ConfigMap
metadata:
name: special-config
namespace: default
data:
special.how: very
special.type: charm
為了把值注入到命令行,我們必須使用我們作為環(huán)境變量的鍵搏予,例如上一個(gè)例子熊锭。我們可以參考在容器內(nèi)命令行使用$(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
當(dāng)pod運(yùn)行起來的時(shí)候,從test-container容器的輸出會(huì)是:
very charm
用例:使用ConfigMap通過卷插件
ConfigMaps也可以在卷內(nèi)使用雪侥。再次返回我們的示例:
apiVersion: v1
kind: ConfigMap
metadata:
name: special-config
namespace: default
data:
special.how: very
special.type: charm
在卷中使用ConfigMap我們有幾個(gè)不同的選項(xiàng)碗殷。最基礎(chǔ)的方式是填充卷文件,鍵值是文件名內(nèi)容是鍵對(duì)應(yīng)的值:
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
當(dāng)這個(gè)pod運(yùn)行起來校镐,會(huì)輸出下面的內(nèi)容:
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
當(dāng)這個(gè)pod運(yùn)行起來亿扁,會(huì)輸出下面:
very
映射key指定的路徑和權(quán)限
你可以在每個(gè)文件基礎(chǔ)上指定key映射的特定路徑和權(quán)限。Secrets用戶指南介紹語法鸟廓。
可選ConfigMap通過卷插件
卷和文件也可以標(biāo)記為可選从祝。ConfigMap或指定的鍵不一定存在。將始終創(chuàng)建這些項(xiàng)目的掛載路徑引谜。
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
當(dāng)pod運(yùn)行起來牍陌,輸出將是空。
真實(shí)的示例:配置Redis
讓我看一個(gè)真實(shí)示例:使用ConfigMap配置redis员咽。加入我們想用推薦的配置注入redis作為緩存毒涧。redis的配置文件應(yīng)該包含:
maxmemory 2mb
maxmemory-policy allkeys-lru
這個(gè)文件在docs/user-guide/configmap/redis
,我們可以用下面的命令新建一個(gè)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
現(xiàn)在我們新建一個(gè)pod使用這個(gè)配置:
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
注意贝室,這個(gè)pod有一個(gè)ConfigMap卷契讲,它將example-redis-config ConfigMap的redis-config鍵的值放入一個(gè)名為redis.conf的文件中。這個(gè)卷是掛載到redis容器里面的/redis-master目錄里面滑频,我們的配置文件在/redis-master/redis.conf
捡偏,這個(gè)redis注解點(diǎn)在鏡像里面的配置文件。
$ kubectl create -f docs/user-guide/configmap/redis/redis-pod.yaml
運(yùn)行kubectl exec
進(jìn)入到這個(gè)pod里面并運(yùn)行redis-cli工具峡迷,可以檢查我們的配置是否正確應(yīng)用:
$ 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消耗他之前創(chuàng)建银伟,除非被標(biāo)記為可選你虹。對(duì)于不存在的ConfigMap將阻止它啟動(dòng)⊥埽控制器可能被寫入以容忍丟失數(shù)據(jù)傅物,可以個(gè)根據(jù)具體情況查看通過ConfigMap配置的各個(gè)組件。
通過configMapKeyRef引用命名ConfigMap中不存在的鍵將阻止他的啟動(dòng)琉预。
ConfigMaps用于填充環(huán)境變量通過envFrom,它們被認(rèn)為具有無效的環(huán)境變量名稱的鍵將跳過這些鍵董饰。該pod被允許啟動(dòng)。將會(huì)有一個(gè)事件圆米,原因是InvalidVariabelNames,該消息包含被跳過的無效的鍵的列表尖阔。該示例顯示一個(gè)pod它指的是 default/myconfig ConfigMap包含兩個(gè)無效的鍵,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配額大小是一個(gè)計(jì)劃功能谴供。
kubelet僅支持pod使用ConfigMap獲取從API server块茁。這包括使用kubectl創(chuàng)建每個(gè)pod,或者間接通過副本控制器。