容器与云原生 / 系统课时
标签与注解
标签与注解
Label 和 Annotation 都存放在 Kubernetes 对象元数据中,但职责不同:Label 用于选择、分组和关联资源,Annotation 用于保存控制器、工具或运维人员需要的扩展信息。本节通过两个 Pod 演示写入、筛选和读取方式。
学习目标
- 区分 Label 与 Annotation 的用途和边界
- 使用 Label Selector 精确筛选一组资源
- 为资源写入并读取非标识性 Annotation
两类元数据的职责边界
Label 是可被选择器查询的键值对,适合表达 app、env、tier、版本等稳定维度。Service、Deployment、NetworkPolicy 等对象都可能依赖 Label Selector 建立资源关系,因此标签不仅是“备注”,还可能直接影响流量和控制范围。
Annotation 不参与 Label Selector,适合保存负责人、构建编号、外部文档地址、控制器参数等扩展信息。它可以承载比 Label 更自由的字符串,但不应存放密码、令牌等敏感数据;敏感值应使用 Secret 等专门机制。
| 维度 | Label | Annotation |
|---|---|---|
| 资源筛选 | 支持 Label Selector | 不支持 |
| 常见用途 | 分组、选择、关联 | 说明、工具参数、外部信息 |
| 是否影响控制关系 | 经常会 | 仅在控制器显式读取时会 |
给 Pod 写入标签与注解
下面使用一个 List 一次创建两个 Pod。两个对象都属于 shop 应用,但环境标签不同;生产 Pod 额外带有负责人和运行手册注解。
apiVersion: v1
kind: List
items:
- apiVersion: v1
kind: Pod
metadata:
name: shop-prod
labels:
app: shop
env: prod
tier: web
annotations:
example.com/owner: platform-team
example.com/runbook: https://docs.example.com/shop
spec:
containers:
- name: web
image: nginx:1.27
- apiVersion: v1
kind: Pod
metadata:
name: shop-dev
labels:
app: shop
env: dev
tier: web
annotations:
example.com/owner: app-team
spec:
containers:
- name: web
image: nginx:1.27保存为 metadata-demo.yaml 后应用。这里使用带域名前缀的注解键,是为了避免不同工具或团队定义同名键时发生冲突。
用选择器筛选并读取注解
执行创建、筛选和读取操作:
kubectl apply -f metadata-demo.yaml
kubectl get pods -l 'app=shop,env=prod' -o name
kubectl get pod shop-prod -o jsonpath='{.metadata.annotations.example\.com/owner}'预期输出:
pod/shop-prod created
pod/shop-dev created
pod/shop-prod
platform-team如果资源此前已经存在,前两行可能显示 configured 或 unchanged。筛选结果只包含 shop-prod,说明 -l 使用的是 Label;最后一行直接读取 Annotation,它不会参与前面的选择条件。
修改标签前先判断影响范围
Label 常被其他对象当作“连接条件”。如果某个 Service 通过 app=shop,env=prod 选择后端 Pod,把 shop-prod 的 env 改成其他值,会让它立即脱离该 Service 的候选端点。修改关键标签前应先检查有哪些选择器依赖它。
Annotation 通常适合记录不用于身份选择的信息,但并不代表它永远“无副作用”。一些 Ingress、Operator 或自定义控制器会主动解释特定 Annotation,因此修改已被控制器约定的注解时,同样需要先确认其行为。