Console

1. In the Google Cloud console, go to Cloud Run:

   Go to Cloud Run

2. SelectWorker pools from the menu, and clickDeploy container todisplay theCreate worker pool form.

   1. In the form, specify the container image.

   2. Enter the worker pool name. Worker pool names must be 49 charactersor less and must be unique per region and project. You can't share thesame name as anexisting service name from your project. Aworker pool name cannot be changed later and is publicly visible.

   3. Select theregion where you want your worker located.The region selector indicatesprice tier and highlightsregions with thelowest carbon impact.

   4. UnderScaling, specify the number of instances for the worker pool.

3. ClickContainer(s), Volumes, Networking, Security to set other optional settings in theappropriate tabs:

   • Container configuration
   • CPU limits
   • Memory limits
   • Environment variables
   • Service accounts
   • Connect to a VPC network foregress and ingress.

4. When you are finished configuring your worker pool, clickCreate todeploy the image to Cloud Run and wait for the deployment to finish.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, aCloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. To deploy a worker pool container image:

   1. Run the following command:

      gcloud beta run worker-pools deployWORKER_POOL --imageIMAGE_URL

      Replace the following:

      • WORKER_POOL: the name of the worker pool you want todeploy to. If the worker pool does not exist yet, this command creates theworker pool during the deployment. You can omit this parameter entirely,but you will be prompted for the worker pool name if you omit it. Worker pool names must be 49 characters or fewer, use a unique name per region and project, and must not share the same name as anexisting service name from your project.
      • IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest. Note that if you don't supply the--imageflag, the deploy command attempts todeploy from source code.

   2. Wait for the deployment to finish. Upon successful completion,Cloud Run displays a success message along with the revision information about the deployed worker pool.

      To deploy to a different location from the one you set using therun/regiongcloud properties, use:

      gcloud beta run worker-pools deployWORKER_POOL --regionREGION

Terraform

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

resource"google_cloud_run_v2_worker_pool""default"{name="WORKER_POOL"location="REGION"launch_stage="BETA"template{containers{image="IMAGE_URL"}}}

Replace the following:

• WORKER_POOL: the name of the worker pool.
• REGION: the Google Cloud region—for example,europe-west1.
• IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest.

REST API

To deploy a new worker pool, send aPOST HTTP request tothe Cloud Run Admin API worker poolscreate endpoint.

For example, usingcurl:

curl-H"Content-Type: application/json"\-H"Authorization: BearerACCESS_TOKEN"\-XPOST\-d'{"launchStage":"BETA",template: {containers: [{image: "IMAGE_URL"}]}}'\https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/workerPools?workerPoolId=WORKER_POOL

Replace the following:

• ACCESS_TOKEN: a valid access token for an account thathas theIAM permissions to deploy services.For example, if you are logged into gcloud, you can retrieve anaccess token usinggcloud auth print-access-token.From within a Cloud Run container instance, you can retrievean access token using thecontainer instance metadata server.
• IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest.
• REGION: the Google Cloud region—for example,europe-west1.
• PROJECT_ID: the Google Cloud project ID.
  • WORKER_POOL: the name of the worker pool.

Console

1. In the Google Cloud console, go to Cloud Run:

   Go to Cloud Run

2. SelectWorker pools from the menu, select the worker pool to update,then clickEdit and deploy new revision to display theDeploy worker pool revision form.

   1. If needed, specify the URL to the new container image to be deployed.

   2. Configure the containeras needed.

   3. If needed, update the number of instances for the worker pool.

3. If needed, clickContainer(s), Volumes, Networking, Security to set other optional settings in theappropriate tabs:

   • Container configuration
   • CPU limits
   • Memory limits
   • Environment variables
   • Service accounts
   • Connect to a VPC network foregress and ingress.

4. When you finish updating your worker pool, clickDeploy.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, aCloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. To deploy a container image:

   1. Run the command:

      gcloud beta run worker-pools deployWORKER_POOL --imageIMAGE_URL

      Replace the following:

      • WORKER_POOL: the name of the worker pool you want todeploy to. If the worker pool does not exist yet, this command creates theworker pool during the deployment. You can omit this parameter entirely,but you will be prompted for the worker pool name if you omit it. Worker pool names must be 49 characters or fewer, use a unique name per region and project, and must not share the same name as anexisting service name from your project.
      • IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest. Note that if you don't supply the--imageflag, the deploy command attempts todeploy from source code.

      The revision suffix is assigned automatically for new revisions. If youwant to supply your own revision suffix, use the gcloud CLIparameter--revision-suffix.

   2. Wait for the deployment to finish. Upon successful completion,Cloud Run displays a success message along with the revision information about the deployed worker pool.

YAML

1. Download the worker poolYAML configuration:

   gcloudbetarunworker-poolsdescribeWORKER_POOL--formatexport>workerpool.yaml

2. Make a change to the configuration file.

3. Update the worker pool using the following command:

   gcloudbetarunworker-poolsreplaceworkerpool.yaml

Terraform

Make sure you have set up Terraform as described in theDeploying a new worker pool example.

1. Make a change to the configuration file.

2. Apply the Terraform configuration:

   terraform apply

   Confirm you want to apply the actions described by enteringyes.

REST API

To deploy a new worker pool, send aPATCH HTTP request tothe Cloud Run Admin APIworker pools endpoint.

To create a new revision from the template even if the system doesn'tdetect any changes from the previously deployed revision, set the queryparameterforceNewRevision totrue.

For example, usingcurl:

curl-H"Content-Type: application/json"\-H"Authorization: BearerACCESS_TOKEN"\-XPATCH\-d'{"launchStage":"BETA",template: {containers: [{image: "IMAGE_URL"}]}}'\https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/workerPools/WORKER_POOL>?forceNewRevision=true

Replace the following:

• ACCESS_TOKEN: a valid access token for an account thathas theIAM permissions to deploy services.For example, if you are logged into gcloud, you can retrieve anaccess token usinggcloud auth print-access-token.From within a Cloud Run container instance, you can retrievean access token using thecontainer instance metadata server.
• IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest.
• REGION: the Google Cloud region—for example,europe-west1.
• PROJECT_ID: the Google Cloud project ID.
• WORKER_POOL: the name of the worker pool you are deploying to.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, aCloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. To deploy multiple containers to a worker pool, run the following command:

   gcloudbetarunworker-poolsdeployWORKER_POOL\--containerWORKER_POOL_CONTAINER_NAME\--image='WORKER_POOL_IMAGE'\--containerSIDECAR_CONTAINER_NAME\--image='SIDECAR_IMAGE'

   Replace the following:

   • WORKER_POOL: the name of the worker pool you aredeploying to. If you omit this parameter, you will beprompted for the worker pool name.
   • WORKER_POOL_CONTAINER_NAME: a name for the worker poolcontainer.
   • IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest.
   • SIDECAR_CONTAINER_NAME: a name for the sidecarcontainer—for examplesidecar.
   • SIDECAR_IMAGE: a reference to the sidecar container image.

   To configure each container in the deploy command, supply eachcontainer's configuration after thecontainer parameters, for example:

   gcloudbetarunworker-poolsdeployWORKER_POOL\--containerCONTAINER_1_NAME\--image='WORKER_POOL_IMAGE'\--set-env-vars=KEY=VALUE\--containerSIDECAR_CONTAINER_NAME\--image='SIDECAR_IMAGE'\--set-env-vars=KEY_N=VALUE_N

   Important: When you use the--container flag, you must specify all non-container-level flags before the container-level flags, otherwise the deploy command fails with an error message to that effect.

3. Wait for the deployment to finish. Upon successful completion,Cloud Run displays a success message.

YAML

1. If you are creating a new worker pool, skip this step.If you are updating an existing worker pool, download itsYAML configuration:

   gcloudbetarunworker-poolsdescribeWORKER_POOL--formatexport>workerpool.yaml

2. The following example contains the YAML configuration:

   apiVersion:run.googleapis.com/v1kind:WorkerPoolmetadata:name:WORKER_POOLannotations:run.googleapis.com/launch-stage:BETAspec:template:spec:containers:-name:CONTAINER_NAMEimage:IMAGE_URLcontainers:-name:SIDECAR_CONTAINER_NAMEimage:SIDECAR_IMAGE_URL

   Replace the following:

   • WORKER_POOL: the name of your Cloud Run worker pool.
   • CONTAINER_NAME: a name for the worker pool container.
   • IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest
   • SIDECAR_CONTAINER_NAME: a name for the sidecar container—forexample,sidecar.
   • SIDECAR_CONTAINER_IMAGE: a reference to the sidecar containerimage.

3. Create or update the worker pool using the following command:

   gcloudbetarunworker-poolsreplaceworkerpool.yaml

Terraform

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

resource"google_cloud_run_v2_worker_pool""default"{name="WORKER_POOL"location="REGION"launch_stage="BETA"template{containers{name="CONTAINER_NAME"image="IMAGE_URL"}containers{name="SIDECAR_CONTAINER_NAME"image="SIDECAR_IMAGE_URL"}}}

Replace the following:

• WORKER_POOL: the name of the worker pool.
• REGION: the Google Cloud region—for example,europe-west1.
• CONTAINER_NAME: the name of the container.
• IMAGE_URL: a reference to the container image thatcontains the worker pool, such asus-docker.pkg.dev/cloudrun/container/worker-pool:latest.
• SIDECAR_CONTAINER_NAME: the name of the sidecar container.
• SIDECAR_IMAGE_URL: a reference to the sidecar container image.