説明を設定する（サービス）

このページでは、Cloud Run サービスにカスタム説明を設定する方法について説明します。説明とは、オプションでサービスに添付できる、人が読める形式のテキストです。説明の長さは 512 文字以内に制限されています。説明がある場合は、gcloud run services describe を使用してサービスの詳細を表示すると、その説明が表示されます。

必要なロール

Cloud Run サービスの構成とデプロイに必要な権限を取得するには、次の IAM ロールを付与するよう管理者に依頼してください。

Cloud Run に関連付けられている IAM ロールと権限のリストについては、Cloud Run IAM ロールと Cloud Run IAM 権限をご覧ください。Cloud Run サービスが Google Cloud APIs（Cloud クライアント ライブラリなど）と連携している場合は、サービス ID の構成ガイドをご覧ください。ロールの付与の詳細については、デプロイ権限とアクセスの管理をご覧ください。

説明を設定または変更する

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 コマンドをご覧ください。

次の google_cloud_run_v2_service リソースは、説明を指定します。説明（description）は目的の値に置き換えてください。

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"
    }
  }

}