mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-14 08:55:34 +00:00
283 lines
11 KiB
Text
283 lines
11 KiB
Text
NAME
|
|
gcloud run jobs update - update a Cloud Run Job
|
|
|
|
SYNOPSIS
|
|
gcloud run jobs update [JOB] [--args=[ARG,...]]
|
|
[--breakglass=JUSTIFICATION] [--clear-vpc-connector]
|
|
[--command=[COMMAND,...]] [--cpu=CPU] [--execute-now] [--image=IMAGE]
|
|
[--key=KEY] [--max-retries=MAX_RETRIES] [--memory=MEMORY]
|
|
[--parallelism=PARALLELISM] [--region=REGION]
|
|
[--service-account=SERVICE_ACCOUNT] [--task-timeout=TASK_TIMEOUT]
|
|
[--tasks=TASKS; default=1] [--vpc-connector=VPC_CONNECTOR]
|
|
[--vpc-egress=VPC_EGRESS]
|
|
[--add-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
|
| --clear-cloudsql-instances
|
|
| --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
|
| --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]]
|
|
[--async | --wait]
|
|
[--binary-authorization=POLICY | --clear-binary-authorization]
|
|
[--clear-env-vars | --env-vars-file=FILE_PATH
|
|
| --set-env-vars=[KEY=VALUE,...]
|
|
| --remove-env-vars=[KEY,...] --update-env-vars=[KEY=VALUE,...]]
|
|
[--clear-labels | --remove-labels=[KEY,...] --labels=[KEY=VALUE,...]
|
|
| --update-labels=[KEY=VALUE,...]]
|
|
[--clear-secrets | --set-secrets=[KEY=VALUE,...]
|
|
| --remove-secrets=[KEY,...] --update-secrets=[KEY=VALUE,...]]
|
|
[GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
Updates a Cloud Run job.
|
|
|
|
EXAMPLES
|
|
To update the container image of Cloud Run job my-job:
|
|
|
|
$ gcloud run jobs update my-job \
|
|
--image=us-docker.pkg.dev/project/image
|
|
|
|
POSITIONAL ARGUMENTS
|
|
Job resource - Job to update. This represents a Cloud resource. (NOTE)
|
|
Some attributes are not given arguments in this group but can be set in
|
|
other ways. To set the project attribute:
|
|
◆ provide the argument JOB on the command line with a fully specified
|
|
name;
|
|
◆ specify the job name from an interactive prompt with a fully
|
|
specified name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
[JOB]
|
|
ID of the Job or fully qualified identifier for the Job. To set the
|
|
jobs attribute:
|
|
▸ provide the argument JOB on the command line;
|
|
▸ specify the job name from an interactive prompt.
|
|
|
|
FLAGS
|
|
--args=[ARG,...]
|
|
Comma-separated arguments passed to the command run by the container
|
|
image. If not specified and no '--command' is provided, the container
|
|
image's default Cmd is used. Otherwise, if not specified, no arguments
|
|
are passed. To reset this field to its default, pass an empty string.
|
|
|
|
--breakglass=JUSTIFICATION
|
|
Justification to bypass Binary Authorization policy constraints and
|
|
allow the operation. See
|
|
https://cloud.google.com/binary-authorization/docs/using-breakglass for
|
|
more information. Next update or deploy command will automatically
|
|
clear existing breakglass justification.
|
|
|
|
--clear-vpc-connector
|
|
Remove the VPC connector for this resource.
|
|
|
|
--command=[COMMAND,...]
|
|
Entrypoint for the container image. If not specified, the container
|
|
image's default Entrypoint is run. To reset this field to its default,
|
|
pass an empty string.
|
|
|
|
--cpu=CPU
|
|
Set a CPU limit in Kubernetes cpu units.
|
|
|
|
Cloud Run (fully managed) supports values 1, 2 and 4. For Cloud Run
|
|
(fully managed), 4 cpus also requires a minimum 2Gi --memory value.
|
|
Examples 2, 2.0, 2000m
|
|
|
|
--execute-now
|
|
Execute the job immediately after creation.
|
|
|
|
--image=IMAGE
|
|
Name of the container image to deploy (e.g.
|
|
us-docker.pkg.dev/cloudrun/container/job:latest).
|
|
|
|
--key=KEY
|
|
CMEK key reference to encrypt the container with.
|
|
|
|
--max-retries=MAX_RETRIES
|
|
Number of times a task is allowed to restart in case of failure before
|
|
being failed permanently. This applies per-task, not per-job. If set to
|
|
0, tasks will only run once and never be retried on failure.
|
|
|
|
--memory=MEMORY
|
|
Set a memory limit. Ex: 1024Mi, 4Gi.
|
|
|
|
--parallelism=PARALLELISM
|
|
Number of tasks that may run concurrently. Must be less than or equal
|
|
to the number of tasks. Set to 0 to unset.
|
|
|
|
--region=REGION
|
|
Region in which the resource can be found. Alternatively, set the
|
|
property [run/region].
|
|
|
|
--service-account=SERVICE_ACCOUNT
|
|
Service account associated with the revision of the service. The
|
|
service account represents the identity of the running revision, and
|
|
determines what permissions the revision has. This is the email address
|
|
of an IAM service account.
|
|
|
|
--task-timeout=TASK_TIMEOUT
|
|
Set the maximum time (deadline) a job task attempt can run for. In the
|
|
case of retries, this deadline applies to each attempt of a task. If
|
|
the task attempt does not complete within this time, it will be killed.
|
|
It is specified as a duration; for example, "10m5s" is ten minutes, and
|
|
five seconds. If you don't specify a unit, seconds is assumed. For
|
|
example, "10" is 10 seconds.
|
|
|
|
--tasks=TASKS; default=1
|
|
Number of tasks that must run to completion for the job to be
|
|
considered done. Use this flag to trigger multiple runs of the job.
|
|
|
|
--vpc-connector=VPC_CONNECTOR
|
|
Set a VPC connector for this resource.
|
|
|
|
--vpc-egress=VPC_EGRESS
|
|
The outbound traffic to send through the VPC connector for this
|
|
resource. This resource must have a VPC connector to set VPC egress.
|
|
VPC_EGRESS must be one of:
|
|
|
|
all
|
|
(DEPRECATED) Sends all outbound traffic through the VPC connector.
|
|
Provides the same functionality as 'all-traffic'. Prefer to use
|
|
'all-traffic' instead.
|
|
all-traffic
|
|
Sends all outbound traffic through the VPC connector.
|
|
private-ranges-only
|
|
Default option. Sends outbound traffic to private IP addresses
|
|
defined by RFC1918 through the VPC connector.
|
|
|
|
These flags modify the Cloud SQL instances this Service connects to. You
|
|
can specify a name of a Cloud SQL instance if it's in the same project and
|
|
region as your Cloud Run service; otherwise specify
|
|
<project>:<region>:<instance> for the instance.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--add-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
|
Append the given values to the current Cloud SQL instances.
|
|
|
|
--clear-cloudsql-instances
|
|
Empty the current Cloud SQL instances.
|
|
|
|
--remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
|
Remove the given values from the current Cloud SQL instances.
|
|
|
|
--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
|
Completely replace the current Cloud SQL instances with the given
|
|
values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--async
|
|
Return immediately, without waiting for the operation in progress to
|
|
complete.
|
|
|
|
--wait
|
|
Wait until the execution has completed running before exiting. If not
|
|
set, gcloud exits successfully when the execution has started.
|
|
Implies --execute-now.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--binary-authorization=POLICY
|
|
Binary Authorization policy to check against. This must be set to
|
|
"default".
|
|
|
|
--clear-binary-authorization
|
|
Remove any previously set Binary Authorization policy.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-env-vars
|
|
Remove all environment variables.
|
|
|
|
--env-vars-file=FILE_PATH
|
|
Path to a local YAML file with definitions for all environment
|
|
variables. All existing environment variables will be removed before
|
|
the new environment variables are added. Example YAML content:
|
|
|
|
KEY_1: "value1"
|
|
KEY_2: "value 2"
|
|
|
|
--set-env-vars=[KEY=VALUE,...]
|
|
List of key-value pairs to set as environment variables. All existing
|
|
environment variables will be removed first.
|
|
|
|
Only --update-env-vars and --remove-env-vars can be used together. If
|
|
both are specified, --remove-env-vars will be applied first.
|
|
|
|
--remove-env-vars=[KEY,...]
|
|
List of environment variables to be removed.
|
|
|
|
--update-env-vars=[KEY=VALUE,...]
|
|
List of key-value pairs to set as environment variables.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-labels
|
|
Remove all labels. If --update-labels is also specified then
|
|
--clear-labels is applied first.
|
|
|
|
For example, to remove all labels:
|
|
|
|
$ gcloud run jobs update --clear-labels
|
|
|
|
To remove all existing labels and create two new labels, foo and baz:
|
|
|
|
$ gcloud run jobs update --clear-labels \
|
|
--update-labels foo=bar,baz=qux
|
|
|
|
--remove-labels=[KEY,...]
|
|
List of label keys to remove. If a label does not exist it is
|
|
silently ignored. If --update-labels is also specified then
|
|
--update-labels is applied first.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--labels=[KEY=VALUE,...]
|
|
List of label KEY=VALUE pairs to add.
|
|
|
|
An alias to --update-labels.
|
|
|
|
--update-labels=[KEY=VALUE,...]
|
|
List of label KEY=VALUE pairs to update. If a label exists, its value
|
|
is modified. Otherwise, a new label is created.
|
|
|
|
Specify secrets to mount or provide as environment variables. Keys
|
|
starting with a forward slash '/' are mount paths. All other keys
|
|
correspond to environment variables. Values should be in the form
|
|
SECRET_NAME:SECRET_VERSION. For example:
|
|
'--update-secrets=/secrets/api/key=mysecret:latest,ENV=othersecret:1' will
|
|
mount a volume at '/secrets/api' containing a file 'key' with the latest
|
|
version of secret 'mysecret'. An environment variable named ENV will also
|
|
be created whose value is version 1 of secret 'othersecret'.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-secrets
|
|
Remove all secrets.
|
|
|
|
--set-secrets=[KEY=VALUE,...]
|
|
List of key-value pairs to set as secrets. All existing secrets will
|
|
be removed first.
|
|
|
|
Only --update-secrets and --remove-secrets can be used together. If both
|
|
are specified, --remove-secrets will be applied first.
|
|
|
|
--remove-secrets=[KEY,...]
|
|
List of secrets to be removed.
|
|
|
|
--update-secrets=[KEY=VALUE,...]
|
|
List of key-value pairs to set as secrets.
|
|
|
|
GCLOUD WIDE FLAGS
|
|
These flags are available to all commands: --access-token-file, --account,
|
|
--billing-project, --configuration, --flags-file, --flatten, --format,
|
|
--help, --impersonate-service-account, --log-http, --project, --quiet,
|
|
--trace-token, --user-output-enabled, --verbosity.
|
|
|
|
Run $ gcloud help for details.
|
|
|
|
NOTES
|
|
These variants are also available:
|
|
|
|
$ gcloud alpha run jobs update
|
|
|
|
$ gcloud beta run jobs update
|
|
|