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

gcloud: Thu Dec 14 10:23:57 UTC 2023

Browse source
This commit is contained in:
Automated 2023-12-14 10:23:58 +00:00
parent f36750d203
commit a990278fb3
205 changed files with 4929 additions and 1866 deletions
Download patch file Download diff file Expand all files Collapse all files

7
gcloud/alpha/deploy/apply
View file

@ -1,7 +1,7 @@
NAME
gcloud alpha deploy apply - applies a yaml configuration containing
Delivery Pipeline(s), Target(s) and Automation(s) declarative
definitions
Delivery Pipeline(s), Target(s), Custom Target Type(s), and
Automation(s) declarative definitions
SYNOPSIS
gcloud alpha deploy apply --file=FILE [--region=REGION]
@ -9,7 +9,8 @@ SYNOPSIS
DESCRIPTION
(ALPHA) Applies a yaml configuration containing Delivery Pipeline(s),
Target(s) and Automation(s) declarative definitions.
Target(s), Custom Target Type(s), and Automation(s) declarative
definitions.
EXAMPLES
To apply a Cloud Deploy YAML file deploy.yaml:

78
gcloud/alpha/deploy/custom-target-types/delete Normal file
View file

@ -0,0 +1,78 @@
NAME
gcloud alpha deploy custom-target-types delete - delete a custom target
type
SYNOPSIS
gcloud alpha deploy custom-target-types delete
(CUSTOM_TARGET_TYPE : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a custom target type for a specified region.
EXAMPLES
The following command will delete custom target type
test-custom-target-type, in region us-central1:
$ gcloud alpha deploy custom-target-types delete \
test-custom-target-type --region=us-central1
POSITIONAL ARGUMENTS
Custom target type resource - The name of the custom target type to
delete. 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 custom_target_type 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.
CUSTOM_TARGET_TYPE
ID of the custom target type or fully qualified identifier for the
custom target type.
To set the custom_target_type attribute:
▸ provide the argument custom_target_type on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Location of the custom target type.
To set the region attribute:
▸ provide the argument custom_target_type on the command line with
a fully specified name;
▸ provide the argument --region on the command line;
▸ set the property deploy/region.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 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. These variants are also available:
$ gcloud deploy custom-target-types delete
$ gcloud beta deploy custom-target-types delete

73
gcloud/alpha/deploy/custom-target-types/describe Normal file
View file

@ -0,0 +1,73 @@
NAME
gcloud alpha deploy custom-target-types describe - show details for a
custom target type
SYNOPSIS
gcloud alpha deploy custom-target-types describe
(CUSTOM_TARGET_TYPE : --region=REGION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Show details for a specified custom target type.
EXAMPLES
To show details about a custom target type test-custom-target-type in
region us-central, run:
$ gcloud alpha deploy custom-target-types describe \
test-custom-target-type --region=us-central1
POSITIONAL ARGUMENTS
Custom target type resource - The name of the custom target type 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 custom_target_type 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.
CUSTOM_TARGET_TYPE
ID of the custom target type or fully qualified identifier for the
custom target type.
To set the custom_target_type attribute:
▸ provide the argument custom_target_type on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--region=REGION
Location of the custom target type.
To set the region attribute:
▸ provide the argument custom_target_type 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 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. These variants are also available:
$ gcloud deploy custom-target-types describe
$ gcloud beta deploy custom-target-types describe

77
gcloud/alpha/deploy/custom-target-types/export Normal file
View file

@ -0,0 +1,77 @@
NAME
gcloud alpha deploy custom-target-types export - returns the .yaml
definition of the specified custom target type
SYNOPSIS
gcloud alpha deploy custom-target-types export
(CUSTOM_TARGET_TYPE : --region=REGION) [--destination=DESTINATION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) The exported yaml definition can be applied by deploy apply
command.
EXAMPLES
To return the .yaml definition of the custom target type
test-custom-target-type, in region us-central1, run:
$ gcloud alpha deploy custom-target-types export \
test-custom-target-type --region=us-central1
POSITIONAL ARGUMENTS
Custom target type resource - The name of the Custom Target Type. 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 custom_target_type 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.
CUSTOM_TARGET_TYPE
ID of the custom_target_type or fully qualified identifier for the
custom_target_type.
To set the custom_target_type attribute:
▸ provide the argument custom_target_type 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 custom_target_type. Alternatively, set the
property [deploy/region].
To set the region attribute:
▸ provide the argument custom_target_type 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 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. These variants are also available:
$ gcloud deploy custom-target-types export
$ gcloud beta deploy custom-target-types export

41
gcloud/alpha/deploy/custom-target-types/help Normal file
View file

@ -0,0 +1,41 @@
NAME
gcloud alpha deploy custom-target-types - create and manage Custom Target
Type resources for Cloud Deploy
SYNOPSIS
gcloud alpha deploy custom-target-types COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create and manage Custom Target Type 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
(ALPHA) Delete a custom target type.
describe
(ALPHA) Show details for a custom target type.
export
(ALPHA) Returns the .yaml definition of the specified custom target
type.
list
(ALPHA) List the custom target types.
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. These variants are also available:
$ gcloud deploy custom-target-types
$ gcloud beta deploy custom-target-types

89
gcloud/alpha/deploy/custom-target-types/list Normal file
View file

@ -0,0 +1,89 @@
NAME
gcloud alpha deploy custom-target-types list - list the custom target types
SYNOPSIS
gcloud alpha deploy custom-target-types list [--region=REGION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List the custom target types for a specified region.
EXAMPLES
To list the custom target types in region us-central1, run:
$ gcloud alpha deploy custom-target-types list --region=us-central1
FLAGS
Location resource - The region for which you want to list the custom
target types. 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 --region on the command line with a fully
specified name;
◆ set the property deploy/region with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--region=REGION
ID of the location or fully qualified identifier for the location.
To set the region attribute:
▸ 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 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. These variants are also available:
$ gcloud deploy custom-target-types list
$ gcloud beta deploy custom-target-types list

10
gcloud/alpha/deploy/delete
View file

@ -1,17 +1,17 @@
NAME
gcloud alpha deploy delete - deletes delivery pipeline(s) and target(s) in
a yaml configuration
gcloud alpha deploy delete - deletes Delivery Pipeline(s), Target(s),
Custom Target Type(s), and Automation(s) in a yaml configuration
SYNOPSIS
gcloud alpha deploy delete --file=FILE [--force] [--region=REGION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Deletes delivery pipeline(s) and target(s) in a yaml configuration.
(ALPHA) Deletes Delivery Pipeline(s), Target(s), Custom Target Type(s), and
Automation(s) in a yaml configuration.
EXAMPLES
To delete the delivery pipeline(s) and target(s) in a Cloud Deploy YAML
file deploy.yaml:
To delete the resources in a Cloud Deploy YAML file deploy.yaml:
$ gcloud alpha deploy delete --file=deploy.yaml --region=us-central1

11
gcloud/alpha/deploy/help
View file

@ -21,6 +21,10 @@ GROUPS
automations
(ALPHA) Manages Automations resources for Cloud Deploy.
custom-target-types
(ALPHA) Create and manage Custom Target Type resources for Cloud
Deploy.
delivery-pipelines
(ALPHA) Create and manage Delivery Pipeline resources for Cloud Deploy.
@ -41,11 +45,12 @@ COMMANDS
apply
(ALPHA) Applies a yaml configuration containing Delivery Pipeline(s),
Target(s) and Automation(s) declarative definitions.
Target(s), Custom Target Type(s), and Automation(s) declarative
definitions.
delete
(ALPHA) Deletes delivery pipeline(s) and target(s) in a yaml
configuration.
(ALPHA) Deletes Delivery Pipeline(s), Target(s), Custom Target Type(s),
and Automation(s) in a yaml configuration.
get-config
(ALPHA) Get the Cloud Deploy config for the provided region and