Kubernetes Downward API 实战：通过文件将 Pod 信息注入容器-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00237/article/details/148525006

Kubernetes Downward API 实战：通过文件将 Pod 信息注入容器

website Kubernetes website and documentation repo: 项目地址: https://gitcode.com/gh_mirrors/webs/website

前言

在 Kubernetes 集群中运行应用时，我们经常需要让容器获取它所在 Pod 的相关信息。Kubernetes 提供了两种主要方式来实现这一需求：环境变量和文件方式。本文将重点介绍如何使用 Downward API 通过文件方式将 Pod 信息暴露给容器。

Downward API 简介

Downward API 是 Kubernetes 提供的一种机制，允许容器获取自身运行环境的信息，主要包括：

Pod 级别的信息：如 Pod 名称、命名空间、标签、注解等
容器级别的信息：如资源限制、请求等

与直接查询 Kubernetes API 相比，Downward API 的优势在于：

无需额外的 API 访问权限
信息自动更新（某些字段）
使用简单，配置即可

准备工作

在开始之前，请确保您已经：

部署了一个可用的 Kubernetes 集群
配置好 kubectl 命令行工具
拥有足够的权限在集群中创建 Pod

通过文件暴露 Pod 信息

基本配置示例

下面是一个基本的 Pod 配置示例，展示了如何通过 downwardAPI 卷将 Pod 的标签和注解信息暴露给容器：

apiVersion: v1
kind: Pod
metadata:
  name: kubernetes-downwardapi-volume-example
  labels:
    zone: us-est-coast
    cluster: test-cluster1
    rack: rack-22
  annotations:
    build: two
    builder: john-doe
spec:
  containers:
    - name: client-container
      image: registry.k8s.io/busybox
      command: ["sh", "-c"]
      args:
      - while true; do
          if [[ -e /etc/podinfo/labels ]]; then
            echo -en '\n\n'; cat /etc/podinfo/labels; fi;
          if [[ -e /etc/podinfo/annotations ]]; then
            echo -en '\n\n'; cat /etc/podinfo/annotations; fi;
          sleep 5;
        done;
      volumeMounts:
        - name: podinfo
          mountPath: /etc/podinfo
  volumes:
    - name: podinfo
      downwardAPI:
        items:
          - path: "labels"
            fieldRef:
              fieldPath: metadata.labels
          - path: "annotations"
            fieldRef:
              fieldPath: metadata.annotations

关键配置解析

volumes 部分：定义了一个名为 podinfo 的 downwardAPI 卷
items 数组：指定了要暴露的字段和对应的文件路径
- metadata.labels → /etc/podinfo/labels
- metadata.annotations → /etc/podinfo/annotations
volumeMounts：将卷挂载到容器的 /etc/podinfo 目录

部署与验证

应用配置：

kubectl apply -f pod-with-downwardapi.yaml

检查 Pod 状态：
```
kubectl get pods
```

查看日志验证信息是否正确注入：

kubectl logs kubernetes-downwardapi-volume-example

进入容器查看文件内容：

kubectl exec -it kubernetes-downwardapi-volume-example -- sh
cat /etc/podinfo/labels
cat /etc/podinfo/annotations

文件更新机制

Downward API 使用了一种巧妙的机制来确保文件更新的原子性：

新数据会写入一个临时目录（如 ..2982_06_02_21_47_53.299460680）
通过符号链接切换（..data 指向最新目录）
实际文件也是符号链接（如 labels → ..data/labels）

这种设计确保了在更新过程中，应用始终能看到完整的数据，而不会出现部分更新的情况。

暴露容器资源信息

除了 Pod 级别的信息，我们还可以暴露容器自身的资源限制和请求信息：

apiVersion: v1
kind: Pod
metadata:
  name: kubernetes-downwardapi-volume-example-2
spec:
  containers:
    - name: client-container
      image: registry.k8s.io/busybox
      command: ["sh", "-c"]
      args:
      - while true; do
          echo -en '\n'; cat /etc/podinfo/cpu_limit;
          sleep 5;
        done;
      resources:
        requests:
          cpu: "250m"
          memory: "64Mi"
        limits:
          cpu: "500m"
          memory: "128Mi"
      volumeMounts:
        - name: podinfo
          mountPath: /etc/podinfo
  volumes:
    - name: podinfo
      downwardAPI:
        items:
          - path: "cpu_limit"
            resourceFieldRef:
              containerName: client-container
              resource: limits.cpu
              divisor: 1m
          - path: "cpu_request"
            resourceFieldRef:
              containerName: client-container
              resource: requests.cpu
              divisor: 1m
          - path: "mem_limit"
            resourceFieldRef:
              containerName: client-container
              resource: limits.memory
          - path: "mem_request"
            resourceFieldRef:
              containerName: client-container
              resource: requests.memory

关键配置解析

resourceFieldRef：用于指定容器资源字段
- containerName：目标容器名称
- resource：资源字段（如 limits.cpu）
- divisor：格式化除数（可选）
divisor 的作用：
- CPU：1m 表示毫核
- 内存：1 表示字节，1Mi 表示 Mebibyte

高级配置选项

自定义文件权限

您可以为 Downward API 文件设置特定的权限模式：

volumes:
  - name: podinfo
    downwardAPI:
      items:
        - path: "labels"
          fieldRef:
            fieldPath: metadata.labels
          mode: 0644  # 设置文件权限