推荐标签

你可以使用 kubectl 和仪表盘以外的更多工具来可视化和管理 Kubernetes 对象。一组通用的标签允许工具协同工作，以所有工具都能理解的通用方式描述对象。

除了支持工具之外，推荐标签以可查询的方式描述应用程序。

元数据围绕 应用程序 概念组织。Kubernetes 不是平台即服务 (PaaS)，并且没有或不强制执行正式的应用程序概念。相反，应用程序是非正式的，通过元数据描述。应用程序包含什么内容的定义是松散的。

共享标签和注解共享一个共同的前缀：app.kubernetes.io。没有前缀的标签是用户私有的。共享前缀可确保共享标签不会与自定义用户标签冲突。

标签

为了充分利用这些标签，它们应该应用于每个资源对象。

键描述示例类型
app.kubernetes.io/name应用程序的名称mysqlstring
app.kubernetes.io/instance标识应用程序实例的唯一名称mysql-abcxyzstring
app.kubernetes.io/version应用程序的当前版本（例如，SemVer 1.0、修订哈希等）5.7.21string
app.kubernetes.io/component架构内的组件databasestring
app.kubernetes.io/part-of此应用程序所属的更高级别应用程序的名称wordpressstring
app.kubernetes.io/managed-by用于管理应用程序操作的工具Helmstring

为了说明这些标签的作用，请考虑以下 StatefulSet 对象

# This is an excerpt
apiVersion: apps/v1
kind: StatefulSet
metadata:
  labels:
    app.kubernetes.io/name: mysql
    app.kubernetes.io/instance: mysql-abcxyz
    app.kubernetes.io/version: "5.7.21"
    app.kubernetes.io/component: database
    app.kubernetes.io/part-of: wordpress
    app.kubernetes.io/managed-by: Helm

应用程序和应用程序实例

一个应用程序可以安装到 Kubernetes 集群中一次或多次，在某些情况下，也可以安装到同一个命名空间。例如，WordPress 可以安装多次，其中不同的网站是 WordPress 的不同安装。

应用程序的名称和实例名称是分开记录的。例如，WordPress 的 app.kubernetes.io/name 为 wordpress，而它的实例名称（表示为 app.kubernetes.io/instance，值为 wordpress-abcxyz）与应用程序名称分开。这使得应用程序和应用程序的实例都可以被识别。应用程序的每个实例都必须有一个唯一的名称。

示例

为了说明使用这些标签的不同方式，以下示例具有不同的复杂性。

一个简单的无状态服务

考虑使用 Deployment 和 Service 对象部署的简单无状态服务。以下两个片段表示标签如何以最简单的形式使用。

Deployment 用于监督运行应用程序本身的 Pod。

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app.kubernetes.io/name: myservice
    app.kubernetes.io/instance: myservice-abcxyz
...

Service 用于暴露应用程序。

apiVersion: v1
kind: Service
metadata:
  labels:
    app.kubernetes.io/name: myservice
    app.kubernetes.io/instance: myservice-abcxyz
...

带有数据库的 Web 应用程序

考虑一个稍微复杂的应用程序：一个使用数据库（MySQL）的 Web 应用程序（WordPress），使用 Helm 安装。以下片段说明了用于部署此应用程序的对象的开头。

以下 Deployment 的开头用于 WordPress

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app.kubernetes.io/name: wordpress
    app.kubernetes.io/instance: wordpress-abcxyz
    app.kubernetes.io/version: "4.9.4"
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/component: server
    app.kubernetes.io/part-of: wordpress
...

Service 用于暴露 WordPress

apiVersion: v1
kind: Service
metadata:
  labels:
    app.kubernetes.io/name: wordpress
    app.kubernetes.io/instance: wordpress-abcxyz
    app.kubernetes.io/version: "4.9.4"
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/component: server
    app.kubernetes.io/part-of: wordpress
...

MySQL 作为 StatefulSet 暴露，其中包含其自身的元数据以及其所属的更大应用程序的元数据

apiVersion: apps/v1
kind: StatefulSet
metadata:
  labels:
    app.kubernetes.io/name: mysql
    app.kubernetes.io/instance: mysql-abcxyz
    app.kubernetes.io/version: "5.7.21"
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/component: database
    app.kubernetes.io/part-of: wordpress
...

Service 用于将 MySQL 作为 WordPress 的一部分暴露

apiVersion: v1
kind: Service
metadata:
  labels:
    app.kubernetes.io/name: mysql
    app.kubernetes.io/instance: mysql-abcxyz
    app.kubernetes.io/version: "5.7.21"
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/component: database
    app.kubernetes.io/part-of: wordpress
...

在 MySQL 的 StatefulSet 和 Service 中，你会注意到其中包含了 MySQL 和其所属的更大应用程序 WordPress 的信息。

最后修改于 2024 年 4 月 25 日太平洋标准时间凌晨 1:16：更新 common-labels.md (4e973d44ba)