推荐标签

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

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

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

共享标签和注解共享一个公共前缀：app.kubernetes.io。没有前缀的标签是用户私有的。共享前缀确保共享标签不会干扰自定义用户标签。

标签

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

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

为了说明这些标签的实际应用，请考虑以下 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 用于公开作为 WordPress 一部分的 MySQL

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)