通过环境变量将 Pod 信息呈现给容器

此页面展示 Pod 如何使用环境变量把自己的信息呈现给 Pod 中运行的容器。 环境变量可以呈现 Pod 的字段和容器字段。

准备开始

你必须拥有一个 Kubernetes 的集群,同时你的 Kubernetes 集群必须带有 kubectl 命令行工具。 如果你还没有集群,你可以通过 Minikube 构建一 个你自己的集群,或者你可以使用下面任意一个 Kubernetes 工具构建:

要获知版本信息,请输入 kubectl version.

Downward API

有两种方式可以将 Pod 和 Container 字段呈现给运行中的容器:

这两种呈现 Pod 和 Container 字段的方式统称为 Downward API

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

在这个练习中,你将创建一个包含一个容器的 Pod。这是该 Pod 的配置文件:

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4. name: dapi-envars-fieldref
  5. spec:
  6. containers:
  7. - name: test-container
  8. image: k8s.gcr.io/busybox
  9. command: [ "sh", "-c"]
  10. args:
  11. - while true; do
  12. echo -en '\n';
  13. printenv MY_NODE_NAME MY_POD_NAME MY_POD_NAMESPACE;
  14. printenv MY_POD_IP MY_POD_SERVICE_ACCOUNT;
  15. sleep 10;
  16. done;
  17. env:
  18. - name: MY_NODE_NAME
  19. valueFrom:
  20. fieldRef:
  21. fieldPath: spec.nodeName
  22. - name: MY_POD_NAME
  23. valueFrom:
  24. fieldRef:
  25. fieldPath: metadata.name
  26. - name: MY_POD_NAMESPACE
  27. valueFrom:
  28. fieldRef:
  29. fieldPath: metadata.namespace
  30. - name: MY_POD_IP
  31. valueFrom:
  32. fieldRef:
  33. fieldPath: status.podIP
  34. - name: MY_POD_SERVICE_ACCOUNT
  35. valueFrom:
  36. fieldRef:
  37. fieldPath: spec.serviceAccountName
  38. restartPolicy: Never

这个配置文件中,你可以看到五个环境变量。env 字段是一个 EnvVars. 对象的数组。 数组中第一个元素指定 MY_NODE_NAME 这个环境变量从 Pod 的 spec.nodeName 字段获取变量值。 同样,其它环境变量也是从 Pod 的字段获取它们的变量值。

说明: 本示例中的字段是 Pod 字段,不是 Pod 中 Container 的字段。

创建Pod:

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

验证 Pod 中的容器运行正常:

  1. kubectl get pods

查看容器日志:

  1. kubectl logs dapi-envars-fieldref

输出信息显示了所选择的环境变量的值:

  1. minikube
  2. dapi-envars-fieldref
  3. default
  4. 172.17.0.4
  5. default

要了解为什么这些值在日志中,请查看配置文件中的commandargs字段。 当容器启动时,它将五个环境变量的值写入 stdout。每十秒重复执行一次。

接下来,通过打开一个 Shell 进入 Pod 中运行的容器:

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

在 Shell 中,查看环境变量:

  1. /# printenv

输出信息显示环境变量已经设置为 Pod 字段的值。

  1. MY_POD_SERVICE_ACCOUNT=default
  2. ...
  3. MY_POD_NAMESPACE=default
  4. MY_POD_IP=172.17.0.4
  5. ...
  6. MY_NODE_NAME=minikube
  7. ...
  8. MY_POD_NAME=dapi-envars-fieldref

用 Container 字段作为环境变量的值

前面的练习中,你将 Pod 字段作为环境变量的值。 接下来这个练习中,你将用 Container 字段作为环境变量的值。这里是包含一个容器的 Pod 的配置文件:

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4. name: dapi-envars-resourcefieldref
  5. spec:
  6. containers:
  7. - name: test-container
  8. image: k8s.gcr.io/busybox:1.24
  9. command: [ "sh", "-c"]
  10. args:
  11. - while true; do
  12. echo -en '\n';
  13. printenv MY_CPU_REQUEST MY_CPU_LIMIT;
  14. printenv MY_MEM_REQUEST MY_MEM_LIMIT;
  15. sleep 10;
  16. done;
  17. resources:
  18. requests:
  19. memory: "32Mi"
  20. cpu: "125m"
  21. limits:
  22. memory: "64Mi"
  23. cpu: "250m"
  24. env:
  25. - name: MY_CPU_REQUEST
  26. valueFrom:
  27. resourceFieldRef:
  28. containerName: test-container
  29. resource: requests.cpu
  30. - name: MY_CPU_LIMIT
  31. valueFrom:
  32. resourceFieldRef:
  33. containerName: test-container
  34. resource: limits.cpu
  35. - name: MY_MEM_REQUEST
  36. valueFrom:
  37. resourceFieldRef:
  38. containerName: test-container
  39. resource: requests.memory
  40. - name: MY_MEM_LIMIT
  41. valueFrom:
  42. resourceFieldRef:
  43. containerName: test-container
  44. resource: limits.memory
  45. restartPolicy: Never

这个配置文件中,你可以看到四个环境变量。env 字段是一个 EnvVars. 对象的数组。数组中第一个元素指定 MY_CPU_REQUEST 这个环境变量从 Container 的 requests.cpu 字段获取变量值。同样,其它环境变量也是从 Container 的字段获取它们的变量值。

说明: 本例中使用的是 Container 的字段而不是 Pod 的字段。

创建Pod:

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

验证 Pod 中的容器运行正常:

  1. kubectl get pods

查看容器日志:

  1. kubectl logs dapi-envars-resourcefieldref

输出信息显示了所选择的环境变量的值:

  1. 1
  2. 1
  3. 33554432
  4. 67108864

接下来

最后修改 December 14, 2020 at 6:35 PM PST : Update environment-variable-expose-pod-information.md (69249f045)