如何在 Kubernetes Pod 中注入环境变量及优先级问题

1. Kubernetes Pod 引用环境变量的几种方式

1.1 直接 Key/Value

可以直接设置 Value 值，也可以将当前 Pod 的信息作为 Value 值。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
apiVersion: v1
kind: Pod
metadata:
  name: envar-demo
  labels:
    purpose: demonstrate-envars
spec:
  containers:
  - name: envar-demo-container
    image: gcr.io/google-samples/node-hello:1.0
    env:
    - name: DEMO_GREETING
      value: "Hello from the environment"
    - name: DEMO_FAREWELL
      value: "Such a sweet sorrow"
    - name: MY_NODE_NAME
      valueFrom:
        fieldRef:
          fieldPath: spec.nodeName
    - name: MY_POD_NAME
      valueFrom:
        fieldRef:
          fieldPath: metadata.name

1.2 从 Secret 引用

有两种方式引用 Secret 中的变量：

通过 envFrom 引用 Secret 中全部变量
通过 valueFrom 引用 Secret 中指定变量

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
apiVersion: v1
kind: Pod
metadata:
  name: secret-env-pod
spec:
  containers:
  - name: mycontainer
    image: redis
    envFrom:
      - secretRef:
          name: secret-config
    env:
      - name: SECRET_USERNAME
        valueFrom:
          secretKeyRef:
            name: secret-config
            key: username
      - name: SECRET_PASSWORD
        valueFrom:
          secretKeyRef:
            name: secret-config
            key: password

1.3 从 ConfigMap 引用

有两种方式引用 ConfigMap 中的变量：

通过 envFrom 引用 ConfigMap 中全部变量
通过 valueFrom 引用 ConfigMap 中指定变量

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
apiVersion: v1
kind: Pod
metadata:
  name: dapi-test-pod
spec:
  containers:
    - name: test-container
      image: k8s.gcr.io/busybox
      envFrom:
        - configMapRef:
            name: configmap-config
      env:
        - name: SPECIAL_LEVEL_KEY
          valueFrom:
            configMapKeyRef:
              name: special-config
              key: special.how
        - name: LOG_LEVEL
          valueFrom:
            configMapKeyRef:
              name: env-config
              key: log_level

2. 变量引用的优先级

从源码中可以看到的实现逻辑是，会初始化一个 Map 存放环境变量，然后按照如下步骤进行处理:

按顺序遍历 envFrom 引用的 ConfigMap 和 Secret 的 Key/Value
按顺序遍历 env 中的设置的 Key/Value
由于 Pod 默认开启了 EnableServiceLinks，最后还需要将 Service 相关变量注入

优先级是，Service 变量 > Env > EnvFrom，其中 EnvFrom 的优先级是后面覆盖前面。

这里单独说下，注入到环境变量中的 Service 相关变量:

注入的范围。所在命名空间的所有 Service
注入的内容。同一命名空间下，所有的服务地址、端口、协议。
注入的格式。大写字母加下划线的格式，例如 ADMIN_WEB_PC_TEST_PORT_80_TCP=tcp://10.233.45.183:80，ADMIN_WEB_PC_TEST_PORT=tcp://10.233.45.183:80，ADMIN_WEB_PC_TEST_PORT_80_TCP_ADDR=10.233.45.183，ADMIN_WEB_PC_TEST_PORT_80_TCP_PORT=80，ADMIN_WEB_PC_TEST_PORT_80_TCP_PROTO=tcp 。如果同一个命名空间下，部署大量服务，每个 Pod 中可能会增加几百个这样的变量。