Kubernetes对象-注解

最新推荐文章于 2025-08-29 10:37:09 发布

qichengzong_right

最新推荐文章于 2025-08-29 10:37:09 发布

阅读量1.2k

点赞数 40

CC 4.0 BY-SA版权

分类专栏：云原生 kubernetes linux 文章标签：云原生 kubernetes linux

本文链接：https://blog.csdn.net/qichengzong_right/article/details/144699759

linux 同时被 3 个专栏收录

81 篇文章

订阅专栏

云原生

46 篇文章

订阅专栏

kubernetes

36 篇文章

订阅专栏

Kubernetes 注解

可以使用 Kubernetes 注解将任意非标识元数据附加到对象上。客户端（如工具和库）可以检索此元数据。

将元数据附加到对象

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

注解和标签一样，是键/值映射：

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

Map 中的键和值必须是字符串。换句话说，不能对键或值使用 numeric、boolean、list 或其他类型。

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

由声明式配置层管理的字段。将这些字段附加为注解可将它们与客户端或服务器设置的默认值区分开来，也与自动生成的字段和由自动调整大小或自动缩放系统设置的字段区分开来。
构建、发布或镜像信息，例如时间戳、发布ID、Git分支、PR编号、镜像哈希和仓库地址。
指向日志记录、监控、分析或审计存储库的指针。
可用于调试目的的客户端库或工具信息：例如名称、版本和构建信息。
用户或工具/系统的来源信息，如来自其他生态系统组件的相关对象的URL。
轻量级部署工具元数据：例如配置或检查点。
负责人的电话或寻呼机号码，或指定在哪里可以找到这些信息的目录条目，比如团队网站。
最终用户对实现的指令，以修改行为或启用非标准特性。

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

语法和字符集

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

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

kubernetes.io/和 k8s.io/ 前缀是为 Kubernetes 核心组件保留的。

例如，下面是一个具有注解 imageregistry 的 Pod 的manifest 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

链接

Kubernetes Object Annotations