mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 10:35:03 +00:00
gcloud: Wed Mar 29 10:40:15 UTC 2023
This commit is contained in:
parent
4ccfc7a5e3
commit
5fabf24be7
269 changed files with 6797 additions and 464 deletions
|
|
@ -31,8 +31,9 @@ SYNOPSIS
|
|||
| --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
||||
| --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
||||
--binary-authorization=POLICY
|
||||
| --clear-binary-authorization --clear-key
|
||||
| --key=KEY --clear-post-key-revocation-action-type
|
||||
| --clear-binary-authorization --clear-encryption-key-shutdown-hours
|
||||
| --encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS
|
||||
--clear-key | --key=KEY --clear-post-key-revocation-action-type
|
||||
| --post-key-revocation-action-type=POST_KEY_REVOCATION_ACTION_TYPE]
|
||||
[--region=REGION
|
||||
| --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION
|
||||
|
|
@ -446,6 +447,15 @@ FLAGS
|
|||
--clear-binary-authorization
|
||||
Remove any previously set Binary Authorization policy.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-encryption-key-shutdown-hours
|
||||
Remove any previously set CMEK key shutdown hours setting.
|
||||
|
||||
--encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS
|
||||
The number of hours to wait before an automatic shutdown server
|
||||
after CMEK key revocation is detected.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-key
|
||||
|
|
|
|||
|
|
@ -26,6 +26,9 @@ GROUPS
|
|||
domain-mappings
|
||||
View and manage your Cloud Run for Anthos domain mappings.
|
||||
|
||||
jobs
|
||||
View and manage your Cloud Run jobs.
|
||||
|
||||
regions
|
||||
View available Cloud Run (fully managed) regions.
|
||||
|
||||
|
|
|
|||
91
gcloud/run/jobs/add-iam-policy-binding
Normal file
91
gcloud/run/jobs/add-iam-policy-binding
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
NAME
|
||||
gcloud run jobs add-iam-policy-binding - add IAM policy binding to a Cloud
|
||||
Run job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs add-iam-policy-binding JOB --member=PRINCIPAL --role=ROLE
|
||||
[--region=REGION] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Add an IAM policy binding to the IAM policy of a Cloud Run job. One binding
|
||||
consists of a member, and a role.
|
||||
|
||||
EXAMPLES
|
||||
To add an IAM policy binding for the role of 'roles/run.invoker' for the
|
||||
user 'test-user@gmail.com' with job 'my-job' and region 'us-central1', run:
|
||||
|
||||
$ gcloud run jobs add-iam-policy-binding my-job \
|
||||
--region='us-central1' --member='user:test-user@gmail.com' \
|
||||
--role='roles/run.invoker'
|
||||
|
||||
See https://cloud.google.com/iam/docs/managing-policies for details of
|
||||
policy role and member types.
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - The job for which to add IAM policy binding to. 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;
|
||||
◆ set the property core/project;
|
||||
◆ provide the argument --project on the command line. To set the region
|
||||
attribute:
|
||||
◆ provide the argument job on the command line with a fully specified
|
||||
name;
|
||||
◆ provide the argument --region on the command line;
|
||||
◆ set the property run/region;
|
||||
◆ specify from a list of available regions in a prompt.
|
||||
|
||||
This must be specified.
|
||||
|
||||
JOB
|
||||
ID of the job or fully qualified identifier for the job. To set the
|
||||
job attribute:
|
||||
▸ provide the argument job on the command line.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--member=PRINCIPAL
|
||||
The principal to add the binding for. Should be of the form
|
||||
user|group|serviceAccount:email or domain:domain.
|
||||
|
||||
Examples: user:test-user@gmail.com, group:admins@example.com,
|
||||
serviceAccount:test123@example.domain.com, or
|
||||
domain:example.domain.com.
|
||||
|
||||
Some resources also accept the following special values:
|
||||
◆ allUsers - Special identifier that represents anyone who is on the
|
||||
internet, with or without a Google account.
|
||||
◆ allAuthenticatedUsers - Special identifier that represents anyone
|
||||
who is authenticated with a Google account or a service account.
|
||||
|
||||
--role=ROLE
|
||||
Role name to assign to the principal. The role name is the complete
|
||||
path of a predefined role, such as roles/logging.viewer, or the role ID
|
||||
for a custom role, such as
|
||||
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the run/v1 API. The full documentation for this API can
|
||||
be found at: https://cloud.google.com/run/
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs add-iam-policy-binding
|
||||
|
||||
$ gcloud beta run jobs add-iam-policy-binding
|
||||
|
||||
195
gcloud/run/jobs/create
Normal file
195
gcloud/run/jobs/create
Normal file
|
|
@ -0,0 +1,195 @@
|
|||
NAME
|
||||
gcloud run jobs create - create a Cloud Run job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs create [JOB] --image=IMAGE [--args=[ARG,...]]
|
||||
[--binary-authorization=POLICY] [--breakglass=JUSTIFICATION]
|
||||
[--command=[COMMAND,...]] [--cpu=CPU] [--execute-now] [--key=KEY]
|
||||
[--labels=[KEY=VALUE,...]] [--max-retries=MAX_RETRIES]
|
||||
[--memory=MEMORY] [--parallelism=PARALLELISM] [--region=REGION]
|
||||
[--service-account=SERVICE_ACCOUNT]
|
||||
[--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]]
|
||||
[--set-secrets=[KEY=SECRET_NAME:SECRET_VERSION,...]]
|
||||
[--task-timeout=TASK_TIMEOUT] [--tasks=TASKS; default=1]
|
||||
[--vpc-connector=VPC_CONNECTOR] [--vpc-egress=VPC_EGRESS]
|
||||
[--async | --wait]
|
||||
[--env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Creates a new Cloud Run job.
|
||||
|
||||
EXAMPLES
|
||||
To deploy a new job my-data-transformation on Cloud Run:
|
||||
|
||||
$ gcloud run jobs create my-data-transformation \
|
||||
--image=us-docker.pkg.dev/project/image
|
||||
|
||||
You may also omit the job name. Then a prompt will be displayed with a
|
||||
suggested default value:
|
||||
|
||||
$ gcloud run jobs create --image=us-docker.pkg.dev/project/image
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - Job to create. 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.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--image=IMAGE
|
||||
Name of the container image to deploy (e.g.
|
||||
us-docker.pkg.dev/cloudrun/container/job:latest).
|
||||
|
||||
OPTIONAL 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.
|
||||
|
||||
--binary-authorization=POLICY
|
||||
Binary Authorization policy to check against. This must be set to
|
||||
"default".
|
||||
|
||||
--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.
|
||||
|
||||
--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.
|
||||
|
||||
--key=KEY
|
||||
CMEK key reference to encrypt the container with.
|
||||
|
||||
--labels=[KEY=VALUE,...]
|
||||
List of label KEY=VALUE pairs to add.
|
||||
|
||||
--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.
|
||||
|
||||
--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
||||
You can specify a name of a Cloud SQL instance if it's in the same
|
||||
project and region as your Cloud Run resource; otherwise specify
|
||||
<project>:<region>:<instance> for the instance.
|
||||
|
||||
--set-secrets=[KEY=SECRET_NAME:SECRET_VERSION,...]
|
||||
Specify secrets to provide as environment variables. For example:
|
||||
'--set-secrets=ENV=mysecret:latest,OTHER_ENV=othersecret:1' will create
|
||||
an environment variable named ENV whose value is the latest version of
|
||||
secret 'mysecret' and an environment variable OTHER_ENV whose value is
|
||||
version of 1 of secret 'othersecret'.
|
||||
|
||||
--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.
|
||||
|
||||
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:
|
||||
|
||||
--env-vars-file=FILE_PATH
|
||||
Path to a local YAML file with definitions for all environment
|
||||
variables. 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.
|
||||
|
||||
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 create
|
||||
|
||||
$ gcloud beta run jobs create
|
||||
|
||||
50
gcloud/run/jobs/delete
Normal file
50
gcloud/run/jobs/delete
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
NAME
|
||||
gcloud run jobs delete - delete a job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs delete JOB [--region=REGION] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Delete a job.
|
||||
|
||||
EXAMPLES
|
||||
To delete a job:
|
||||
|
||||
$ gcloud run jobs delete job-name
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - Job to delete. 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;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
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.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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 delete
|
||||
|
||||
$ gcloud beta run jobs delete
|
||||
|
||||
50
gcloud/run/jobs/describe
Normal file
50
gcloud/run/jobs/describe
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
NAME
|
||||
gcloud run jobs describe - obtain details about jobs
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs describe JOB [--region=REGION] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Obtain details about jobs.
|
||||
|
||||
EXAMPLES
|
||||
To describe a job:
|
||||
|
||||
$ gcloud run jobs describe my-job
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - Job to describe. 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;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
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.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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 describe
|
||||
|
||||
$ gcloud beta run jobs describe
|
||||
|
||||
62
gcloud/run/jobs/execute
Normal file
62
gcloud/run/jobs/execute
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
NAME
|
||||
gcloud run jobs execute - execute a job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs execute [JOB] [--region=REGION] [--async | --wait]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Execute a job.
|
||||
|
||||
EXAMPLES
|
||||
To execute a job:
|
||||
|
||||
$ gcloud run jobs execute my-job
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - Job to execute. 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
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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.
|
||||
|
||||
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 execute
|
||||
|
||||
$ gcloud beta run jobs execute
|
||||
|
||||
51
gcloud/run/jobs/executions/delete
Normal file
51
gcloud/run/jobs/executions/delete
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud run jobs executions delete - delete an execution
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions delete EXECUTION [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Delete an execution.
|
||||
|
||||
EXAMPLES
|
||||
To delete an execution:
|
||||
|
||||
$ gcloud run jobs executions delete my-execution
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Execution resource - Execution to delete. 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 EXECUTION on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
EXECUTION
|
||||
ID of the Execution or fully qualified identifier for the Execution.
|
||||
To set the executions attribute:
|
||||
▸ provide the argument EXECUTION on the command line.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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 executions delete
|
||||
|
||||
$ gcloud beta run jobs executions delete
|
||||
|
||||
51
gcloud/run/jobs/executions/describe
Normal file
51
gcloud/run/jobs/executions/describe
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud run jobs executions describe - obtain details about executions
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions describe EXECUTION [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Obtain details about executions.
|
||||
|
||||
EXAMPLES
|
||||
To describe an execution:
|
||||
|
||||
$ gcloud run jobs executions describe my-execution
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Execution resource - Execution to describe. 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 EXECUTION on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
EXECUTION
|
||||
ID of the Execution or fully qualified identifier for the Execution.
|
||||
To set the executions attribute:
|
||||
▸ provide the argument EXECUTION on the command line.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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 executions describe
|
||||
|
||||
$ gcloud beta run jobs executions describe
|
||||
|
||||
51
gcloud/run/jobs/executions/help
Normal file
51
gcloud/run/jobs/executions/help
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud run jobs executions - view and manage your Cloud Run jobs executions
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions GROUP | COMMAND [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
This set of commands can be used to view and manage your Cloud Run jobs
|
||||
executions.
|
||||
|
||||
EXAMPLES
|
||||
To list your executions for a job, run:
|
||||
|
||||
$ gcloud run jobs executions list --job=my-job
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
GROUPS
|
||||
GROUP is one of the following:
|
||||
|
||||
tasks
|
||||
View and manage your Cloud Run jobs tasks.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
delete
|
||||
Delete an execution.
|
||||
|
||||
describe
|
||||
Obtain details about executions.
|
||||
|
||||
list
|
||||
List executions.
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs executions
|
||||
|
||||
$ gcloud beta run jobs executions
|
||||
|
||||
85
gcloud/run/jobs/executions/list
Normal file
85
gcloud/run/jobs/executions/list
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
NAME
|
||||
gcloud run jobs executions list - list executions
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions list [--job=JOB] [--namespace=NAMESPACE]
|
||||
[--region=REGION] [--filter=EXPRESSION] [--limit=LIMIT]
|
||||
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
List executions.
|
||||
|
||||
EXAMPLES
|
||||
To list all executions in all regions:
|
||||
|
||||
$ gcloud run jobs executions list
|
||||
|
||||
FLAGS
|
||||
--job=JOB
|
||||
Limit matched resources to the given job.
|
||||
|
||||
Namespace resource - Namespace to list executions in. This represents a
|
||||
Cloud resource.
|
||||
|
||||
--namespace=NAMESPACE
|
||||
ID of the namespace or fully qualified identifier for the namespace.
|
||||
To set the namespace attribute:
|
||||
▸ provide the argument --namespace on the command line;
|
||||
▸ set the property run/namespace;
|
||||
▸ For Cloud Run on Kubernetes Engine, defaults to "default".
|
||||
Otherwise, defaults to project ID.;
|
||||
▸ provide the argument project on the command line;
|
||||
▸ set the property core/project.
|
||||
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--uri
|
||||
Print a list of resource URIs instead of the default output, and change
|
||||
the command output to a list of URIs. If this flag is used with
|
||||
--format, the formatting is applied on this URI list. To display URIs
|
||||
alongside other keys instead, use the uri() transform.
|
||||
|
||||
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 executions list
|
||||
|
||||
$ gcloud beta run jobs executions list
|
||||
|
||||
51
gcloud/run/jobs/executions/tasks/describe
Normal file
51
gcloud/run/jobs/executions/tasks/describe
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
NAME
|
||||
gcloud run jobs executions tasks describe - obtain details about tasks
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions tasks describe TASK [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Obtain details about tasks.
|
||||
|
||||
EXAMPLES
|
||||
To describe a task:
|
||||
|
||||
$ gcloud run jobs executions tasks describe my-task
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Task resource - Task to describe. 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 TASK on the command line with a fully specified
|
||||
name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
TASK
|
||||
ID of the Task or fully qualified identifier for the Task. To set the
|
||||
tasks attribute:
|
||||
▸ provide the argument TASK on the command line.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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 executions tasks describe
|
||||
|
||||
$ gcloud beta run jobs executions tasks describe
|
||||
|
||||
43
gcloud/run/jobs/executions/tasks/help
Normal file
43
gcloud/run/jobs/executions/tasks/help
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
NAME
|
||||
gcloud run jobs executions tasks - view and manage your Cloud Run jobs
|
||||
tasks
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions tasks COMMAND [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
This set of commands can be used to view and manage your Cloud Run jobs
|
||||
tasks.
|
||||
|
||||
EXAMPLES
|
||||
To list your existing tasks for an execution, run:
|
||||
|
||||
$ gcloud run jobs executions tasks list --execution my_execution
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
describe
|
||||
Obtain details about tasks.
|
||||
|
||||
list
|
||||
List tasks.
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs executions tasks
|
||||
|
||||
$ gcloud beta run jobs executions tasks
|
||||
|
||||
88
gcloud/run/jobs/executions/tasks/list
Normal file
88
gcloud/run/jobs/executions/tasks/list
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
NAME
|
||||
gcloud run jobs executions tasks list - list tasks
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs executions tasks list --execution=EXECUTION
|
||||
[--region=REGION] [--succeeded] [--filter=EXPRESSION] [--limit=LIMIT]
|
||||
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
List tasks.
|
||||
|
||||
EXAMPLES
|
||||
To list all tasks for an execution:
|
||||
|
||||
$ gcloud run jobs executions tasks list --execution=my-execution
|
||||
|
||||
REQUIRED FLAGS
|
||||
Execution resource - Execution for which to list tasks. 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 --execution on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
--execution=EXECUTION
|
||||
ID of the Execution or fully qualified identifier for the Execution.
|
||||
To set the executions attribute:
|
||||
▸ provide the argument --execution on the command line.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
--succeeded
|
||||
Include succeeded tasks.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--uri
|
||||
Print a list of resource URIs instead of the default output, and change
|
||||
the command output to a list of URIs. If this flag is used with
|
||||
--format, the formatting is applied on this URI list. To display URIs
|
||||
alongside other keys instead, use the uri() transform.
|
||||
|
||||
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 executions tasks list
|
||||
|
||||
$ gcloud beta run jobs executions tasks list
|
||||
|
||||
93
gcloud/run/jobs/get-iam-policy
Normal file
93
gcloud/run/jobs/get-iam-policy
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
NAME
|
||||
gcloud run jobs get-iam-policy - get the IAM policy for a Cloud Run job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs get-iam-policy JOB [--region=REGION] [--filter=EXPRESSION]
|
||||
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
This command gets the IAM policy for a job. If formatted as JSON, the
|
||||
output can be edited and used as a policy file for set-iam-policy. The
|
||||
output includes an "etag" field identifying the version emitted and
|
||||
allowing detection of concurrent policy updates; see $ gcloud alpha run
|
||||
registries set-iam-policy for additional details.
|
||||
|
||||
EXAMPLES
|
||||
To print the IAM policy for a given job, run:
|
||||
|
||||
$ gcloud run jobs get-iam-policy --region=us-central1 my-job
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - The job for which to display the IAM policy. 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;
|
||||
◆ set the property core/project;
|
||||
◆ provide the argument --project on the command line. To set the region
|
||||
attribute:
|
||||
◆ provide the argument job on the command line with a fully specified
|
||||
name;
|
||||
◆ provide the argument --region on the command line;
|
||||
◆ set the property run/region;
|
||||
◆ specify from a list of available regions in a prompt.
|
||||
|
||||
This must be specified.
|
||||
|
||||
JOB
|
||||
ID of the job or fully qualified identifier for the job. To set the
|
||||
job attribute:
|
||||
▸ provide the argument job on the command line.
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
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.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the run/v1 API. The full documentation for this API can
|
||||
be found at: https://cloud.google.com/run/
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs get-iam-policy
|
||||
|
||||
$ gcloud beta run jobs get-iam-policy
|
||||
|
||||
73
gcloud/run/jobs/help
Normal file
73
gcloud/run/jobs/help
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
NAME
|
||||
gcloud run jobs - view and manage your Cloud Run jobs
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs GROUP | COMMAND [--region=REGION] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
This set of commands can be used to view and manage your Cloud Run jobs.
|
||||
|
||||
EXAMPLES
|
||||
To list your existing jobs, run:
|
||||
|
||||
$ gcloud run jobs list
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
GROUPS
|
||||
GROUP is one of the following:
|
||||
|
||||
executions
|
||||
View and manage your Cloud Run jobs executions.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
add-iam-policy-binding
|
||||
Add IAM policy binding to a Cloud Run job.
|
||||
|
||||
create
|
||||
Create a Cloud Run job.
|
||||
|
||||
delete
|
||||
Delete a job.
|
||||
|
||||
describe
|
||||
Obtain details about jobs.
|
||||
|
||||
execute
|
||||
Execute a job.
|
||||
|
||||
get-iam-policy
|
||||
Get the IAM policy for a Cloud Run job.
|
||||
|
||||
list
|
||||
List jobs.
|
||||
|
||||
remove-iam-policy-binding
|
||||
Remove IAM policy binding of a Cloud Run job.
|
||||
|
||||
replace
|
||||
Create or replace a job from a YAML job specification.
|
||||
|
||||
set-iam-policy
|
||||
Set the IAM policy for a job.
|
||||
|
||||
update
|
||||
Update a Cloud Run Job.
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs
|
||||
|
||||
$ gcloud beta run jobs
|
||||
|
||||
81
gcloud/run/jobs/list
Normal file
81
gcloud/run/jobs/list
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
NAME
|
||||
gcloud run jobs list - list jobs
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs list [--namespace=NAMESPACE] [--region=REGION]
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
|
||||
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
List jobs.
|
||||
|
||||
EXAMPLES
|
||||
To list all jobs in all regions:
|
||||
|
||||
$ gcloud run jobs list
|
||||
|
||||
FLAGS
|
||||
Namespace resource - Namespace to list jobs in. This represents a Cloud
|
||||
resource.
|
||||
|
||||
--namespace=NAMESPACE
|
||||
ID of the namespace or fully qualified identifier for the namespace.
|
||||
To set the namespace attribute:
|
||||
▸ provide the argument --namespace on the command line;
|
||||
▸ set the property run/namespace;
|
||||
▸ For Cloud Run on Kubernetes Engine, defaults to "default".
|
||||
Otherwise, defaults to project ID.;
|
||||
▸ provide the argument project on the command line;
|
||||
▸ set the property core/project.
|
||||
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--uri
|
||||
Print a list of resource URIs instead of the default output, and change
|
||||
the command output to a list of URIs. If this flag is used with
|
||||
--format, the formatting is applied on this URI list. To display URIs
|
||||
alongside other keys instead, use the uri() transform.
|
||||
|
||||
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 list
|
||||
|
||||
$ gcloud beta run jobs list
|
||||
|
||||
93
gcloud/run/jobs/remove-iam-policy-binding
Normal file
93
gcloud/run/jobs/remove-iam-policy-binding
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
NAME
|
||||
gcloud run jobs remove-iam-policy-binding - remove IAM policy binding of a
|
||||
Cloud Run job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs remove-iam-policy-binding JOB --member=PRINCIPAL
|
||||
--role=ROLE [--region=REGION] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Remove an IAM policy binding from the IAM policy of a job. One binding
|
||||
consists of a member, and a role.
|
||||
|
||||
EXAMPLES
|
||||
To remove an IAM policy binding for the role of 'roles/run.invoker' for the
|
||||
user 'test-user@gmail.com' with servcie 'my-job' and region 'us-central1',
|
||||
run:
|
||||
|
||||
$ gcloud run jobs remove-iam-policy-binding my-job \
|
||||
--region='us-central1' --member='user:test-user@gmail.com' \
|
||||
--role='roles/run.invoker'
|
||||
|
||||
See https://cloud.google.com/iam/docs/managing-policies for details of
|
||||
policy role and member types.
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - The job for which to remove the IAM policy binding. 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;
|
||||
◆ set the property core/project;
|
||||
◆ provide the argument --project on the command line. To set the region
|
||||
attribute:
|
||||
◆ provide the argument job on the command line with a fully specified
|
||||
name;
|
||||
◆ provide the argument --region on the command line;
|
||||
◆ set the property run/region;
|
||||
◆ specify from a list of available regions in a prompt.
|
||||
|
||||
This must be specified.
|
||||
|
||||
JOB
|
||||
ID of the job or fully qualified identifier for the job. To set the
|
||||
job attribute:
|
||||
▸ provide the argument job on the command line.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--member=PRINCIPAL
|
||||
The principal to remove the binding for. Should be of the form
|
||||
user|group|serviceAccount:email or domain:domain.
|
||||
|
||||
Examples: user:test-user@gmail.com, group:admins@example.com,
|
||||
serviceAccount:test123@example.domain.com, or
|
||||
domain:example.domain.com.
|
||||
|
||||
Deleted principals have an additional deleted: prefix and a ?uid=UID
|
||||
suffix, where UID is a unique identifier for the principal. Example:
|
||||
deleted:user:test-user@gmail.com?uid=123456789012345678901.
|
||||
|
||||
Some resources also accept the following special values:
|
||||
◆ allUsers - Special identifier that represents anyone who is on the
|
||||
internet, with or without a Google account.
|
||||
◆ allAuthenticatedUsers - Special identifier that represents anyone
|
||||
who is authenticated with a Google account or a service account.
|
||||
|
||||
--role=ROLE
|
||||
The role to remove the principal from.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the run/v1 API. The full documentation for this API can
|
||||
be found at: https://cloud.google.com/run/
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs remove-iam-policy-binding
|
||||
|
||||
$ gcloud beta run jobs remove-iam-policy-binding
|
||||
|
||||
45
gcloud/run/jobs/replace
Normal file
45
gcloud/run/jobs/replace
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
NAME
|
||||
gcloud run jobs replace - create or replace a job from a YAML job
|
||||
specification
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs replace FILE [--async] [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
Creates or replaces a job from a YAML job specification.
|
||||
|
||||
EXAMPLES
|
||||
To replace the specification for a job defined in myjob.yaml
|
||||
|
||||
$ gcloud run jobs replace myjob.yaml
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
FILE
|
||||
The absolute path to the YAML file with a Cloud Run job definition for
|
||||
the job to update or create.
|
||||
|
||||
FLAGS
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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 replace
|
||||
|
||||
$ gcloud beta run jobs replace
|
||||
|
||||
79
gcloud/run/jobs/set-iam-policy
Normal file
79
gcloud/run/jobs/set-iam-policy
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
NAME
|
||||
gcloud run jobs set-iam-policy - set the IAM policy for a job
|
||||
|
||||
SYNOPSIS
|
||||
gcloud run jobs set-iam-policy JOB POLICY_FILE [--region=REGION]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
This command replaces the existing IAM policy for a job, given a job and a
|
||||
file encoded in JSON or YAML that contains the IAM policy. If the given
|
||||
policy file specifies an "etag" value, then the replacement will succeed
|
||||
only if the policy already in place matches that etag. (An etag obtain via
|
||||
get-iam-policy will prevent the replacement if the policy for the job has
|
||||
been subsequently updated.) A policy file that does not contain an etag
|
||||
value will replace any existing policy for the job.
|
||||
|
||||
EXAMPLES
|
||||
The following command will read an IAM policy defined in a JSON file
|
||||
'policy.json' and set it for a job with identifier 'my-job'
|
||||
|
||||
$ gcloud run jobs set-iam-policy --region=us-central1 my-job \
|
||||
policy.json
|
||||
|
||||
See https://cloud.google.com/iam/docs/managing-policies for details of the
|
||||
policy file format and contents.
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Job resource - The job for which to set the IAM policy. 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;
|
||||
◆ set the property core/project;
|
||||
◆ provide the argument --project on the command line. To set the region
|
||||
attribute:
|
||||
◆ provide the argument job on the command line with a fully specified
|
||||
name;
|
||||
◆ provide the argument --region on the command line;
|
||||
◆ set the property run/region;
|
||||
◆ specify from a list of available regions in a prompt.
|
||||
|
||||
This must be specified.
|
||||
|
||||
JOB
|
||||
ID of the job or fully qualified identifier for the job. To set the
|
||||
job attribute:
|
||||
▸ provide the argument job on the command line.
|
||||
|
||||
POLICY_FILE
|
||||
Path to a local JSON or YAML formatted file containing a valid policy.
|
||||
|
||||
The output of the get-iam-policy command is a valid file, as is any
|
||||
JSON or YAML file conforming to the structure of a Policy
|
||||
(https://cloud.google.com/iam/reference/rest/v1/Policy).
|
||||
|
||||
FLAGS
|
||||
--region=REGION
|
||||
Region in which the resource can be found. Alternatively, set the
|
||||
property [run/region].
|
||||
|
||||
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.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the run/v1 API. The full documentation for this API can
|
||||
be found at: https://cloud.google.com/run/
|
||||
|
||||
NOTES
|
||||
These variants are also available:
|
||||
|
||||
$ gcloud alpha run jobs set-iam-policy
|
||||
|
||||
$ gcloud beta run jobs set-iam-policy
|
||||
|
||||
283
gcloud/run/jobs/update
Normal file
283
gcloud/run/jobs/update
Normal file
|
|
@ -0,0 +1,283 @@
|
|||
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
|
||||
|
||||
|
|
@ -20,8 +20,9 @@ SYNOPSIS
|
|||
| --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
||||
| --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]
|
||||
--binary-authorization=POLICY
|
||||
| --clear-binary-authorization --clear-key
|
||||
| --key=KEY --clear-post-key-revocation-action-type
|
||||
| --clear-binary-authorization --clear-encryption-key-shutdown-hours
|
||||
| --encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS
|
||||
--clear-key | --key=KEY --clear-post-key-revocation-action-type
|
||||
| --post-key-revocation-action-type=POST_KEY_REVOCATION_ACTION_TYPE]
|
||||
[--clear-env-vars | --env-vars-file=FILE_PATH
|
||||
| --set-env-vars=[KEY=VALUE,...]
|
||||
|
|
@ -276,6 +277,15 @@ FLAGS
|
|||
--clear-binary-authorization
|
||||
Remove any previously set Binary Authorization policy.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-encryption-key-shutdown-hours
|
||||
Remove any previously set CMEK key shutdown hours setting.
|
||||
|
||||
--encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS
|
||||
The number of hours to wait before an automatic shutdown server
|
||||
after CMEK key revocation is detected.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-key
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue