标签和选择器

标签（Labels）是附加到 对象（例如 Pod）的键值对。标签旨在用于指定对用户有意义且相关的对象的识别属性，但它们不会直接赋予核心系统语义。标签可用于组织和选择对象的子集。标签可以在创建时附加到对象，并在之后随时添加和修改。每个对象可以定义一组键值对标签。给定对象中的每个 Key 都必须是唯一的。

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

标签允许高效查询和监听，非常适合在 UI 和 CLI 中使用。非识别信息应使用注解（Annotations）进行记录。

动机

标签使用户能够以松散耦合的方式将其组织结构映射到系统对象上，而无需客户端存储这些映射关系。

Service 部署和批处理流水线通常是多维实体（例如，多个分区或部署、多个发布轨道、多个层级、每层级的多个微服务）。管理通常需要跨领域操作，这打破了严格的层级表示的封装，特别是那些由基础设施而非用户确定的僵化层级结构。

示例标签

• "release" : "stable", "release" : "canary"
• "environment" : "dev", "environment" : "qa", "environment" : "production"
• "tier" : "frontend", "tier" : "backend", "tier" : "cache"
• "partition" : "customerA", "partition" : "customerB"
• "track" : "daily", "track" : "weekly"

以上是常用标签的示例；您可以自由开发自己的约定。请记住，给定对象的标签 Key 必须是唯一的。

语法和字符集

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

如果省略前缀，标签 Key 被假定为用户私有。将标签添加到最终用户对象的自动化系统组件（例如 kube-scheduler、kube-controller-manager、kube-apiserver、kubectl 或其他第三方自动化工具）必须指定前缀。

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

有效的标签值

• 必须小于等于 63 个字符（可以为空），
• 除非为空，必须以字母数字字符（[a-z0-9A-Z]）开头和结尾，
• 可以包含短划线（-）、下划线（_）、点（.）和中间的字母数字。

例如，这是一个 Pod 的清单，它有两个标签 environment: production 和 app: nginx

apiVersion: v1
kind: Pod
metadata:
  name: label-demo
  labels:
    environment: production
    app: nginx
spec:
  containers:
  - name: nginx
    image: nginx:1.14.2
    ports:
    - containerPort: 80

标签选择器

与名称和 UID 不同，标签不提供唯一性。通常，我们预计许多对象会带有相同的一个或多个标签。

通过标签选择器，客户端/用户可以识别一组对象。标签选择器是 Kubernetes 中的核心分组原语。

API 目前支持两种类型的选择器：基于相等的和基于集合的。标签选择器可以由逗号分隔的多个需求组成。在有多个需求的情况下，所有需求都必须满足，因此逗号分隔符充当逻辑与（&&）操作符。

空白或未指定的选择器的语义取决于上下文，使用选择器的 API 类型应记录其有效性和含义。

基于相等的需求

基于相等或基于不相等的需求允许按标签 Key 和值进行过滤。匹配的对象必须满足所有指定的标签约束，尽管它们可能还有额外的标签。允许使用三种操作符：=、==、!=。前两种表示相等（并且是同义词），而后者表示不相等。例如

environment = production
tier != frontend

前者选择所有 Key 等于 environment 且值等于 production 的资源。后者选择所有 Key 等于 tier 且值不同于 frontend 的资源，以及所有没有带有 tier Key 的标签的资源。可以使用逗号操作符过滤 production 中排除 frontend 的资源：environment=production,tier!=frontend

基于相等的标签需求的一种使用场景是让 Pod 指定节点选择标准。例如，下面的示例 Pod 选择存在 accelerator 标签且其值设置为 nvidia-tesla-p100 的节点。

apiVersion: v1
kind: Pod
metadata:
  name: cuda-test
spec:
  containers:
    - name: cuda-test
      image: "registry.k8s.io/cuda-vector-add:v0.1"
      resources:
        limits:
          nvidia.com/gpu: 1
  nodeSelector:
    accelerator: nvidia-tesla-p100

基于集合的需求

基于集合的标签需求允许根据一组值过滤 Key。支持三种操作符：in、notin 和 exists（仅 Key 标识符）。例如

environment in (production, qa)
tier notin (frontend, backend)
partition
!partition

• 第一个示例选择所有 Key 等于 environment 且值等于 production 或 qa 的资源。
• 第二个示例选择所有 Key 等于 tier 且值不是 frontend 或 backend 的资源，以及所有没有带有 tier Key 的标签的资源。
• 第三个示例选择所有包含带有 Key partition 的标签的资源；不检查值。
• 第四个示例选择所有不包含带有 Key partition 的标签的资源；不检查值。

同样，逗号分隔符充当逻辑与操作符。因此，要过滤带有 partition Key（无论值是什么）且 environment 不同于 qa 的资源，可以使用 partition,environment notin (qa)。基于集合的标签选择器是基于相等形式的泛化，因为 environment=production 等价于 environment in (production)；!= 和 notin 也类似。

基于集合的需求可以与基于相等的需求混合使用。例如：partition in (customerA, customerB),environment!=qa。

API

LIST 和 WATCH 过滤

对于 list 和 watch 操作，您可以指定标签选择器来过滤返回的对象集合；您可以使用查询参数指定过滤器。（要详细了解 Kubernetes 中的监听，请阅读更改的有效检测）。两种需求都允许（在此呈现为它们在 URL 查询字符串中出现的样子）

• 基于相等的需求：?labelSelector=environment%3Dproduction,tier%3Dfrontend
• 基于集合的需求：?labelSelector=environment+in+%28production%2Cqa%29%2Ctier+in+%28frontend%29

两种标签选择器风格都可以用于通过 REST 客户端 list 或 watch 资源。例如，使用 kubectl 定位到 apiserver 并使用基于相等的选择器，可以这样写

kubectl get pods -l environment=production,tier=frontend

或者使用基于集合的需求

kubectl get pods -l 'environment in (production),tier in (frontend)'

如前所述，基于集合的需求表达能力更强。例如，它们可以实现值上的或操作符

kubectl get pods -l 'environment in (production, qa)'

或者通过 notin 操作符限制否定匹配

kubectl get pods -l 'environment,environment notin (frontend)'

API 对象中的集合引用

一些 Kubernetes 对象，例如 services 和 replicationcontrollers，也使用标签选择器来指定其他资源的集合，例如 pods。

Service 和 ReplicationController

service 目标 Pod 的集合是用标签选择器定义的。类似地，replicationcontroller 应该管理的 Pod 的集合也用标签选择器定义。

这两种对象的标签选择器都在 json 或 yaml 文件中通过映射定义，并且只支持基于相等的需求选择器。

"selector": {
    "component" : "redis",
}

或者

selector:
  component: redis

这个选择器（分别以 json 或 yaml 格式）等价于 component=redis 或 component in (redis)。

支持基于集合的需求的资源

较新的资源，例如 Job、Deployment、ReplicaSet 和 DaemonSet，也支持基于集合的需求。

selector:
  matchLabels:
    component: redis
  matchExpressions:
    - { key: tier, operator: In, values: [cache] }
    - { key: environment, operator: NotIn, values: [dev] }

matchLabels 是一个 {key,value} 对的映射。matchLabels 映射中的单个 {key,value} 等价于 matchExpressions 中的一个元素，该元素的 key 字段是 "key"，operator 是 "In"，并且 values 数组只包含 "value"。matchExpressions 是 Pod 选择器需求的列表。有效的操作符包括 In, NotIn, Exists 和 DoesNotExist。对于 In 和 NotIn，值集合必须非空。来自 matchLabels 和 matchExpressions 的所有需求通过逻辑与（AND）组合在一起——它们必须全部满足才能匹配。

选择节点集合

基于标签进行选择的一种用例是约束 Pod 可以调度到的节点集合。有关更多信息，请参阅节点选择的文档。

有效使用标签

您可以向任何资源应用单个标签，但这并不总是最佳实践。在许多场景中，应该使用多个标签来区分不同的资源集合。

例如，不同的应用会使用不同的 app 标签值，但像guestbook 示例这样的多层应用，还需要区分每个层级。前端可以带有以下标签

labels:
  app: guestbook
  tier: frontend

而 Redis 主节点和副本会带有不同的 tier 标签，甚至可能还有一个额外的 role 标签

labels:
  app: guestbook
  tier: backend
  role: master

和

labels:
  app: guestbook
  tier: backend
  role: replica

标签允许根据标签指定的任何维度对资源进行切片和细分

kubectl apply -f examples/guestbook/all-in-one/guestbook-all-in-one.yaml
kubectl get pods -Lapp -Ltier -Lrole

NAME                           READY  STATUS    RESTARTS   AGE   APP         TIER       ROLE
guestbook-fe-4nlpb             1/1    Running   0          1m    guestbook   frontend   <none>
guestbook-fe-ght6d             1/1    Running   0          1m    guestbook   frontend   <none>
guestbook-fe-jpy62             1/1    Running   0          1m    guestbook   frontend   <none>
guestbook-redis-master-5pg3b   1/1    Running   0          1m    guestbook   backend    master
guestbook-redis-replica-2q2yf  1/1    Running   0          1m    guestbook   backend    replica
guestbook-redis-replica-qgazl  1/1    Running   0          1m    guestbook   backend    replica
my-nginx-divi2                 1/1    Running   0          29m   nginx       <none>     <none>
my-nginx-o0ef1                 1/1    Running   0          29m   nginx       <none>     <none>

kubectl get pods -lapp=guestbook,role=replica

NAME                           READY  STATUS   RESTARTS  AGE
guestbook-redis-replica-2q2yf  1/1    Running  0         3m
guestbook-redis-replica-qgazl  1/1    Running  0         3m

更新标签

有时您可能想在创建新资源之前重新标记现有的 Pod 和其他资源。这可以使用 kubectl label 完成。例如，如果您想将所有 NGINX Pod 标记为前端层级，运行

kubectl label pods -l app=nginx tier=fe

pod/my-nginx-2035384211-j5fhi labeled
pod/my-nginx-2035384211-u2c7e labeled
pod/my-nginx-2035384211-u3t6x labeled

这首先过滤所有带有 "app=nginx" 标签的 Pod，然后将它们标记为 "tier=fe"。要查看您标记的 Pod，运行

kubectl get pods -l app=nginx -L tier

NAME                        READY     STATUS    RESTARTS   AGE       TIER
my-nginx-2035384211-j5fhi   1/1       Running   0          23m       fe
my-nginx-2035384211-u2c7e   1/1       Running   0          23m       fe
my-nginx-2035384211-u3t6x   1/1       Running   0          23m       fe

这将输出所有 "app=nginx" 的 Pod，并带有一个额外的 Pod 层级标签列（使用 -L 或 --label-columns 指定）。

有关更多信息，请参阅 kubectl label。

下一步

• 学习如何向节点添加标签
• 查找常用标签、注解和污点
• 查看推荐标签
• 使用命名空间标签强制实施 Pod 安全标准
• 阅读一篇关于为 Pod 标签编写控制器的博客