imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Wed Sep 14 09:28:28 UTC 2022

Browse source
This commit is contained in:
Automated 2022-09-14 09:28:28 +00:00
parent e7bec9b31b
commit 8f4214beb2
Failed to extract signature
148 changed files with 5778 additions and 334 deletions
Download patch file Download diff file Expand all files Collapse all files

3
gcloud/deploy/help
View file

@ -18,6 +18,9 @@ GROUPS
delivery-pipelines
Create and manage Delivery Pipeline resources for Google Cloud Deploy.
job-runs
Manages job runs resources for Google Cloud Deploy.
releases
Create and manage Release resources for Google Cloud Deploy.

94
gcloud/deploy/job-runs/describe Normal file
View file

@ -0,0 +1,94 @@
NAME
gcloud deploy job-runs describe - show details for a job run
SYNOPSIS
gcloud deploy job-runs describe
(JOB_RUN : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE --rollout=ROLLOUT)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details for a specified job run.
EXAMPLES
To show details about a job run 'test-jobrun', for delivery pipeline
'test-pipeline', release 'test-release', rollout 'test-rollout', in region
'us-central1', run:
$ gcloud deploy job-runs describe test-jobrun \
--delivery-pipeline=test-pipeline --release=test-release \
--rollout=test-rollout --region=us-central1
POSITIONAL ARGUMENTS
Job run resource - The name of the job run you want to describe. The
arguments in this group can be used to specify the attributes of this
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_run 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_RUN
ID of the job run or fully qualified identifier for the job run. To
set the job_run attribute:
▸ provide the argument job_run on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--delivery-pipeline=DELIVERY_PIPELINE
The name of the Cloud Deploy delivery pipeline.
To set the delivery-pipeline attribute:
▸ provide the argument job_run on the command line with a fully
specified name;
▸ provide the argument --delivery-pipeline on the command line;
▸ set the property deploy/delivery_pipeline.
--region=REGION
Location of the job run.
To set the region attribute:
▸ provide the argument job_run on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
--release=RELEASE
The name of the Cloud Deploy release.
To set the release attribute:
▸ provide the argument job_run on the command line with a fully
specified name;
▸ provide the argument --release on the command line.
--rollout=ROLLOUT
The name of the Cloud Deploy rollout.
To set the rollout attribute:
▸ provide the argument job_run on the command line with a fully
specified name;
▸ provide the argument --rollout on the command line.
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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
These variants are also available:
$ gcloud alpha deploy job-runs describe
$ gcloud beta deploy job-runs describe

30
gcloud/deploy/job-runs/help Normal file
View file

@ -0,0 +1,30 @@
NAME
gcloud deploy job-runs - manages job runs resources for Google Cloud Deploy
SYNOPSIS
gcloud deploy job-runs COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manages job runs resources for Google Cloud Deploy.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
Show details for a job run.
list
List the job runs.
NOTES
These variants are also available:
$ gcloud alpha deploy job-runs
$ gcloud beta deploy job-runs

118
gcloud/deploy/job-runs/list Normal file
View file

@ -0,0 +1,118 @@
NAME
gcloud deploy job-runs list - list the job runs
SYNOPSIS
gcloud deploy job-runs list
(--rollout=ROLLOUT : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List the job runs for a specified delivery pipeline.
EXAMPLES
To list the job runs for delivery pipeline 'test-pipeline', release
'test-release', and rollout 'test-rollout' in region 'us-central1', run:
$ gcloud deploy job-runs list --delivery-pipeline=test-pipeline \
--release=test-release --rollout=test-rollout \
--region=us-central1
REQUIRED FLAGS
Rollout resource - The rollouts for which you want to list the job runs.
The arguments in this group can be used to specify the attributes of this
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 --rollout 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.
--rollout=ROLLOUT
ID of the rollout or fully qualified identifier for the rollout. To
set the rollout attribute:
▸ provide the argument --rollout on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--delivery-pipeline=DELIVERY_PIPELINE
The name of the Cloud Deploy delivery pipeline.
To set the delivery-pipeline attribute:
▸ provide the argument --rollout on the command line with a fully
specified name;
▸ provide the argument --delivery-pipeline on the command line;
▸ set the property deploy/delivery_pipeline.
--region=REGION
Location of the rollout.
To set the region attribute:
▸ provide the argument --rollout on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
--release=RELEASE
The name of the Cloud Deploy release.
To set the release attribute:
▸ provide the argument --rollout on the command line with a fully
specified name;
▸ provide the argument --release on the command line.
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.
API REFERENCE
This command uses the clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
These variants are also available:
$ gcloud alpha deploy job-runs list
$ gcloud beta deploy job-runs list

3
gcloud/deploy/rollouts/help
View file

@ -28,6 +28,9 @@ COMMANDS
reject
Rejects a rollout having an Approval state of "Required".
retry-job
Retries a specified job, phase combination on a rollout.
NOTES
These variants are also available:

88
gcloud/deploy/rollouts/retry-job Normal file
View file

@ -0,0 +1,88 @@
NAME
gcloud deploy rollouts retry-job - retries a specified job, phase
combination on a rollout
SYNOPSIS
gcloud deploy rollouts retry-job
(ROLLOUT : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE) --job-id=JOB_ID
--phase-id=PHASE_ID [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Retries a specified job, phase combination on a rollout.
EXAMPLES
To retry a job 'test-job' in phase 'test-phase' on a rollout 'test-rollout'
for delivery pipeline 'test-pipeline', release 'test-release' in region
'us-central1', run:
$ gcloud deploy rollouts retry-job test-rollout --job-id=test-job \
--phase-id=test-phase --delivery-pipeline=test-pipeline \
--release=test-release --region=us-central1
POSITIONAL ARGUMENTS
Rollout resource - The name of the Rollout. The arguments in this group
can be used to specify the attributes of this 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 rollout 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.
ROLLOUT
ID of the rollout or fully qualified identifier for the rollout. To
set the rollout attribute:
▸ provide the argument rollout on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--delivery-pipeline=DELIVERY_PIPELINE
The delivery pipeline associated with the rollout. Alternatively, set
the property [deploy/delivery-pipeline]. To set the delivery-pipeline
attribute:
▸ provide the argument rollout on the command line with a fully
specified name;
▸ provide the argument --delivery-pipeline on the command line;
▸ set the property deploy/delivery_pipeline.
--region=REGION
The Cloud region for the rollout. Alternatively, set the property
[deploy/region]. To set the region attribute:
▸ provide the argument rollout on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
--release=RELEASE
The release associated with the rollout. To set the release
attribute:
▸ provide the argument rollout on the command line with a fully
specified name;
▸ provide the argument --release on the command line.
REQUIRED FLAGS
--job-id=JOB_ID
Job ID on a rollout resource
--phase-id=PHASE_ID
Phase ID on a rollout resource
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 deploy rollouts retry-job
$ gcloud beta deploy rollouts retry-job

3
gcloud/deploy/targets/help
View file

@ -35,6 +35,9 @@ COMMANDS
list
List Cloud Deploy targets.
redeploy
Redeploy the last rollout to a target.
remove-iam-policy-binding
Remove an IAM policy binding for a Cloud Deploy target.

95
gcloud/deploy/targets/redeploy Normal file
View file

@ -0,0 +1,95 @@
NAME
gcloud deploy targets redeploy - redeploy the last rollout to a target
SYNOPSIS
gcloud deploy targets redeploy (TARGET : --region=REGION)
--delivery-pipeline=DELIVERY_PIPELINE [--annotations=[KEY=VALUE,...]]
[--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
[--rollout-id=ROLLOUT_ID] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Redeploy the last rollout that has a state of SUCCESSFUL or FAILED to a
target. If rollout-id is not specified, a rollout ID will be generated.
EXAMPLES
To redeploy a target prod for delivery pipeline test-pipeline in region
us-central1, run:
$ gcloud deploy targets redeploy prod \
--delivery-pipeline=test-pipeline --region=us-central1
POSITIONAL ARGUMENTS
Target resource - The name of the Target. The arguments in this group can
be used to specify the attributes of this 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 target 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.
TARGET
ID of the target or fully qualified identifier for the target. To set
the target attribute:
▸ provide the argument target on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
The Cloud region for the target. Alternatively, set the property
[deploy/region]. To set the region attribute:
▸ provide the argument target on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
REQUIRED FLAGS
--delivery-pipeline=DELIVERY_PIPELINE
The name of the Cloud Deploy delivery pipeline
OPTIONAL FLAGS
--annotations=[KEY=VALUE,...]
Annotations to apply to the rollout. Annotations take the form of
key/value string pairs.
Examples:
Add annotations:
$ gcloud deploy targets redeploy \
--annotations="from_target=test,status=stable"
--description=DESCRIPTION
Description of rollout created during a rollback.
--labels=[KEY=VALUE,...]
Labels to apply to the rollout. Labels take the form of key/value
string pairs.
Examples:
Add labels:
$ gcloud deploy targets redeploy --labels="commit=abc123,author=foo"
--rollout-id=ROLLOUT_ID
ID to assign to the generated rollout for promotion.
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 deploy targets redeploy
$ gcloud beta deploy targets redeploy