透過環境變數向容器公開 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)