ワーカープールの説明を設定する

このページでは、Cloud Run ワーカープールにカスタムの説明を設定する方法について説明します。説明は、ワーカープールに添付できる、人が読める形式のテキストです。

説明の長さは 512 文字以内に制限されています。説明がある場合は、gcloud beta run worker-pools describe を使用してワーカープールの詳細を表示すると確認できます。

必要なロール

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

Cloud Run のワーカープールに対する Cloud Run デベロッパー（roles/run.developer）
サービス ID に対するサービスアカウントユーザー（roles/iam.serviceAccountUser）

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

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

新しいワーカープールを作成する際に、Google Cloud CLI を使用して Cloud Run ワーカープールに説明を設定します。

gcloud

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

gcloud beta run worker-pools deploy WORKER_POOL --description DESCRIPTION

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

WORKER_POOL: Cloud Run ワーカープールの名前
DESCRIPTION: ワーカープールの説明

YAML

新しいワーカープールを作成する場合は、この手順をスキップします。既存のワーカープールを更新する場合は、その YAML 構成をダウンロードします。
```
gcloud beta run worker-pools describe WORKER_POOL --format export > workerpool.yaml
```

次の例には、YAML 構成が含まれています。

apiVersion: run.googleapis.com/v1
kind: WorkerPool
metadata:
  name: WORKER_POOL
  annotations:
    run.googleapis.com/launch-stage: BETA
    run.googleapis.com/description: DESCRIPTION

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

WORKER_POOL: Cloud Run ワーカープールの名前
DESCRIPTION: ワーカープールの説明

次のコマンドを使用して、ワーカープールを作成または更新します。
```
gcloud beta run worker-pools replace workerpool.yaml
```

Terraform

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

resource "google_cloud_run_v2_worker_pool" "default" {
  name     = "WORKER_POOL"
  location = "REGION"
  launch_stage = "BETA"

  template {
    containers {
      image = "IMAGE_URL"
    }
  }
  description = "DESCRIPTION"
}

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

WORKER_POOL: ワーカープールの名前
REGION: Google Cloud リージョン（europe-west1 など）
IMAGE_URL: ワーカープールを含むコンテナイメージへの参照（us-docker.pkg.dev/cloudrun/container/worker-pool:latest など）
DESCRIPTION: ワーカープールの説明

ワーカープールの説明を設定する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

必要なロール

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

gcloud

YAML

Terraform

ワーカープールの説明を設定する