Deploy worker pools from source code Stay organized with collections Save and categorize content based on your preferences.

This page describes how to deploy a new worker pool or worker pool revision to Cloud Run directly from source code using a single gcloud CLI command, gcloud run worker-pools deploy with the --source flag. Note: The deploy command defaults to source deployment if you don't supply --image or --source flags. Behind the scenes, this command uses Google Cloud's buildpacks and Cloud Build to automatically build container images from your source code without having to install Docker on your machine or set up buildpacks or Cloud Build. By default, Cloud Run uses the default machine type provided by Cloud Build. Running gcloud run worker-pools deploy eliminates the need to also run the gcloud builds submit command.

Note that source deployments use Artifact Registry to store built containers. If your project doesn't already have an Artifact Registry repository with the name cloud-run-source-deploy in the region you are deploying to, this feature automatically creates an Artifact Registry repository with the name cloud-run-source-deploy.

If a Dockerfile is present in the source code directory, the uploaded source code is built using that Dockerfile. If no Dockerfile is present in the source code directory, Google Cloud's buildpacks automatically detects the language you are using and fetches the dependencies of the code to make a production-ready container image, using a secure base image managed by Google.

Before you begin

• Make sure you have set up a new project for Cloud Run as described in the setup page.

• Enable the Cloud Run Admin API.

  Roles required to enable APIs

  To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

  Enable the API

  After the Cloud Run Admin API is enabled, the Compute Engine default service account is automatically created.

Required roles

To deploy from source, you or your administrator must grant the deployer account the following IAM roles.

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.

Supported languages

In addition to sources with a Dockerfile, deploying from source supports the following languages using Google Cloud's buildpacks:

• Go
• Node.js
• Python
• Java
• Kotlin
• Groovy
• Scala
• .NET
• Ruby
• PHP

Read more details about supported language versions.

Deploy from source with build

This section describes how to use Google Cloud's buildpacks and Cloud Build to automatically build container images from your source code without having to install Docker on your machine or set up buildpacks or Cloud Build.

Limitations

• Deploy from source uses Artifact Registry and Cloud Build, so this feature is only available in regions supported by Artifact Registry and Cloud Build.
• Deploying from source is a convenience feature, and does not allow full customization of the build. For more control, build the container image using Cloud Build, for example, using gcloud builds submit, and then deploy the container image using, for example, gcloud run worker-pools deploy --image.
• Deploying from source with Google Cloud's buildpacks sets the Last Modified Date of source files to Jan 1, 1980. This is the default behavior of buildpacks and is designed to support reproducible builds. Depending on your language framework, this can affect browser-side caching of static files. If your application is affected by this, Google recommends disabling etag and Last-Modified HTTP headers in your application.
• Deploying from source with Google Cloud's buildpacks always uses gcr.io/buildpacks/builder:latest. If your preferred language or OS configuration is not available in latest, use a specific builder to create an application image using your preferred builder.

• You can deploy your worker pool from source using Kotlin and other JVM languages such as Java. The language you use must conform to the following rules:

  • You can build the application using Maven or Gradle.
  • The build file contains all the plugins required to product classes.

Before you deploy with build

Before you deploy from source with build:

• Follow the steps in Before you begin.

• Enable the Cloud Build API.

  Roles required to enable APIs

  To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

  Enable the API

Required roles

To deploy from source with build, you or your administrator must grant the Cloud Build service account the following IAM roles.

  gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
      --role=roles/run.builder
  

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.

Deploy with build

To deploy from source code:

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

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud 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. Change to your source directory. The source directory uses a Dockerfile if present, although it's not required.

3. Build and deploy your worker pool:

   gcloud run worker-pools deploy WORKERPOOL --source .

   Replace WORKERPOOL with the name you want for your worker pool.

4. Respond to any prompts to install required APIs by responding y when prompted. You only need to do this once for a project. Respond to other prompts by supplying the platform and region, if you haven't set defaults for these as described in the setup page.

5. Wait for the build and deploy to complete. When finished, Cloud Run displays a success message.

Automating building from source

As a best practice for avoiding unversioned changes in local source, Google recommends that you automatically deploy when changes are pushed to your Git repository. To make this easier, you can connect and configure continuous deployment to your Cloud Run worker pool. By connecting your GitHub repositories to Cloud Run, you can configure builds and deploy your repositories without writing Dockerfiles or build files.

What's next

After you deploy a Cloud Run worker pool, you can do the following:

• View worker pool logs
• Monitor worker pools
• Set memory limits
• Set environment variables
• Manage the worker pool
• Manage worker pool revisions