This page describes how to configure the entrypoint command and arguments for a Cloud Run job.
When Cloud Run starts a container, it runs the image's default
entrypoint command and default command arguments. If you want to
override the image's default entrypoint and command arguments, you can use the
command
and args
fields in the container configuration. The command
field
specifies the actual command run by the container. The args
field specifies
the arguments passed to that command.
Note that you can have a maximum of 1000 arguments per container for each job.
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 entrypoint and arguments
To configure command entrypoint and arguments for jobs:
Console
In the Google Cloud console, go to the Cloud Run jobs page:
Click Deploy container and select Job to fill out the initial job settings page. If you are configuring an existing job, select the job, then click Edit.
Click Container, variables and secrets, connections, security to expand the job properties page.
Click the General tab.
- Specify the command you want the container to run, if not the command defined in your container, and optionally specify the arguments to the entrypoint command.
Click Create or Update.
gcloud
To set the start command and arguments for a new job:
gcloud run jobs create JOB_NAME --image IMAGE_URL --command COMMAND --args ARG1,ARG-N
Replace
- JOB_NAME with the name of your job.
- COMMAND with the command that the container is to start up with if you are not using the default command.
- ARG1 with the argument you are sending to the container command, or use a comma delimited list for more than one argument.
- Replace IMAGE_URL with a reference to the container image, for
example,
us-docker.pkg.dev/cloudrun/container/job:latest
.
To update command and args for an existing job:
gcloud run jobs update JOB_NAME --command COMMAND --args ARG1,ARG-N
YAML
If you are creating a new job, skip this step. If you are updating an existing job, download its YAML configuration:
gcloud run jobs describe JOB_NAME --format export > job.yaml
Update the
args:
andcommand
attributes:apiVersion: run.googleapis.com/v1 kind: Job metadata: name: JOB_NAME spec: template: spec: template: spec: containers: - args: - 'ARG1' - 'ARG-N' command: - COMMAND image: IMAGE
Replace
- COMMAND with the command that the container is to start up with if you are not using the default command.
- ARG1 with the argument you are sending to the container command. Optionally specify additional arguments each in a separate line.
You can also specify more configuration such as environment variables or memory limits.
Update the existing job configuration:
gcloud run jobs replace job.yaml
To clear any entrypoint commands and arguments you have set (restore to container defaults), supply empty strings as follows:
gcloud run jobs update JOB_NAME --command "" --args ""
Use equals signs or commas in arguments
If you use equal signs in your arguments, supply these using the following format:
gcloud run deploy \
--args="--repo-allowlist=github.com/example/example_demo"
If your arguments use commas, refer to configuring environment variables for details on escaping those.
View container settings
To view the current container settings for your Cloud Run job:
Console
In the Google Cloud console, go to the Cloud Run jobs page:
Click the job you are interested in to open the Job details page.
Click the Configuration tab.
Locate the container setting in the configuration details.
gcloud
Use the following command:
gcloud run jobs describe JOB_NAME
Locate the container setting in the returned configuration.