設定服務說明

本頁面說明如何在 Cloud Run 服務中設定自訂說明。說明是附加至服務的選用人類可讀文字。說明的長度上限為 512 個半形字元。如果有，使用 gcloud run services describe 查看服務詳細資料時，系統會顯示說明。

必要的角色

如要取得設定及部署 Cloud Run 服務所需的權限，請要求管理員授予您下列 IAM 角色：

  • Cloud Run 服務中的 Cloud Run 開發人員 (roles/run.developer)
  • 服務身分中的「服務帳戶使用者」 (roles/iam.serviceAccountUser)

如需與 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"
    }
  }

}

將說明替換為您想要的值。