1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00

gcloud: Thu Nov 9 11:45:52 UTC 2023

This commit is contained in:
Automated 2023-11-09 11:45:52 +00:00
parent f2c5d1d45f
commit 03f0979970
300 changed files with 8569 additions and 1319 deletions

View file

@ -1,14 +1,14 @@
NAME
gcloud beta deploy apply - applies a yaml configuration containing Deliver
Pipeline(s), Target(s) declarative definitions
gcloud beta deploy apply - applies a yaml configuration containing Delivery
Pipeline(s), Target(s) and Automation(s) declarative definitions
SYNOPSIS
gcloud beta deploy apply --file=FILE [--region=REGION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Applies a yaml configuration containing Deliver Pipeline(s),
Target(s) declarative definitions.
(BETA) Applies a yaml configuration containing Delivery Pipeline(s),
Target(s) and Automation(s) declarative definitions.
EXAMPLES
To apply a Cloud Deploy YAML file deploy.yaml:

View file

@ -0,0 +1,80 @@
NAME
gcloud beta deploy automation-runs cancel - cancels a Cloud Deploy
Automation Run
SYNOPSIS
gcloud beta deploy automation-runs cancel
(AUTOMATION_RUN
: --delivery-pipeline=DELIVERY_PIPELINE --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Cancels a Cloud Deploy Automation Run.
EXAMPLES
To cancel an AutomationRun test-run for delivery pipeline test-pipeline in
region us-central1, run:
$ gcloud beta deploy automation-runs cancel test-run \
--delivery-pipeline=test-pipeline --region=us-central1
POSITIONAL ARGUMENTS
Automation run resource - The name of the AutomationRun. 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 automation_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.
AUTOMATION_RUN
ID of the automation_run or fully qualified identifier for the
automation_run.
To set the name attribute:
▸ provide the argument automation_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 automation_run.
Alternatively, set the property [deploy/delivery-pipeline].
To set the delivery-pipeline attribute:
▸ provide the argument automation_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 automation_run. Alternatively, set the
property [deploy/region].
To set the region attribute:
▸ provide the argument automation_run on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/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
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automation-runs cancel
$ gcloud alpha deploy automation-runs cancel

View file

@ -0,0 +1,82 @@
NAME
gcloud beta deploy automation-runs describe - show details for an
Automation Run
SYNOPSIS
gcloud beta deploy automation-runs describe
(AUTOMATION_RUN
: --delivery-pipeline=DELIVERY_PIPELINE --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Show details for a specified automation run.
EXAMPLES
To show details about a automation run 'test-automationrun', for delivery
pipeline 'test-pipeline', in region 'us-central1', run:
$ gcloud beta deploy automation-runs describe test-automationrun \
--delivery-pipeline=test-pipeline --region=us-central1
POSITIONAL ARGUMENTS
Automation run resource - The name of the automation 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 automation_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.
AUTOMATION_RUN
ID of the automation run or fully qualified identifier for the
automation run.
To set the automation_run attribute:
▸ provide the argument automation_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 automation_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 automation run.
To set the region attribute:
▸ provide the argument automation_run on the command line with a
fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automation-runs describe
$ gcloud alpha deploy automation-runs describe

View file

@ -0,0 +1,35 @@
NAME
gcloud beta deploy automation-runs - manages AutomationRuns resources for
Cloud Deploy
SYNOPSIS
gcloud beta deploy automation-runs COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manages AutomationRuns resources for 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:
cancel
(BETA) Cancels a Cloud Deploy Automation Run.
describe
(BETA) Show details for an Automation Run.
list
(BETA) List the Automation Runs.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automation-runs
$ gcloud alpha deploy automation-runs

View file

@ -0,0 +1,104 @@
NAME
gcloud beta deploy automation-runs list - list the Automation Runs
SYNOPSIS
gcloud beta deploy automation-runs list
[--delivery-pipeline=DELIVERY_PIPELINE --region=REGION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List the automation runs for a specified delivery pipeline.
EXAMPLES
To list the automation runs for delivery pipeline 'test-pipeline' in region
'us-central1', run:
$ gcloud beta deploy automation-runs list \
--delivery-pipeline=test-pipeline --region=us-central1
FLAGS
Delivery pipeline resource - The delivery pipeline for which you want to
list the automation 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 --delivery-pipeline on the command line with a
fully specified name;
◆ set the property deploy/delivery_pipeline with a fully specified
name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--delivery-pipeline=DELIVERY_PIPELINE
ID of the delivery_pipeline or fully qualified identifier for the
delivery_pipeline.
To set the delivery-pipeline attribute:
▸ provide the argument --delivery-pipeline on the command line;
▸ set the property deploy/delivery_pipeline.
--region=REGION
Location of the delivery_pipeline.
To set the region attribute:
▸ provide the argument --delivery-pipeline on the command line with
a fully specified name;
▸ set the property deploy/delivery_pipeline with a fully specified
name;
▸ provide the argument --region on the command line;
▸ set the property deploy/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.
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
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automation-runs list
$ gcloud alpha deploy automation-runs list

View file

@ -0,0 +1,78 @@
NAME
gcloud beta deploy automations delete - deletes a Cloud Deploy Automation
SYNOPSIS
gcloud beta deploy automations delete
(AUTOMATION : --delivery-pipeline=DELIVERY_PIPELINE --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Deletes a Cloud Deploy Automation.
EXAMPLES
To delete an automation test-automation for delivery pipeline
test-pipeline, in region us-central1, run:
$ gcloud beta deploy automations delete test-automation \
--delivery-pipeline=test-pipeline --region=us-central1
POSITIONAL ARGUMENTS
Automation resource - The name of the Automation. 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 automation 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.
AUTOMATION
ID of the automation or fully qualified identifier for the
automation.
To set the name attribute:
▸ provide the argument automation 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 automation. Alternatively,
set the property [deploy/delivery-pipeline].
To set the delivery-pipeline attribute:
▸ provide the argument automation 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 automation. Alternatively, set the property
[deploy/region].
To set the region attribute:
▸ provide the argument automation on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/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
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automations delete
$ gcloud alpha deploy automations delete

View file

@ -0,0 +1,80 @@
NAME
gcloud beta deploy automations describe - show details for an Automation
SYNOPSIS
gcloud beta deploy automations describe
(AUTOMATION : --delivery-pipeline=DELIVERY_PIPELINE --region=REGION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Show details for a specified automation.
EXAMPLES
To show details about an automation 'test-automation', for delivery
pipeline 'test-pipeline', in region 'us-central1', run:
$ gcloud beta deploy automations describe test-automation \
--delivery-pipeline=test-pipeline --region=us-central1
POSITIONAL ARGUMENTS
Automation resource - The name of the automation 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 automation 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.
AUTOMATION
ID of the automation or fully qualified identifier for the
automation.
To set the automation attribute:
▸ provide the argument automation 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 automation 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 automation.
To set the region attribute:
▸ provide the argument automation on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/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 clouddeploy/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/deploy/
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automations describe
$ gcloud alpha deploy automations describe

View file

@ -0,0 +1,85 @@
NAME
gcloud beta deploy automations export - returns the YAML definition of the
specified Automation
SYNOPSIS
gcloud beta deploy automations export
(AUTOMATION : --delivery-pipeline=DELIVERY_PIPELINE --region=REGION)
[--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) The exported yaml definition can be applied by using the deploy
apply command.
EXAMPLES
To return the YAML definition of the automation test-automation of delivery
pipeline test-pipeline, in region us-central1, run:
$ gcloud beta deploy automations export test-automation \
--delivery-pipeline=test-pipeline --region=us-central1
POSITIONAL ARGUMENTS
Automation resource - The name of the Automation. 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 automation 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.
AUTOMATION
ID of the automation or fully qualified identifier for the
automation.
To set the name attribute:
▸ provide the argument automation 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 automation. Alternatively,
set the property [deploy/delivery-pipeline].
To set the delivery-pipeline attribute:
▸ provide the argument automation 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 automation. Alternatively, set the property
[deploy/region].
To set the region attribute:
▸ provide the argument automation on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
FLAGS
--destination=DESTINATION
Path to a YAML file where the configuration will be exported.
Alternatively, you may omit this flag to write to standard output.
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 beta and might change without notice. These
variants are also available:
$ gcloud deploy automations export
$ gcloud alpha deploy automations export

View file

@ -0,0 +1,38 @@
NAME
gcloud beta deploy automations - manages Automations resources for Cloud
Deploy
SYNOPSIS
gcloud beta deploy automations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manages Automations resources for 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:
delete
(BETA) Deletes a Cloud Deploy Automation.
describe
(BETA) Show details for an Automation.
export
(BETA) Returns the YAML definition of the specified Automation.
list
(BETA) List the Automations.
NOTES
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automations
$ gcloud alpha deploy automations

View file

@ -0,0 +1,104 @@
NAME
gcloud beta deploy automations list - list the Automations
SYNOPSIS
gcloud beta deploy automations list
[--delivery-pipeline=DELIVERY_PIPELINE --region=REGION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List the automations for a specified delivery pipeline.
EXAMPLES
To list the automations for delivery pipeline 'test-pipeline' in region
'us-central1', run:
$ gcloud beta deploy automations list \
--delivery-pipeline=test-pipeline --region=us-central1
FLAGS
Delivery pipeline resource - The delivery pipeline for which you want to
list the automations. 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 --delivery-pipeline on the command line with a
fully specified name;
◆ set the property deploy/delivery_pipeline with a fully specified
name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--delivery-pipeline=DELIVERY_PIPELINE
ID of the delivery_pipeline or fully qualified identifier for the
delivery_pipeline.
To set the delivery-pipeline attribute:
▸ provide the argument --delivery-pipeline on the command line;
▸ set the property deploy/delivery_pipeline.
--region=REGION
Location of the delivery_pipeline.
To set the region attribute:
▸ provide the argument --delivery-pipeline on the command line with
a fully specified name;
▸ set the property deploy/delivery_pipeline with a fully specified
name;
▸ provide the argument --region on the command line;
▸ set the property deploy/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.
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
This command is currently in beta and might change without notice. These
variants are also available:
$ gcloud deploy automations list
$ gcloud alpha deploy automations list

View file

@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS
GROUPS
GROUP is one of the following:
automation-runs
(BETA) Manages AutomationRuns resources for Cloud Deploy.
automations
(BETA) Manages Automations resources for Cloud Deploy.
delivery-pipelines
(BETA) Create and manage Delivery Pipeline resources for Cloud Deploy.
@ -34,8 +40,8 @@ COMMANDS
COMMAND is one of the following:
apply
(BETA) Applies a yaml configuration containing Deliver Pipeline(s),
Target(s) declarative definitions.
(BETA) Applies a yaml configuration containing Delivery Pipeline(s),
Target(s) and Automation(s) declarative definitions.
delete
(BETA) Deletes delivery pipeline(s) and target(s) in a yaml