注解

你可以使用 Kubernetes 注解为对象附加任意的非识别性元数据。客户端（例如工具和库）可以检索这些元数据。

为对象附加元数据

你可以使用标签或注解为 Kubernetes 对象附加元数据。标签可用于选择对象并查找满足特定条件的对象集合。相比之下，注解不用于识别和选择对象。注解中的元数据可以很小或很大，结构化或非结构化，并且可以包含标签不允许的字符。可以在同一个对象的元数据中使用标签和注解。

注解，就像标签一样，是键/值映射。

"metadata": {
  "annotations": {
    "key1" : "value1",
    "key2" : "value2"
  }
}

以下是一些可以在注解中记录的信息示例：

• 由声明式配置层管理的字段。将这些字段作为注解附加，可以将其与客户端或服务器设置的默认值以及自动生成字段、自动扩缩系统设置的字段区分开来。

• 构建、发布或镜像信息，例如时间戳、发布 ID、Git 分支、PR 编号、镜像哈希值和注册表地址。

• 指向日志、监控、分析或审计仓库的指针。

• 可用于调试的客户端库或工具信息：例如，名称、版本和构建信息。

• 用户或工具/系统来源信息，例如来自其他生态系统组件的相关对象的 URL。

• 轻量级发布工具元数据：例如，配置或检查点。

• 负责人的电话或寻呼机号码，或指定可以在何处找到该信息的目录条目，例如团队网站。

• 最终用户向实现发出的指令，用于修改行为或启用非标准功能。

除了使用注解，你还可以将此类信息存储在外部数据库或目录中，但这会使为部署、管理、自省等生成共享客户端库和工具变得更加困难。

语法和字符集

_注解_是键/值对。有效的注解键有两个部分：可选的前缀和名称，由斜杠（/）分隔。名称部分是必需的，长度必须小于或等于 63 个字符，以字母数字字符（[a-z0-9A-Z]）开头和结尾，中间可以包含破折号（-）、下划线（_）、点（.）和字母数字。前缀是可选的。如果指定，前缀必须是一个 DNS 子域：一系列由点（.）分隔的 DNS 标签，总长度不超过 253 个字符，后跟斜杠（/）。

如果省略前缀，则假定注解键对用户是私有的。向最终用户对象添加注解的自动化系统组件（例如 kube-scheduler、kube-controller-manager、kube-apiserver、kubectl 或其他第三方自动化）必须指定前缀。

kubernetes.io/ 和 k8s.io/ 前缀保留给 Kubernetes 核心组件使用。

例如，这是一个 Pod 的清单，它带有一个注解 imageregistry: https://hub.docker.com/

apiVersion: v1
kind: Pod
metadata:
  name: annotations-demo
  annotations:
    imageregistry: "https://hub.docker.com/"
spec:
  containers:
  - name: nginx
    image: nginx:1.14.2
    ports:
    - containerPort: 80

下一步

• 了解更多关于标签和选择器的信息。
• 查找众所周知的标签、注解和污点