使用标签

本页面介绍如何设置、修改和删除 Cloud Run 服务、修订版本及 Cloud Run 作业的标签。对于 Cloud Run,标签是应用于服务、修订版本或作业的键值对。请注意,在 Cloud Run 服务上设置标签时,系统会为此服务创建带有该标签的新修订版本;该标签不会应用于先前的修订版本。

可能的用途包括:

  • 用于费用分配和账单明细。
  • 确定各个团队或费用中心使用的资源
  • 区分部署环境(生产、预演、质量检查或测试)
  • 识别所有者、状态标签。
  • 在 Logging 中过滤日志

标签使用规则

以下规则适用于使用在 Cloud Run 服务或作业上设置的标签:

只允许在 Cloud Run 上使用有效的 Google Cloud 标签

设置或修改标签

您可以在 Cloud Run 服务和作业上设置标签。

对于 Cloud Run 服务

任何配置更改都会导致新修订版本的创建。后续修订版本也将自动采用此配置设置,除非您进行了明确更新。

您可以在部署新修订版本时使用 Google Cloud 控制台、gcloud 命令行或 YAML 文件来设置或修改标签。

控制台

  1. 转到 Cloud Run

  2. 选中要为其设置标签的服务左侧的复选框。

  3. 确保最右侧的“信息面板”已开启(显示信息面板)。

  4. 点击标签以显示标签窗格。

    设置标签

  5. 要修改现有标签键值对,请找到相应标签,然后根据需要更改值。

  6. 要为该服务设置新标签,请点击添加标签并提供键和值。

  7. 点击保存

命令行

您可以使用命令更新服务的标签:

gcloud run services update SERVICE --update-labels KEY=VALUE

要更新多个标签,请提供以英文逗号分隔的键值对列表。请注意,如果标签已存在,update-labels 命令会为标签键设置新值,否则它会创建新标签。

替换

  • SERVICE 替换为您的 Cloud Run 服务的名称
  • KEY 替换为您的标签键的名称
  • VALUE 替换为键的值

您还可以在部署期间设置标签:

gcloud run deploy SERVICE --image IMAGE --labels KEY=VALUE

要在部署期间创建多个标签,请提供以英文逗号分隔的键值对列表。

YAML

您可以使用 gcloud run services describe --format export 命令下载并查看现有服务配置,该命令会生成清理后的 YAML 格式的结果。然后按照后续说明修改字段,最后使用 gcloud run services replace 命令上传修改后的 YAML。请务必严格按照说明修改字段。

  1. 要查看和下载配置,请运行以下命令:

    gcloud run services describe SERVICE --format export > service.yaml
  2. 在两个位置更新 labels 特性:

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: SERVICE
      labels:
        LABEL: VALUE
    spec:
      template:
        metadata:
          labels:
            LABEL: VALUE
          name: REVISION

    替换

    • SERVICE 替换为您的 Cloud Run 服务的名称
    • LABEL 替换为标签的名称
    • VALUE 替换为所需的值
    • REVISION 替换为新的修订版本名称或者将其删除(如果存在)。如果您提供新的修订版本名称,则该名称必须满足以下条件:
      • 开头为 SERVICE-
      • 仅包含小写字母、数字和 -
      • 不以 - 结尾
      • 不超过 63 个字符

    metadata.labels 用于对服务对象设置标签,spec.template.metadata.label 用于对创建的修订版本设置标签。只有对修订版本设置的标签会传递给日志和结算。

  3. 使用以下命令将服务替换为其新配置:

    gcloud run services replace service.yaml

Terraform

如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令

以下代码段为 Cloud Run 实例添加了两个标签:foo(其值为 bar)和 baz(其值为 quux),并使用 Terraform 配置中的 google_cloud_run_service 资源。

如下所示,在 template 下添加标签会为修订版本设置标签:只有为修订版本设置的标签会传递给日志和结算。如果您向 template 以外的位置添加标签,则系统会为服务(而非修订版本)设置标签。

resource "google_cloud_run_service" "default" {
  name     = "cloudrun-service-labels"
  location = "us-central1"

  template {
    spec {
      containers {
        image = "us-docker.pkg.dev/cloudrun/container/hello"
      }
    }
    metadata {
      # Labels
      # https://cloud.google.com/run/docs/configuring/labels
      labels = {
        foo : "bar"
        baz : "quux"
      }
    }
  }
}

请替换以下内容

  • name 属性替换为您的服务名称。
  • location 属性替换为用于您的服务的位置。
  • image 属性设置为您的容器映像。
  • foobaz 替换为您自己的标签名称。
  • barquux 替换为您自己的标签值。

对于 Cloud Run 作业

您可以使用 Google Cloud CLI 或 YAML 在 Cloud Run 作业上设置标签。

命令行

  1. 如需在新作业上设置标签,请运行以下命令:

    gcloud run jobs create JOB_NAME --image IMAGE_URL --labels KEY=VALUE

    替换

    • JOB_NAME 替换为作业的名称。
    • KEY 替换为您的标签键的名称
    • VALUE 替换为键的值
    • IMAGE_URL 替换为对容器映像的引用,例如 us-docker.pkg.dev/cloudrun/container/job:latest
  2. 如需在现有作业上设置标签,请运行以下命令:

    gcloud run jobs update JOB_NAME --labels KEY=VALUE
  3. 如需创建多个标签,请提供以英文逗号分隔的键值对列表。

    gcloud run jobs update JOB_NAME --labels KEY1=VALUE1,KEY2=VALUE2 

YAML

使用 gcloud run jobs describe --format export 命令下载并查看现有作业配置,该命令会生成清理后的 YAML 格式的结果。然后,修改下述字段,并使用 gcloud run jobs replace 命令上传修改后的 YAML。请务必严格按照说明修改字段。

  1. 要查看和下载配置,请运行以下命令:

    gcloud run jobs describe JOB_NAME --format export > job.yaml
  2. 在两个位置更新 labels 特性:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      labels:
        LABEL: VALUE
    spec:
      template:
        metadata:
          labels:
            LABEL: VALUE

    替换

    • LABEL 替换为标签的名称
    • VALUE 替换为所需的值

    您还可以指定更多配置,例如环境变量或内存限制。

  3. 更新现有作业配置:

    gcloud run jobs replace job.yaml

按标签列出服务或作业

您可以使用 Google Cloud CLI 过滤条件按标签列出服务或作业:

对于服务:

  gcloud run services list --filter metadata.labels.LABEL=VALUE
  

对于作业:

  gcloud run jobs list --filter metadata.labels.LABEL=VALUE
  

替换

  • LABEL 替换为标签的名称
  • VALUE 替换为要包含在过滤列表中的值

在服务上删除标签

您可以使用控制台或命令行在服务上删除标签。

控制台

  1. 转到 Cloud Run

  2. 选中要从中删除标签的服务左侧的复选框。

  3. 确保最右侧的“信息面板”已开启(显示信息面板)。

  4. 点击标签以显示标签窗格。

  5. 找到您要删除的标签。

  6. 将光标悬停在标签对应的“值”文本框的右侧,以显示垃圾箱图标,然后点击该图标。

  7. 点击保存

命令行

要清除服务的所有标签,请使用以下命令:

gcloud run services update SERVICE --clear-labels

要删除服务的特定标签,请提供以英文逗号分隔的键列表:

gcloud run services update SERVICE --remove-labels LABEL

替换

  • SERVICE 替换为您的 Cloud Run 服务的名称
  • LABEL 替换为您的标签名称

删除作业上的标签

如需清除服务的所有标签,请使用以下命令:

gcloud run jobs update JOB --clear-labels

如需删除服务的特定标签,请提供以英文逗号分隔的键列表:

gcloud run jobs update JOB --remove-labels LABEL

Replace

  * <var>JOB</var> with name of your Cloud Run service
  * <var>LABEL</var> with the name of your label