zhangxiaoyang
10 KiB
title, content_type, description
| title | content_type | description |
|---|---|---|
| Downward API | concept | 有两种方法可以将 Pod 和容器字段暴露给运行中的容器：环境变量和由特殊卷类型承载的文件。 这两种暴露 Pod 和容器字段的方法统称为 Downward API。 |
对于容器来说，在不与 Kubernetes 过度耦合的情况下，拥有关于自身的信息有时是很有用的。 Downward API 允许容器在不使用 Kubernetes 客户端或 API 服务器的情况下获得自己或集群的信息。
例如，现有应用程序假设某特定的周知的环境变量是存在的，其中包含唯一标识符。 一种方法是对应用程序进行封装，但这很繁琐且容易出错，并且违背了低耦合的目标。 更好的选择是使用 Pod 名称作为标识符，并将 Pod 名称注入到周知的环境变量中。
在 Kubernetes 中，有两种方法可以将 Pod 和容器字段暴露给运行中的容器：
- 作为环境变量
- 作为
downwardAPI卷中的文件
这两种暴露 Pod 和容器字段的方式统称为 Downward API。
可用字段
只有部分 Kubernetes API 字段可以通过 Downward API 使用。本节列出了你可以使用的字段。
你可以使用 fieldRef 传递来自可用的 Pod 级字段的信息。在 API 层面，一个 Pod 的
spec 总是定义了至少一个 Container。
你可以使用 resourceFieldRef 传递来自可用的 Container 级字段的信息。
可通过 fieldRef 获得的信息
对于大多数 Pod 级别的字段，你可以将它们作为环境变量或使用 downwardAPI 卷提供给容器。
通过这两种机制可用的字段有：
metadata.name- Pod 的名称
metadata.namespace- Pod 的{{< glossary_tooltip text="命名空间" term_id="namespace" >}}
metadata.uid- Pod 的唯一 ID
metadata.annotations['<KEY>']- Pod 的{{< glossary_tooltip text="注解" term_id="annotation" >}}
<KEY>的值（例如：metadata.annotations['myannotation']）
metadata.labels['<KEY>']- Pod 的{{< glossary_tooltip text="标签" term_id="label" >}}
<KEY>的值（例如：metadata.labels['mylabel']）
spec.serviceAccountName- Pod 的{{< glossary_tooltip text="服务账号" term_id="service-account" >}}名称
spec.nodeName- Pod 运行时所处的{{< glossary_tooltip term_id="node" text="节点">}}名称
status.hostIP- Pod 所在节点的主 IP 地址
status.podIP- Pod 的主 IP 地址（通常是其 IPv4 地址）
此外，以下信息可以通过 downwardAPI 卷 fieldRef 获得，但不能作为环境变量获得：
metadata.labels- Pod 的所有标签，格式为
标签键名="转义后的标签值"，每行一个标签
metadata.annotations- Pod 的全部注解，格式为
注解键名="转义后的注解值"，每行一个注解
可通过 resourceFieldRef 获得的信息
resource: limits.cpu- 容器的 CPU 限制值
resource: requests.cpu- 容器的 CPU 请求值
resource: limits.memory- 容器的内存限制值
resource: requests.memory- 容器的内存请求值
resource: limits.hugepages-*- 容器的巨页限制值（前提是启用了
DownwardAPIHugePages特性门控）
resource: requests.hugepages-*- 容器的巨页请求值（前提是启用了
DownwardAPIHugePages特性门控）
resource: limits.ephemeral-storage- 容器的临时存储的限制值
resource: requests.ephemeral-storage- 容器的临时存储的请求值
资源限制的后备信息
如果没有为容器指定 CPU 和内存限制时尝试使用 Downward API 暴露该信息，那么 kubelet 默认会根据 节点可分配资源 计算并暴露 CPU 和内存的最大可分配值。
{{% heading "whatsnext" %}}
你可以阅读有关 downwardAPI 卷的内容。
你可以尝试使用 Downward API 暴露容器或 Pod 级别的信息：
- 作为环境变量
- 作为
downwardAPI卷中的文件