This page describes how to set the maximum number of container instances that can be used for your Cloud Run service. Specifying maximum instances in Cloud Run allows you to limit the scaling of your service in response to incoming requests, although this maximum setting can be exceeded for a brief period due to circumstances such as traffic spikes. Use this setting as a way to control your costs or to limit the number of connections to a backing service, such as to a database.
For information about the maximum instance limits that might apply to your service, refer to Maximum instances limits.
For more information on the way Cloud Run autoscales container instances, refer to Instance autoscaling.
Setting and updating maximum instances
Any configuration change leads to the creation of a new revision. Subsequent revisions will also automatically get this configuration setting unless you make explicit updates to change it.
By default, Cloud Run services are configured to scale out to a maximum of 100 instances.
You can change the maximum instances setting using the Google Cloud console, the gcloud command line, or a YAML file when you create a new service or deploy a new revision.
Console
Click Create Service if you are configuring a new service you are deploying to. If you are configuring an existing service, click on the service, then click Edit and Deploy New Revision.
If you are configuring a new service, fill out the initial service settings page as desired, then click Container, connections, security to expand the service configuration page.
Click the Container tab.
In the field labelled Maximum number of instances, specify the desired maximum number of container instances, using any integer value from
1
to the maximum limitClick Create or Deploy.
Command line
You can update the maximum number of container instances of a given service by using the following command:
gcloud run services update SERVICE --max-instances MAX-VALUE
Replace
- SERVICE with the name of your service and
- MAX-VALUE with the desired maximum number of container
instances, using any integer value from
1
to the maximum limit. Specifydefault
to clear any maximum instance setting and restore the default of 100 instances.
You can also set the maximum number of container instances during deployment using the command:
gcloud run deploy --image IMAGE_URL --max-instances MAX-VALUE
Replace
- IMAGE_URL with a reference to the container image, for
example,
us-docker.pkg.dev/cloudrun/container/hello:latest
. - MAX-VALUE with the desired maximum number of container instances.
YAML
You can download and view existing service configurations using the
gcloud run services describe --format export
command, which yields
cleaned results in YAML format.
You can then modify the fields described below and
upload the modified YAML using the gcloud run services replace
command.
Make sure you only modify fields as documented.
To view and download the configuration:
gcloud run services describe SERVICE --format export > service.yaml
Update the
autoscaling.knative.dev/maxScale:
attribute:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: SERVICE spec: template: metadata: annotations: autoscaling.knative.dev/maxScale: 'MAX-INSTANCE' name: REVISION
Replace
- SERVICE with the name of your Cloud Run service
- MAX-INSTANCE with the desired maximum number.
- REVISION with a new revision name or delete it (if present). If you supply a new revision name, it must meet the following criteria:
- Starts with
SERVICE-
- Contains only lowercase letters, numbers and
-
- Does not end with a
-
- Does not exceed 63 characters
- Starts with
Replace the service with its new configuration using the following command:
gcloud run services replace service.yaml
Terraform
Add the following to a google_cloud_run_service
resource in your Terraform
configuration, under the template
attribute. Replace 10
with your
service's desired maximum number of instances.
To apply your Terraform configuration in a Google Cloud project, complete the following steps:
- Launch Cloud Shell.
- Set the Google Cloud project where you want to apply the Terraform configuration:
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
- Create a directory and a new file within that directory. The filename must have the
.tf
extension—for examplemain.tf
. In this tutorial, the file is referred to asmain.tf
.mkdir DIRECTORY && cd DIRECTORY && touch main.tf
If you are following a tutorial, you can copy the sample code in each section or step.
Copy the sample code into the newly created
main.tf
.Optionally, copy the code from GitHub. This is recommended when the Terraform snippet is part of an end-to-end solution.
- Review and modify the sample parameters to apply to your environment.
- Save your changes.
- Initialize Terraform:
terraform init
- Review the configuration and verify that the resources that Terraform is going to create or
update match your expectations:
terraform plan
Make corrections to the configuration as necessary.
- Apply the Terraform configuration by running the following command and entering
yes
at the prompt:terraform apply
Wait until Terraform displays the "Apply complete!" message.
- Open your Google Cloud project to view the results. In the Google Cloud console, navigate to your resources in the UI to make sure that Terraform has created or updated them.
Maximum instances limits
By default, Cloud Run services are configured to a maximum of 100 instances
For instance using 1 CPU and 2GB memory, this maximum can be increased up to a limit of 1000 instances. The actual maximum limit depends on the region of the Cloud Run service and its CPU and memory configurations.
The quotas page shows the baseline quotas per-region.
The maximum number of instances is determined as the minimum of:
- regional quota baseline / requested multiple of 1 CPU
- regional quota baseline / requested multiple of 2GB memory
For example, a baseline quota of 1000 instances with either 4GB memory or 2 CPU will get an effective limit of 500.
If you want to specify a maximum number of instances greater than the maximum allowed in the region of the Cloud Run service, you must request a quota increase.
View maximum instances settings
To view the current maximum instances settings for your Cloud Run service:
Console
Click the service you are interested in to open the Service details page.
Click the Revisions tab.
In the details panel at the right, the maximum instances setting is listed under the Container tab.
Command line
Use the following command:
gcloud run services describe SERVICE
Locate the maximum instances setting in the returned configuration.