1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 18:45:13 +00:00

gcloud: Wed Mar 29 10:40:15 UTC 2023

This commit is contained in:
Automated 2023-03-29 10:40:15 +00:00
parent 4ccfc7a5e3
commit 5fabf24be7
269 changed files with 6797 additions and 464 deletions

View file

@ -22,6 +22,9 @@ COMMANDS
list
(ALPHA) List the job runs.
terminate
(ALPHA) Terminates a Cloud Deploy job run.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct

View file

@ -0,0 +1,88 @@
NAME
gcloud alpha deploy job-runs terminate - terminates a Cloud Deploy job run
SYNOPSIS
gcloud alpha deploy job-runs terminate
(JOB_RUN : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE --rollout=ROLLOUT)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Terminates a Cloud Deploy job run.
EXAMPLES
To terminate a job run test-jobrun, for delivery pipeline 'test-pipeline',
release 'test-release', rollout 'test-rollout', in region 'us-central1',
run:
$ gcloud alpha deploy job-runs terminate 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. 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 name 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 delivery pipeline associated with the job_run. Alternatively, set
the property [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
The Cloud region for the job_run. Alternatively, set the property
[deploy/region]. 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 release associated with the job_run. 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 rollout associated with the job_run. 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.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta deploy job-runs terminate

View file

@ -12,7 +12,8 @@ SYNOPSIS
[--build-artifacts=BUILD_ARTIFACTS | --images=[NAME=TAG,...]]
[--disable-initial-rollout | --enable-initial-rollout
--initial-rollout-annotations=[KEY=VALUE,...]
--initial-rollout-labels=[KEY=VALUE,...]]
--initial-rollout-labels=[KEY=VALUE,...]
--initial-rollout-phase-id=INITIAL_ROLLOUT_PHASE_ID]
[--from-k8s-manifest=FROM_K8S_MANIFEST
| --from-run-manifest=FROM_RUN_MANIFEST
| --skaffold-file=SKAFFOLD_FILE --source=SOURCE; default="."]
@ -184,6 +185,18 @@ FLAGS
$ gcloud alpha deploy releases create \
initial-rollout-labels="commit=abc123,author=foo"
--initial-rollout-phase-id=INITIAL_ROLLOUT_PHASE_ID
The phase to start the initial rollout at when creating the release.
The phase ID must be a valid phase on the rollout. If not specified,
then the rollout will start at the first phase.
Examples:
Start rollout at stable phase:
$ gcloud alpha deploy releases create \
--initial-rollout-phase-id=stable
At most one of these can be specified:
--from-k8s-manifest=FROM_K8S_MANIFEST

View file

@ -7,8 +7,8 @@ SYNOPSIS
(--release=RELEASE
: --delivery-pipeline=DELIVERY_PIPELINE --region=REGION)
[--annotations=[KEY=VALUE,...]] [--labels=[KEY=VALUE,...]]
[--rollout-id=ROLLOUT_ID] [--to-target=TO_TARGET]
[GCLOUD_WIDE_FLAG ...]
[--rollout-id=ROLLOUT_ID] [--starting-phase-id=STARTING_PHASE_ID]
[--to-target=TO_TARGET] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) If to-target is not specified the command promotes the release from
@ -86,6 +86,13 @@ OPTIONAL FLAGS
--rollout-id=ROLLOUT_ID
ID to assign to the generated rollout for promotion.
--starting-phase-id=STARTING_PHASE_ID
If set, starts the created rollout at the specified phase.
Start rollout at stable phase:
$ gcloud alpha deploy releases promote --starting-phase-id=stable
--to-target=TO_TARGET
Destination target to promote into.

View file

@ -0,0 +1,84 @@
NAME
gcloud alpha deploy rollouts advance - advances a rollout
SYNOPSIS
gcloud alpha deploy rollouts advance
(ROLLOUT : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE) [--phase-id=PHASE_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Advances a rollout.
EXAMPLES
To advance a rollout test-rollout to phase test-phase for delivery pipeline
test-pipeline, release test-release in region us-central1, run:
$ gcloud alpha deploy rollouts advance test-rollout \
--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.
FLAGS
--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
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta deploy rollouts advance

View file

@ -0,0 +1,79 @@
NAME
gcloud alpha deploy rollouts cancel - cancel a Rollout
SYNOPSIS
gcloud alpha deploy rollouts cancel
(ROLLOUT : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Cancel a Rollout.
EXAMPLES
To cancel a rollout test-rollout for delivery pipeline test-pipeline,
release test-release in region us-central1, run:
$ gcloud alpha deploy rollouts cancel test-rollout \
--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.
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
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta deploy rollouts cancel

View file

@ -16,12 +16,21 @@ GCLOUD WIDE FLAGS
COMMANDS
COMMAND is one of the following:
advance
(ALPHA) Advances a rollout.
approve
(ALPHA) Approves a rollout having an Approval state of "Required".
cancel
(ALPHA) Cancel a Rollout.
describe
(ALPHA) Show details for a rollout.
ignore-job
(ALPHA) Ignores a specified job and phase combination on a rollout.
list
(ALPHA) List the rollouts.

View file

@ -0,0 +1,90 @@
NAME
gcloud alpha deploy rollouts ignore-job - ignores a specified job and phase
combination on a rollout
SYNOPSIS
gcloud alpha deploy rollouts ignore-job
(ROLLOUT : --delivery-pipeline=DELIVERY_PIPELINE
--region=REGION --release=RELEASE) --job-id=JOB_ID
--phase-id=PHASE_ID [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Ignores a specified job and phase combination on a rollout.
EXAMPLES
To ignore 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 alpha deploy rollouts ignore-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
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta deploy rollouts ignore-job

View file

@ -6,7 +6,8 @@ SYNOPSIS
gcloud alpha 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 ...]
[--rollout-id=ROLLOUT_ID] [--starting-phase-id=STARTING_PHASE_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Redeploy the last rollout that has a state of SUCCESSFUL or FAILED
@ -81,6 +82,13 @@ OPTIONAL FLAGS
--rollout-id=ROLLOUT_ID
ID to assign to the generated rollout for promotion.
--starting-phase-id=STARTING_PHASE_ID
If set, starts the created rollout at the specified phase.
Start rollout at stable phase:
$ gcloud alpha deploy targets redeploy --starting-phase-id=stable
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -6,7 +6,8 @@ SYNOPSIS
gcloud alpha deploy targets rollback (TARGET : --region=REGION)
--delivery-pipeline=DELIVERY_PIPELINE [--annotations=[KEY=VALUE,...]]
[--description=DESCRIPTION] [--labels=[KEY=VALUE,...]]
[--release=RELEASE] [--rollout-id=ROLLOUT_ID] [GCLOUD_WIDE_FLAG ...]
[--release=RELEASE] [--rollout-id=ROLLOUT_ID]
[--starting-phase-id=STARTING_PHASE_ID] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) If release is not specified, the command rollbacks the target with
@ -84,6 +85,13 @@ OPTIONAL FLAGS
--rollout-id=ROLLOUT_ID
ID to assign to the generated rollout for promotion.
--starting-phase-id=STARTING_PHASE_ID
If set, starts the created rollout at the specified phase.
Start rollout at stable phase:
$ gcloud alpha deploy targets rollback --starting-phase-id=stable
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,