设置服务说明

本页面介绍了如何在 Cloud Run 服务上设置自定义说明。说明是附加到服务的易于用户理解的可选文本。说明的长度不得超过 512 个字符。如果存在说明，则使用 gcloud run services describe 查看服务的详细信息时会显示说明。

所需的角色

如需获得配置和部署 Cloud Run 服务所需的权限，请让您的管理员为您授予以下 IAM 角色：

如果您要从源代码部署服务或函数，则还必须向您的项目和 Cloud Build 服务账号授予其他角色。

如需查看与 Cloud Run 关联的 IAM 角色和权限的列表，请参阅 Cloud Run IAM 角色和 Cloud Run IAM 权限。如果您的 Cloud Run 服务与Google Cloud API（例如 Cloud 客户端库）进行交互，请参阅服务身份配置指南。如需详细了解如何授予角色，请参阅部署权限和管理访问权限。

设置或修改说明

您可以为 Cloud Run 服务设置说明。

gcloud

您可以在部署期间设置或更新说明：

gcloud run deploy SERVICE --description DESCRIPTION

进行如下替换

  • 将 SERVICE 替换为您的 Cloud Run 服务的名称
  • 将 DESCRIPTION 替换为该服务的说明

YAML

  1. 如果您要创建新的服务，请跳过此步骤。如果您要更新现有服务，请下载其 YAML 配置：

    gcloud run services describe SERVICE --format export > service.yaml

  2. 更新 run.googleapis.com/description 注释：

    apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: SERVICE
  annotations:
    run.googleapis.com/description: "DESCRIPTION"
spec:
  template:
    ...

    进行如下替换

    • 将 SERVICE 替换为您的 Cloud Run 服务的名称
    • 将 DESCRIPTION 替换为该服务的说明

  3. 使用以下命令创建或更新服务：

    gcloud run services replace service.yaml

Terraform

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

将以下内容添加到 Terraform 配置中的 google_cloud_run_v2_service 资源：

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-description"
  location = "us-central1"

  description = "This service has a custom description"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"
    }
  }

}

将说明替换为所需的值。