Set worker pool descriptions

This page shows how to set a custom description on your Cloud Run worker pools. A description is optional human-readable text attached to the worker pool.

A description is limited to 512 characters. If present, the description is displayed when viewing details of a worker pool using gcloud beta run worker-pools describe.

Required roles

To get the permissions that you need to configure and deploy Cloud Run worker pools, ask your administrator to grant you the following IAM roles:

Cloud Run Developer (roles/run.developer) on the Cloud Run worker pool
Service Account User (roles/iam.serviceAccountUser) on the service identity

For a list of IAM roles and permissions that are associated with Cloud Run, see Cloud Run IAM roles and Cloud Run IAM permissions. If your Cloud Run worker pool interfaces with Google Cloud APIs, such as Cloud Client Libraries, see the service identity configuration guide. For more information about granting roles, see deployment permissions and manage access.

Set or modify a description

Set a description on Cloud Run worker pools using the Google Cloud CLI when you create a new worker pool:

gcloud

You can set or update the description during deployment:

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

Replace the following:

WORKER_POOL: the name of your Cloud Run worker pool
DESCRIPTION: the description of the worker pool

Terraform

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

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

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