注解

你可以使用 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

下一步

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