You are viewing documentation for Kubernetes version: v1.23

Kubernetes v1.23 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

众所周知的标签、注解和污点

Kubernetes 将所有标签和注解保留在 kubernetes.io Namespace中。

本文档既可作为值的参考,也可作为分配值的协调点。

API 对象上使用的标签、注解和污点

app.kubernetes.io/component

例子: app.kubernetes.io/component=database

用于: 所有对象

架构中的组件。

推荐标签之一。

app.kubernetes.io/created-by

示例:app.kubernetes.io/created-by=controller-manager

用于:所有对象

创建此资源的控制器/用户。

推荐标签之一。

app.kubernetes.io/instance

示例:app.kubernetes.io/instance=mysql-abcxzy

用于:所有对象

标识应用实例的唯一名称。

推荐标签之一。

app.kubernetes.io/managed-by

示例:app.kubernetes.io/managed-by=helm

用于:所有对象

用于管理应用操作的工具。

推荐标签之一。

app.kubernetes.io/name

示例:app.kubernetes.io/name=mysql

用于:所有对象

应用的名称。

推荐标签之一。

app.kubernetes.io/part-of

示例:app.kubernetes.io/part-of=wordpress

用于:所有对象

此应用所属的更高级别应用的名称。

推荐标签之一。

app.kubernetes.io/version

示例:app.kubernetes.io/version="5.7.21"

用于:所有对象

应用的当前版本(例如,语义版本、修订哈希等)。

推荐标签之一。

kubernetes.io/arch

例子:kubernetes.io/arch=amd64

用于:Node

Kubelet 使用 Go 定义的 runtime.GOARCH 填充它。 如果你混合使用 ARM 和 X86 节点,这会很方便。

kubernetes.io/os

例子:kubernetes.io/os=linux

用于:Node

Kubelet 使用 Go 定义的 runtime.GOOS 填充它。如果你在集群中混合使用操作系统(例如:混合 Linux 和 Windows 节点),这会很方便。

kubernetes.io/metadata.name

例子:kubernetes.io/metadata.name=mynamespace

用于:Namespace

Kubernetes API 服务器(控制平面 的一部分)在所有 Namespace 上设置此标签。 标签值被设置 Namespace 的名称。你无法更改此标签的值。

如果你想使用标签选择器定位特定 Namespace,这很有用。

beta.kubernetes.io/arch (已弃用)

此标签已被弃用。请改用kubernetes.io/arch

beta.kubernetes.io/os (已弃用)

此标签已被弃用。请改用kubernetes.io/os

kubernetes.io/hostname

例子:kubernetes.io/hostname=ip-172-20-114-199.ec2.internal

用于:Node

Kubelet 使用主机名填充此标签。请注意,可以通过将 --hostname-override 标志传递给 kubelet 来替代“实际”主机名。

此标签也用作拓扑层次结构的一部分。 有关详细信息,请参阅 topology.kubernetes.io/zone

kubernetes.io/change-cause

例子:kubernetes.io/change-cause=kubectl edit --record deployment foo

用于:所有对象

此注解是对某些事物发生变更的原因的最佳猜测。

--record 添加到可能会更改对象的 kubectl 命令时会填充它。

kubernetes.io/description

例子:kubernetes.io/description: "Description of K8s object."

用于:所有对象

此注解用于描述给定对象的特定行为。

kubernetes.io/enforce-mountable-secrets

例子:kubernetes.io/enforce-mountable-secrets: "true"

用于:ServiceAccount

此注解的值必须为 true 才能生效。此注解表示作为此服务帐户运行的 Pod 只能引用在服务帐户的 secrets 字段中指定的 Secret API 对象。

controller.kubernetes.io/pod-deletion-cost

例子:controller.kubernetes.io/pod-deletion-cost=10

用于:Pod

该注解用于设置 Pod 删除成本允许用户影响 ReplicaSet 缩减顺序。注解解析为 int32 类型。

kubernetes.io/ingress-bandwidth

示例:kubernetes.io/ingress-bandwidth: 10M

用于:Pod

你可以对 Pod 应用服务质量流量控制并有效限制其可用带宽。 入站流量(到 Pod)通过控制排队的数据包来处理,以有效地处理数据。 要限制 Pod 的带宽,请编写对象定义 JSON 文件并使用 kubernetes.io/ingress-bandwidth 注解指定数据流量速度。 用于指定入站的速率单位是每秒, 作为量纲(Quantity)。 例如,10M表示每秒 10 兆比特。

kubernetes.io/egress-bandwidth

示例:kubernetes.io/egress-bandwidth: 10M

用于:Pod

出站流量(来自 pod)由策略控制,策略只是丢弃超过配置速率的数据包。 你为一个 Pod 所设置的限制不会影响其他 Pod 的带宽。 要限制 Pod 的带宽,请编写对象定义 JSON 文件并使用 kubernetes.io/egress-bandwidth 注解指定数据流量速度。 用于指定出站的速率单位是每秒比特数, 以量纲(Quantity)的形式给出。 例如,10M 表示每秒 10 兆比特。

beta.kubernetes.io/instance-type (已弃用)

node.kubernetes.io/instance-type

例子:node.kubernetes.io/instance-type=m3.medium

用于:Node

Kubelet 使用 cloudprovider 定义的实例类型填充它。 仅当你使用 cloudprovider 时才会设置此项。如果你希望将某些工作负载定位到某些实例类型,则此设置非常方便,但通常你希望依靠 Kubernetes 调度程序来执行基于资源的调度。 你应该基于属性而不是实例类型来调度(例如:需要 GPU,而不是需要 g2.2xlarge)。

failure-domain.beta.kubernetes.io/region (已弃用)

请参阅 topology.kubernetes.io/region

failure-domain.beta.kubernetes.io/zone (已弃用)

请参阅 topology.kubernetes.io/zone

statefulset.kubernetes.io/pod-name

例子:statefulset.kubernetes.io/pod-name=mystatefulset-7

当 StatefulSet 控制器为 StatefulSet 创建 Pod 时,控制平面会在该 Pod 上设置此标签。标签的值是正在创建的 Pod 的名称。

有关详细信息,请参阅 StatefulSet 主题中的 Pod 名称标签

topology.kubernetes.io/region

例子:topology.kubernetes.io/region=us-east-1

请参阅 topology.kubernetes.io/zone

topology.kubernetes.io/zone

例子:topology.kubernetes.io/zone=us-east-1c

用于:Node、PersistentVolume

在 Node 上:kubelet 或外部 cloud-controller-manager 使用 cloudprovider 提供的信息填充它。仅当你使用 cloudprovider 时才会设置此项。 但是,如果它在你的拓扑中有意义,你应该考虑在 Node 上设置它。

在 PersistentVolume 上:拓扑感知卷配置器将自动在 PersistentVolume 上设置 Node 亲和性约束。

一个 Zone 代表一个逻辑故障域。 Kubernetes 集群通常跨越多个 Zone 以提高可用性。虽然 Zone 的确切定义留给基础设施实现, 但 Zone 的常见属性包括 Zone 内非常低的网络延迟、 Zone 内的免费网络流量以及与其他 Zone 的故障独立性。 例如,一个 Zone 内的 Node 可能共享一个网络交换机,但不同 Zone 中的 Node 无法共享交换机。

一个 Region 代表一个更大的域,由一个或多个 Zone 组成。Kubernetes 集群跨多个 Region 并不常见,虽然 Zone 或 Region 的确切定义留给基础设施实现, 但 Region 的共同属性包括它们之间的网络延迟比它们内部更高,它们之间的网络流量成本非零,以及与其他 Zone 或 Region 的故障独立性。 例如,一个 Region 内的 Node 可能共享电力基础设施(例如 UPS 或发电机),但不同 Region 的 Node 通常不会共享电力基础设施。

Kubernetes 对 Zone 和 Region 的结构做了一些假设:

  1. Zone 和 Region 是分层的: Zone 是 Region 的严格子集,没有 Zone 可以在两个 Region 中;

  2. Zone 名称跨 Region 是唯一的;例如, Region “africa-east-1” 可能由 Zone “africa-east-1a” 和 “africa-east-1b” 组成。

你可以大胆假设拓扑标签不会改变。尽管严格地讲标签是可变的,但节点的用户可以假设给定 节点只能通过销毁和重新创建才能完成 Zone 间移动。

Kubernetes 可以通过多种方式使用这些信息。例如,调度程序会自动尝试将 ReplicaSet 中的 Pod 分布在单 Zone 集群中的多个节点上(以便减少节点故障的影响,请参阅 kubernetes.io/hostname)。 对于多 Zone 集群,这种分布行为也适用于 Zone(以减少 Zone 故障的影响)。 Zone 级别的 Pod 分布是通过 SelectorSpreadPriority 实现的。

SelectorSpreadPriority 是一个尽力而为的放置机制。如果集群中的 Zone 是异构的 (例如:节点数量不同、节点类型不同或 Pod 资源需求有别等),这种放置机制可能会让你的 Pod 无法实现跨 Zone 均匀分布。 如果需要,你可以使用同质 Zone(节点数量和类型均相同)来减少不均匀分布的可能性。

调度程序还将(通过 VolumeZonePredicate 条件)确保申领给定卷的 Pod 仅被放置在与该卷相同的 Zone 中。 卷不能跨 Zone 挂接。

你应该考虑手动添加标签(或添加对 PersistentVolumeLabel 的支持)。 基于 PersistentVolumeLabel ,调度程序可以防止 Pod 挂载来自其他 Zone 的卷。如果你的基础架构没有此限制,则不需要将 Zone 标签添加到卷上。

volume.beta.kubernetes.io/storage-provisioner (已弃用)

例子:volume.beta.kubernetes.io/storage-provisioner: k8s.io/minikube-hostpath

用于:PersistentVolumeClaim

此注解已被弃用。

volume.kubernetes.io/storage-provisioner

用于:PersistentVolumeClaim

此注解将被添加到根据需要动态制备的 PVC 上。

node.kubernetes.io/windows-build

例子:node.kubernetes.io/windows-build=10.0.17763

用于:Node

当 kubelet 在 Microsoft Windows 上运行时,它会自动标记其所在节点以记录所使用的 Windows Server 的版本。

标签的值采用 “MajorVersion.MinorVersion.BuildNumber” 格式。

service.kubernetes.io/headless

例子:service.kubernetes.io/headless=""

用于:Service

当拥有的 Service 是无头类型时,控制平面将此标签添加到 Endpoints 对象。

kubernetes.io/service-name

例子:kubernetes.io/service-name="nginx"

用于:Service

Kubernetes 使用这个标签来区分多个服务。目前仅用于 ELB (弹性负载均衡器)。

endpointslice.kubernetes.io/managed-by

例子:endpointslice.kubernetes.io/managed-by="controller"

用于:EndpointSlice

用于标示管理 EndpointSlice 的控制器或实体。该标签旨在使不同的 EndpointSlice 对象能够由同一集群内的不同控制器或实体管理。

endpointslice.kubernetes.io/skip-mirror

例子:endpointslice.kubernetes.io/skip-mirror="true"

用于:Endpoints

可以在 Endpoints 资源上将此标签设置为 "true",以指示 EndpointSliceMirroring 控制器不应使用 EndpointSlice 镜像此 Endpoints 资源。

service.kubernetes.io/service-proxy-name

例子:service.kubernetes.io/service-proxy-name="foo-bar"

用于:Service

kube-proxy 自定义代理会使用这个标签,它将服务控制委托给自定义代理。

experimental.windows.kubernetes.io/isolation-type (已弃用)

例子:experimental.windows.kubernetes.io/isolation-type: "hyperv"

用于:Pod

注解用于运行具有 Hyper-V 隔离的 Windows 容器。要使用 Hyper-V 隔离功能并创建 Hyper-V 隔离容器,kubelet 启动时应该需要设置特性门控 HyperVContainer=true。

ingressclass.kubernetes.io/is-default-class

例子:ingressclass.kubernetes.io/is-default-class: "true"

用于:IngressClass

当单个 IngressClass 资源将此注解设置为 "true"时,新的未指定 Ingress 类的 Ingress 资源将被设置为此默认类。

kubernetes.io/ingress.class (已弃用)

storageclass.kubernetes.io/is-default-class

例子:storageclass.kubernetes.io/is-default-class=true

用于:StorageClass

当单个 StorageClass 资源将此注解设置为 "true" 时,新的未指定存储类的 PersistentVolumeClaim 资源将被设置为此默认类。

alpha.kubernetes.io/provided-node-ip

例子:alpha.kubernetes.io/provided-node-ip: "10.0.0.1"

用于:Node

kubelet 可以在 Node 上设置此注解来表示其配置的 IPv4 地址。

当使用“外部”云驱动启动时,kubelet 会在 Node 上设置此注解以表示从命令行标志 ( --node-ip ) 设置的 IP 地址。 云控制器管理器通过云驱动验证此 IP 是否有效。

batch.kubernetes.io/job-completion-index

例子:batch.kubernetes.io/job-completion-index: "3"

用于:Pod

kube-controller-manager 中的 Job 控制器为使用 Indexed 完成模式创建的 Pod 设置此注解。

kubectl.kubernetes.io/default-container

例子:kubectl.kubernetes.io/default-container: "front-end-app"

此注解的值是此 Pod 的默认容器名称。例如,未指定 -c--container 标志时执行 kubectl logskubectl exec 命令将使用此默认容器。

endpoints.kubernetes.io/over-capacity

例子:endpoints.kubernetes.io/over-capacity:truncated

用于:Endpoints

在 Kubernetes 集群 v1.22(或更高版本)中,如果 Endpoints 资源超过 1000 个,Endpoints 控制器会将此注解添加到 Endpoints 资源。 注解表示 Endpoints 资源已超出容量,并且已将 Endpoints 数截断为 1000。

batch.kubernetes.io/job-tracking

例子:batch.kubernetes.io/job-tracking: ""

用于:Job

Job 上存在此注解表明控制平面正在使用 Finalizer 追踪 Job。 你 可以手动添加或删除此注解。

scheduler.alpha.kubernetes.io/preferAvoidPods (deprecated)

用于:Node

此注解需要启用 NodePreferAvoidPods 调度插件。 该插件自 Kubernetes 1.22 起已被弃用。 请改用污点和容忍度

下面列出的污点总是在 Node 上使用

node.kubernetes.io/not-ready

例子:node.kubernetes.io/not-ready:NoExecute

Node 控制器通过监控 Node 的健康状况来检测 Node 是否准备就绪,并相应地添加或删除此污点。

node.kubernetes.io/unreachable

例子:node.kubernetes.io/unreachable:NoExecute

Node 控制器将此污点添加到对应节点状况 ReadyUnknown 的 Node 上。

node.kubernetes.io/unschedulable

例子:node.kubernetes.io/unschedulable:NoSchedule

在初始化 Node 期间,为避免竞争条件,此污点将被添加到 Node 上。

node.kubernetes.io/memory-pressure

例子:node.kubernetes.io/memory-pressure:NoSchedule

kubelet 根据在 Node 上观察到的 memory.availableallocatableMemory.available 检测内存压力。 然后将观察到的值与可以在 kubelet 上设置的相应阈值进行比较,以确定是否应添加/删除 Node 状况和污点。

node.kubernetes.io/disk-pressure

例子:node.kubernetes.io/disk-pressure:NoSchedule

kubelet 根据在 Node 上观察到的 imagefs.availableimagefs.inodesFreenodefs.availablenodefs.inodesFree(仅限 Linux )检测磁盘压力。 然后将观察到的值与可以在 kubelet 上设置的相应阈值进行比较,以确定是否应添加/删除 Node 状况和污点。

node.kubernetes.io/network-unavailable

例子:node.kubernetes.io/network-unavailable:NoSchedule

当使用的云驱动指示需要额外的网络配置时,此注解最初由 kubelet 设置。 只有云上的路由被正确地配置了,此污点才会被云驱动移除

node.kubernetes.io/pid-pressure

例子:node.kubernetes.io/pid-pressure:NoSchedule

kubelet 检查 /proc/sys/kernel/pid_max 大小的 D 值和 Kubernetes 在 Node 上消耗的 PID, 以获取可用 PID 数量,并将其作为 pid.available 指标值。 然后该指标与在 kubelet 上设置的相应阈值进行比较,以确定是否应该添加/删除 Node 状况和污点。

node.cloudprovider.kubernetes.io/uninitialized

例子:node.cloudprovider.kubernetes.io/uninitialized:NoSchedule

在使用“外部”云驱动启动 kubelet 时,在 Node 上设置此污点以将其标记为不可用,直到来自 cloud-controller-manager 的控制器初始化此 Node,然后移除污点。

node.cloudprovider.kubernetes.io/shutdown

例子:node.cloudprovider.kubernetes.io/shutdown:NoSchedule

如果 Node 处于云驱动所指定的关闭状态,则 Node 会相应地被设置污点,对应的污点和效果为 node.cloudprovider.kubernetes.io/shutdownNoSchedule

pod-security.kubernetes.io/enforce

例子:pod-security.kubernetes.io/enforce: baseline

用于:Namespace

必须privilegedbaselinerestricted 之一,它们对应于 Pod 安全标准 级别。 特别地,enforce 标签 禁止 在带标签的 Namespace 中创建任何不符合指示级别要求的 Pod。

请请参阅在名字空间级别实施 Pod 安全性了解更多信息。

pod-security.kubernetes.io/enforce-version

例子:pod-security.kubernetes.io/enforce-version: 1.24

用于:Namespace

必须latest 或格式为 v<MAJOR>.<MINOR> 的有效 Kubernetes 版本。 此注解决定了在验证提交的 Pod 时要应用的 Pod 安全标准策略的版本。

请参阅在名字空间级别实施 Pod 安全性了解更多信息。

pod-security.kubernetes.io/audit

例子:pod-security.kubernetes.io/audit: baseline

用于:Namespace

必须是与 Pod 安全标准 级别相对应的 privilegedbaselinerestricted 之一。 具体来说,audit 标签不会阻止在带标签的 Namespace 中创建不符合指示级别要求的 Pod, 但会向该 Pod 添加审计注解。

请参阅在名字空间级别实施 Pod 安全性了解更多信息。

pod-security.kubernetes.io/audit-version

例子:pod-security.kubernetes.io/audit-version: 1.24

用于:Namespace

必须latest 或格式为 v<MAJOR>.<MINOR> 的有效 Kubernetes 版本。 此注解决定了在验证提交的 Pod 时要应用的 Pod 安全标准策略的版本。

请参阅在名字空间级别实施 Pod 安全性了解更多信息。

pod-security.kubernetes.io/warn

例子:pod-security.kubernetes.io/warn: baseline

用于:Namespace

必须是与 Pod 安全标准级别相对应的 privilegedbaselinerestricted 之一。特别地, warn 标签不会阻止在带标签的 Namespace 中创建不符合指示级别概述要求的 Pod,但会在这样做后向用户返回警告。 请注意,在创建或更新包含 Pod 模板的对象时也会显示警告,例如 Deployment、Jobs、StatefulSets 等。

请参阅在名字空间级别实施 Pod 安全性了解更多信息。

pod-security.kubernetes.io/warn-version

例子:pod-security.kubernetes.io/warn-version: 1.24

用于:Namespace

必须latest 或格式为 v<MAJOR>.<MINOR> 的有效 Kubernetes 版本。 此注解决定了在验证提交的 Pod 时要应用的 Pod 安全标准策略的版本。 请注意,在创建或更新包含 Pod 模板的对象时也会显示警告, 例如 Deployment、Jobs、StatefulSets 等。

请参阅在名字空间级别实施 Pod 安全性了解更多信息。

seccomp.security.alpha.kubernetes.io/pod (已弃用)

此注解自 Kubernetes v1.19 起已被弃用,将在 v1.25 中失效。 要为 Pod 指定安全设置,请在 Pod 规范中包含 securityContext 字段。 Pod 的 .spec 中的 securityContext 字段定义了 Pod 级别的安全属性。 你为 Pod 设置安全上下文 时, 你所给出的设置适用于该 Pod 中的所有容器。

container.seccomp.security.alpha.kubernetes.io/[NAME]

此注解自 Kubernetes v1.19 起已被弃用,将在 v1.25 中失效。 教程使用 seccomp 限制容器的系统调用将引导你完成将 seccomp 配置文件应用于 Pod 或其容器的步骤。 该教程介绍了在 Kubernetes 中配置 seccomp 的支持机制,基于在 Pod 的 .spec 中设置 securityContext

用于审计的注解

审计注解页面上查看更多详细信息。