Set maximum retries for jobs

A Cloud Run job consists of one or more tasks. The maximum retries setting specifies the number of times a task is allowed to restart in case of failure before being failed permanently. The default is 3.

This setting applies per-task, not per-job. If you set this to 0, tasks only run once and are not retried on failure.

Required roles

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

Cloud Run Developer (roles/run.developer) on the Cloud Run job
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 job 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.

Configure maximum retries

To specify maximum retries:

Console

In the Google Cloud console, go to the Cloud Run Jobs page:

Go to Cloud Run
Click Deploy container to fill out the initial job settings page. If you are configuring an existing job, select the job, then click View and edit job configuration.
Click Container(s), Volumes, Connections, Security to expand the job properties page.
Click the General tab.

image
- Specify the number of retries using an integer from 0 to 10.
Click Create or Update.

gcloud

For a job you are creating:
```
gcloudrunjobscreateJOB_NAME--imageIMAGE_URL--max-retriesRETRY
```
Replace
- JOB_NAME with the name of your job.
- IMAGE_URL: a reference to the container image—for example, us-docker.pkg.dev/cloudrun/container/job:latest.
- RETRY with the number of retries: specify an integer from 0 to 10.

For a job you are updating:

gcloudrunjobsupdateJOB_NAME--max-retriesRETRY

YAML

If you are creating a new job, skip this step. If you are updating an existing job, download its YAML configuration:
```
gcloudrunjobsdescribeJOB_NAME--formatexport>job.yaml
```
Update the maxRetries: attribute:
```
apiVersion:run.googleapis.com/v1
kind:Job
metadata:
name:JOB
spec:
template:
spec:
template:
spec:
containers:
-image:IMAGE
maxRetries:RETRIES
```
Replace RETRIES with the number of retries: specify an integer from 0 to 10.

You can also specify more configuration such as environment variables or memory limits.
Update the existing job configuration:
```
gcloudrunjobsreplacejob.yaml
```

Terraform

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

Add the following to a google_cloud_run_v2_job resource in your Terraform configuration:

resource"google_cloud_run_v2_job""default"{
name="cloud-run-job-retries"
location="us-central1"
deletion_protection=false # set to "true" in production
template{
template{
max_retries=3
containers{
image="us-docker.pkg.dev/cloudrun/container/job:latest"
}
}
}
}

View maximum retries settings

To view the current maximum retries settings for your Cloud Run job:

Console

In the Google Cloud console, go to the Cloud Run jobs page:

Go to Cloud Run jobs
Click the job you are interested in to open the Job details page.
Click View and Edit job configuration.
Locate the maximum retries setting in the configuration details.

gcloud

Use the following command:
```
gcloudrunjobsdescribeJOB_NAME
```
Locate the maximum retries setting in the returned configuration.