通过环境变量将 Pod 信息公开给容器

本页面展示了 Pod 如何通过使用 downward API，利用环境变量向 Pod 中运行的容器公开自身信息。你可以使用环境变量来公开 Pod 字段、容器字段，或者两者都公开。

在 Kubernetes 中，有两种方式可以向运行中的容器公开 Pod 和容器的字段：

环境变量，如本任务所述
Volume 文件

总而言之，这两种公开 Pod 和容器字段的方式被称为向下 API（downward API）。

由于 Service 是 Kubernetes 管理的容器化应用之间的主要通信方式，因此能够在运行时发现它们会很有帮助。

阅读更多关于访问 Service 的信息这里。

准备工作

你需要拥有一个 Kubernetes 集群，并且 kubectl 命令行工具已经配置好与你的集群进行通信。建议你在至少有两个非控制平面主机的节点上运行本教程。如果你还没有集群，可以使用 minikube 创建一个，或者使用以下 Kubernetes 演练场之一：

使用 Pod 字段作为环境变量的值

在本练习的这一部分，你创建一个包含一个容器的 Pod，并将 Pod 级别的字段作为环境变量投影到运行中的容器中。

pods/inject/dapi-envars-pod.yaml

apiVersion: v1
kind: Pod
metadata:
  name: dapi-envars-fieldref
spec:
  containers:
    - name: test-container
      image: registry.k8s.io/busybox:1.27.2
      command: [ "sh", "-c"]
      args:
      - while true; do
          echo -en '\n';
          printenv MY_NODE_NAME MY_POD_NAME MY_POD_NAMESPACE;
          printenv MY_POD_IP MY_POD_SERVICE_ACCOUNT;
          sleep 10;
        done;
      env:
        - name: MY_NODE_NAME
          valueFrom:
            fieldRef:
              fieldPath: spec.nodeName
        - name: MY_POD_NAME
          valueFrom:
            fieldRef:
              fieldPath: metadata.name
        - name: MY_POD_NAMESPACE
          valueFrom:
            fieldRef:
              fieldPath: metadata.namespace
        - name: MY_POD_IP
          valueFrom:
            fieldRef:
              fieldPath: status.podIP
        - name: MY_POD_SERVICE_ACCOUNT
          valueFrom:
            fieldRef:
              fieldPath: spec.serviceAccountName
  restartPolicy: Never

在该清单中，你可以看到五个环境变量。env 字段是一个环境变量定义的数组。数组中的第一个元素指定 MY_NODE_NAME 环境变量从 Pod 的 spec.nodeName 字段获取其值。类似地，其他环境变量从 Pod 字段获取其名称。

注意

此示例中的字段是 Pod 字段。它们不是 Pod 中容器的字段。

创建 Pod

kubectl apply -f https://k8s.io/examples/pods/inject/dapi-envars-pod.yaml

验证 Pod 中的容器正在运行

# If the new Pod isn't yet healthy, rerun this command a few times.
kubectl get pods

查看容器的日志

kubectl logs dapi-envars-fieldref

输出显示了所选环境变量的值

minikube
dapi-envars-fieldref
default
172.17.0.4
default

要了解这些值为何出现在日志中，请查看配置文件中的 command 和 args 字段。容器启动时，它会将五个环境变量的值写入标准输出。它每隔十秒重复此操作。

接下来，进入在你的 Pod 中运行的容器的 shell：

kubectl exec -it dapi-envars-fieldref -- sh

在 shell 中，查看环境变量：

# Run this in a shell inside the container
printenv

输出显示某些环境变量已被赋予 Pod 字段的值

MY_POD_SERVICE_ACCOUNT=default
...
MY_POD_NAMESPACE=default
MY_POD_IP=172.17.0.4
...
MY_NODE_NAME=minikube
...
MY_POD_NAME=dapi-envars-fieldref

使用容器字段作为环境变量的值

在前面的练习中，你使用了 Pod 级别字段中的信息作为环境变量的值。在接下来的练习中，你将传递属于 Pod 定义一部分的字段，但这些字段是取自特定的容器，而不是整个 Pod。

这是另一个 Pod 的清单，它也只有一个容器：

pods/inject/dapi-envars-container.yaml

apiVersion: v1
kind: Pod
metadata:
  name: dapi-envars-resourcefieldref
spec:
  containers:
    - name: test-container
      image: registry.k8s.io/busybox:1.27.2
      command: [ "sh", "-c"]
      args:
      - while true; do
          echo -en '\n';
          printenv MY_CPU_REQUEST MY_CPU_LIMIT;
          printenv MY_MEM_REQUEST MY_MEM_LIMIT;
          sleep 10;
        done;
      resources:
        requests:
          memory: "32Mi"
          cpu: "125m"
        limits:
          memory: "64Mi"
          cpu: "250m"
      env:
        - name: MY_CPU_REQUEST
          valueFrom:
            resourceFieldRef:
              containerName: test-container
              resource: requests.cpu
        - name: MY_CPU_LIMIT
          valueFrom:
            resourceFieldRef:
              containerName: test-container
              resource: limits.cpu
        - name: MY_MEM_REQUEST
          valueFrom:
            resourceFieldRef:
              containerName: test-container
              resource: requests.memory
        - name: MY_MEM_LIMIT
          valueFrom:
            resourceFieldRef:
              containerName: test-container
              resource: limits.memory
  restartPolicy: Never

在该清单中，你可以看到四个环境变量。env 字段是一个环境变量定义的数组。数组中的第一个元素指定 MY_CPU_REQUEST 环境变量从名为 test-container 的容器的 requests.cpu 字段获取其值。类似地，其他环境变量从该特定容器的字段获取其值。