説明（サービス）

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

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

Cloud Run サービスに説明を設定できます。

コマンドライン

デプロイ時に説明を設定または変更できます。

gcloud run deploy SERVICE --description DESCRIPTION

次のように置き換えます。

SERVICE は、Cloud Run サービスの名前に置き換えます。
DESCRIPTION は、サービスの説明に置き換えます。

YAML

既存のサービス構成をダウンロードして表示するには、gcloud run services describe --format export コマンドを使用します。読みやすく整えられた結果が YAML 形式で出力されます。次に、下記の手順でフィールドを変更し、gcloud run services replace コマンドを使用して変更後の YAML ファイルをアップロードします。必ず説明されているとおりにフィールドを変更してください。

次のコマンドで、構成を表示してダウンロードします。
```
gcloud run services describe SERVICE --format export > service.yaml
```
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 は、サービスの説明に置き換えます。
次のコマンドを使用して、サービスを新しい構成に置き換えます。
```
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"

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

}