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

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

在 Kubernetes 中,有两种方法可以将 Pod 和容器字段暴露给正在运行的容器:

  • 环境变量,如本任务中所述
  • 卷文件

总而言之,这两种暴露 Pod 和容器字段的方式称为 downward API。

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

在此处阅读更多关于访问 Services 的信息 here

准备工作

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

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

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

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

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

要了解这些值为何出现在日志中,请查看配置文件中的 commandargs 字段。当容器启动时,它会将五个环境变量的值写入标准输出。它每十秒重复一次。

接下来,获取 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 的清单,它同样只包含一个容器

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 字段获取其值。类似地,其他环境变量从特定于此容器的字段获取其值。

创建 Pod

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

验证 Pod 中的容器是否正在运行

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

查看容器的日志

kubectl logs dapi-envars-resourcefieldref

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

1
1
33554432
67108864

下一步

阅读旧版 API 参考中关于 Pod、容器和环境变量的信息

最后修改于 2023 年 8 月 24 日下午 6:38 PST:使用 code_sample 简码代替 code 简码 (e8b136c3b3)