diff --git a/gcloud/_version b/gcloud/_version index c7975de6d..48b54aa21 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 407.0.0 -alpha 2022.10.21 -beta 2022.10.21 -bq 2.0.79 -bundled-python3-unix 3.9.12 -core 2022.10.21 +Google Cloud SDK 414.0.0 +alpha 2023.01.13 +beta 2023.01.13 +bq 2.0.84 +bundled-python3-unix 3.9.16 +core 2023.01.13 gcloud-crc32c 1.0.0 -gsutil 5.15 +gsutil 5.18 diff --git a/gcloud/access-context-manager/authorized-orgs/create b/gcloud/access-context-manager/authorized-orgs/create new file mode 100644 index 000000000..6f8eee50d --- /dev/null +++ b/gcloud/access-context-manager/authorized-orgs/create @@ -0,0 +1,93 @@ +NAME + gcloud access-context-manager authorized-orgs create - create a new + authorized organizations description + +SYNOPSIS + gcloud access-context-manager authorized-orgs create + (AUTHORIZED_ORGS_DESC : --policy=POLICY) --asset_type=ASSET_TYPE + --authorization_direction=AUTHORIZATION_DIRECTION + --authorization_type=AUTHORIZATION_TYPE [--async] [--orgs=[ORGS,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new authorized organizations description in a given access policy. + +EXAMPLES + To create a new authorized organizations description: + + $ gcloud access-context-manager authorized-orgs create \ + --orgs=organizations/12345 --policy=9876543 + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized organizations description + to create. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized-orgs-desc or fully qualified identifier for the + authorized-orgs-desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. + + To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +REQUIRED FLAGS + --asset_type=ASSET_TYPE + The asset type of this authorized organizations description. For + example, device, or credential strength. ASSET_TYPE must be one of: + asset-type-credential-strength, asset-type-device, + asset-type-unspecified. + + --authorization_direction=AUTHORIZATION_DIRECTION + Authorization direction of this authorization relationship. Specifies + whether to allow specified organizations to evaluate this + organization's traffic, or allow specified organizations traffic to be + evaluated by this org. AUTHORIZATION_DIRECTION must be one of: + authorization-direction-from, authorization-direction-to, + authorization-direction-unspecified. + + --authorization_type=AUTHORIZATION_TYPE + The authorization type of the authorized organizations description. For + example, trust, troubleshooting or logging. AUTHORIZATION_TYPE must be + one of: authorization-type-trust, authorization-type-unspecified. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --orgs=[ORGS,...] + Comma-separated list of organizations (in the following format: + organizations/). + +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 accesscontextmanager/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +NOTES + This variant is also available: + + $ gcloud alpha access-context-manager authorized-orgs create + diff --git a/gcloud/access-context-manager/authorized-orgs/delete b/gcloud/access-context-manager/authorized-orgs/delete new file mode 100644 index 000000000..39f497ff0 --- /dev/null +++ b/gcloud/access-context-manager/authorized-orgs/delete @@ -0,0 +1,67 @@ +NAME + gcloud access-context-manager authorized-orgs delete - delete an authorized + organizations description + +SYNOPSIS + gcloud access-context-manager authorized-orgs delete + (AUTHORIZED_ORGS_DESC : --policy=POLICY) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an authorized organizations description in a given access policy. + +EXAMPLES + To delete an existing authorized organizations description, run: + + $ gcloud access-context-manager authorized-orgs delete \ + my_authorized_orgs_desc_id + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized organizations description + you want to delete. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized-orgs-desc or fully qualified identifier for the + authorized-orgs-desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. + + To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +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 accesscontextmanager/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +NOTES + This variant is also available: + + $ gcloud alpha access-context-manager authorized-orgs delete + diff --git a/gcloud/access-context-manager/authorized-orgs/describe b/gcloud/access-context-manager/authorized-orgs/describe new file mode 100644 index 000000000..e076be8fb --- /dev/null +++ b/gcloud/access-context-manager/authorized-orgs/describe @@ -0,0 +1,61 @@ +NAME + gcloud access-context-manager authorized-orgs describe - show details about + an authorized organizations description + +SYNOPSIS + gcloud access-context-manager authorized-orgs describe + (AUTHORIZED_ORGS_DESC : --policy=POLICY) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about an existing authorized organizations description. + +EXAMPLES + To get details about an existing authorized organizations description, run: + + $ gcloud access-context-manager authorized-orgs describe \ + my_authorized_orgs_desc_id + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized organizations description + for which you want to show details. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized-orgs-desc or fully qualified identifier for the + authorized-orgs-desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. + + To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +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 accesscontextmanager/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +NOTES + This variant is also available: + + $ gcloud alpha access-context-manager authorized-orgs describe + diff --git a/gcloud/access-context-manager/authorized-orgs/help b/gcloud/access-context-manager/authorized-orgs/help new file mode 100644 index 000000000..196cedae0 --- /dev/null +++ b/gcloud/access-context-manager/authorized-orgs/help @@ -0,0 +1,44 @@ +NAME + gcloud access-context-manager authorized-orgs - manage Access Context + Manager authorized organizations descriptions + +SYNOPSIS + gcloud access-context-manager authorized-orgs COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + An authorized organizations description describes a list of organizations + (1) that have been authorized to use certain asset (for example, device) + data owned by different organizations at the enforcement points, or (2) + with certain asset (for example, device) have been authorized to access the + resources in another organization at the enforcement points. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a new authorized organizations description. + + delete + Delete an authorized organizations description. + + describe + Show details about an authorized organizations description. + + list + List authorized organizations descriptions. + + update + Update the organizations for an existing authorized organizations + description. + +NOTES + This variant is also available: + + $ gcloud alpha access-context-manager authorized-orgs + diff --git a/gcloud/access-context-manager/authorized-orgs/list b/gcloud/access-context-manager/authorized-orgs/list new file mode 100644 index 000000000..7d161a35d --- /dev/null +++ b/gcloud/access-context-manager/authorized-orgs/list @@ -0,0 +1,80 @@ +NAME + gcloud access-context-manager authorized-orgs list - list authorized + organizations descriptions + +SYNOPSIS + gcloud access-context-manager authorized-orgs list [--policy=POLICY] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List all service access zones in an access policy object. + +EXAMPLES + To list authorized organizations description in an access policy, run: + + $ gcloud access-context-manager authorized-orgs list + + This command prints out a list of authorized organizations descriptions in + a tabular form: + + NAME + my_authorized_orgs_desc + +FLAGS + Policy resource - The access policy for which you want to list the + corresponding authorized organizations descriptions. This represents a + Cloud resource. + + --policy=POLICY + ID of the policy or fully qualified identifier for the policy. To set + the policy attribute: + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +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 accesscontextmanager/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +NOTES + This variant is also available: + + $ gcloud alpha access-context-manager authorized-orgs list + diff --git a/gcloud/access-context-manager/authorized-orgs/update b/gcloud/access-context-manager/authorized-orgs/update new file mode 100644 index 000000000..76dfddee2 --- /dev/null +++ b/gcloud/access-context-manager/authorized-orgs/update @@ -0,0 +1,73 @@ +NAME + gcloud access-context-manager authorized-orgs update - update the + organizations for an existing authorized organizations description + +SYNOPSIS + gcloud access-context-manager authorized-orgs update + (AUTHORIZED_ORGS_DESC : --policy=POLICY) + [--add-orgs=[ORGS,...] | --clear-orgs | --remove-orgs=[ORGS,...] + | --set-orgs=[ORGS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + This command updates an authorized organizations description. + +EXAMPLES + To update the organizations for an authorized organizations description: + + $ gcloud access-context-manager authorized-orgs update \ + my-authorized-orgs \ + --add-orgs="organizations/123,organizations/456" + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized orgs desc to update. The + arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized_orgs_desc or fully qualified identifier for the + authorized_orgs_desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy. + +FLAGS + These flags modify the member orgs of this authorized_orgs_desc. Orgs must + be organizations, in the form organizations/. + + At most one of these can be specified: + + --add-orgs=[ORGS,...] + Append the given values to the current orgs. + + --clear-orgs + Empty the current orgs. + + --remove-orgs=[ORGS,...] + Remove the given values from the current orgs. + + --set-orgs=[ORGS,...] + Completely replace the current orgs with the given values. + +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 variant is also available: + + $ gcloud alpha access-context-manager authorized-orgs update + diff --git a/gcloud/access-context-manager/cloud-bindings/update b/gcloud/access-context-manager/cloud-bindings/update index 3e0961d32..172be3005 100644 --- a/gcloud/access-context-manager/cloud-bindings/update +++ b/gcloud/access-context-manager/cloud-bindings/update @@ -14,8 +14,8 @@ EXAMPLES To update a existing cloud access binding, run: $ gcloud access-context-manager cloud-bindings update \ - --binding=my-binding-id \ - --level=accessPolicies/123/accessLevels/new-abc + --binding=my-binding-id \ + --level=accessPolicies/123/accessLevels/new-abc REQUIRED FLAGS --level=[LEVEL,...] diff --git a/gcloud/access-context-manager/help b/gcloud/access-context-manager/help index bc21a80c9..dc67d429c 100644 --- a/gcloud/access-context-manager/help +++ b/gcloud/access-context-manager/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + authorized-orgs + Manage Access Context Manager authorized organizations descriptions. + cloud-bindings Manage Access Context Manager cloud access bindings. diff --git a/gcloud/ai/custom-jobs/create b/gcloud/ai/custom-jobs/create index 69c25ba23..593094e1c 100644 --- a/gcloud/ai/custom-jobs/create +++ b/gcloud/ai/custom-jobs/create @@ -84,6 +84,9 @@ REQUIRED FLAGS field in WorkerPoolSpec API message. executor-image-uri The URI of a container image that will run the provided package. + output-image-uri + The URI of a custom container image to be built for autopackaged + custom jobs. python-module The Python module name to run within the provided package. local-package-path @@ -135,7 +138,15 @@ REQUIRED FLAGS Example: --worker-pool-spec=machine-type=e2-standard-4,executor-image-uri=us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-4:latest,python-module=trainer.task - local-package-path, executor-image-uri, python-module|script + output-image-uri + Specify this field to push the output custom container training + image to a specific path in Container Registry or Artifact + Registry for an autopackaged custom job. + + Example: + --worker-pool-spec=machine-type=e2-standard-4,executor-image-uri=us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-4:latest,output-image-uri='eu.gcr.io/projectName/imageName',python-module=trainer.task + + local-package-path, executor-image-uri, output-image-uri, python-module|script Specify these fields, optionally with requirements, extra-packages, or extra-dirs, to train using a pre-built container and Python code from a local path. In this case, the diff --git a/gcloud/ai/models/upload b/gcloud/ai/models/upload index da0ac0565..807a1430d 100644 --- a/gcloud/ai/models/upload +++ b/gcloud/ai/models/upload @@ -19,7 +19,8 @@ SYNOPSIS [--smooth-grad-noise-sigma=SMOOTH_GRAD_NOISE_SIGMA] [--smooth-grad-noise-sigma-by-feature=[KEY=VALUE,...]] [--smooth-grad-noisy-sample-count=SMOOTH_GRAD_NOISY_SAMPLE_COUNT] - [--version-aliases=[VERSION_ALIASES,...]] [GCLOUD_WIDE_FLAG ...] + [--version-aliases=[VERSION_ALIASES,...]] + [--version-description=VERSION_DESCRIPTION] [GCLOUD_WIDE_FLAG ...] EXAMPLES To upload a model under project example in region us-central1, run: @@ -138,6 +139,9 @@ OPTIONAL FLAGS version ID. The aliases mentioned in the flag will replace the aliases set in the model. + --version-description=VERSION_DESCRIPTION + Description of the model version. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alloydb/backups/create b/gcloud/alloydb/backups/create new file mode 100644 index 000000000..330d861a7 --- /dev/null +++ b/gcloud/alloydb/backups/create @@ -0,0 +1,85 @@ +NAME + gcloud alloydb backups create - creates a new AlloyDB backup within a given + project + +SYNOPSIS + gcloud alloydb backups create BACKUP --cluster=CLUSTER --region=REGION + [--async] + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Creates a new AlloyDB backup within a given project. + +EXAMPLES + To create a new backup, run: + + $ gcloud alloydb backups create my-backup --cluster=my-cluster \ + --region=us-central1 + +POSITIONAL ARGUMENTS + BACKUP + AlloyDB backup ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + The region of the cluster to backup. Note: both the cluster and the + backup have to be in the same region. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the backup. The 'AlloyDB Service Agent' service account + must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The + arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + +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 alloydb backups create + + $ gcloud beta alloydb backups create + diff --git a/gcloud/alloydb/backups/delete b/gcloud/alloydb/backups/delete new file mode 100644 index 000000000..4a5c42340 --- /dev/null +++ b/gcloud/alloydb/backups/delete @@ -0,0 +1,45 @@ +NAME + gcloud alloydb backups delete - deletes an AlloyDB backup within a given + project + +SYNOPSIS + gcloud alloydb backups delete BACKUP --region=REGION [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Deletes an AlloyDB backup within a given project. + +EXAMPLES + To delete a backup, run: + + $ gcloud alloydb backups delete my-backup --region=us-central1 + +POSITIONAL ARGUMENTS + BACKUP + AlloyDB backup ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb backups delete + + $ gcloud beta alloydb backups delete + diff --git a/gcloud/alloydb/backups/describe b/gcloud/alloydb/backups/describe new file mode 100644 index 000000000..66ea425fd --- /dev/null +++ b/gcloud/alloydb/backups/describe @@ -0,0 +1,40 @@ +NAME + gcloud alloydb backups describe - describes an AlloyDB backup in a given + project and region + +SYNOPSIS + gcloud alloydb backups describe BACKUP --region=REGION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describes an AlloyDB backup in a given project and region. + +EXAMPLES + To describe a backup, run: + + $ gcloud alloydb backups describe my-backup --region=us-central1 + +POSITIONAL ARGUMENTS + BACKUP + AlloyDB backup ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +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 alloydb backups describe + + $ gcloud beta alloydb backups describe + diff --git a/gcloud/alloydb/backups/help b/gcloud/alloydb/backups/help new file mode 100644 index 000000000..a1ca52051 --- /dev/null +++ b/gcloud/alloydb/backups/help @@ -0,0 +1,37 @@ +NAME + gcloud alloydb backups - provide commands for managing AlloyDB backups + +SYNOPSIS + gcloud alloydb backups COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Provide commands for managing AlloyDB backups including creating, deleting, + and listing backups. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Creates a new AlloyDB backup within a given project. + + delete + Deletes an AlloyDB backup within a given project. + + describe + Describes an AlloyDB backup in a given project and region. + + list + Lists AlloyDB backups in a given project. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb backups + + $ gcloud beta alloydb backups + diff --git a/gcloud/alloydb/backups/list b/gcloud/alloydb/backups/list new file mode 100644 index 000000000..b7bf2e2ee --- /dev/null +++ b/gcloud/alloydb/backups/list @@ -0,0 +1,76 @@ +NAME + gcloud alloydb backups list - lists AlloyDB backups in a given project + +SYNOPSIS + gcloud alloydb backups list [--region=REGION; default="-"] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Lists AlloyDB backups in a given project in the alphabetical order of the + backup name. + +EXAMPLES + To list backups, run: + + $ gcloud alloydb backups list --region=us-central1 + + Use the --format flag to customize the fields that are outputted. For + example, to list backups with their names and sizes, run: + + $ gcloud alloydb backups list --region=us-central1 \ + --format="table(name, size_bytes)" + +FLAGS + --region=REGION; default="-" + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + Default: list clusters in all regions. + +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 alloydb backups list + + $ gcloud beta alloydb backups list + diff --git a/gcloud/alloydb/clusters/create b/gcloud/alloydb/clusters/create new file mode 100644 index 000000000..37d8fb3bd --- /dev/null +++ b/gcloud/alloydb/clusters/create @@ -0,0 +1,183 @@ +NAME + gcloud alloydb clusters create - create a new AlloyDB cluster within a + given project + +SYNOPSIS + gcloud alloydb clusters create CLUSTER --password=PASSWORD --region=REGION + [--async] [--network=NETWORK] + [--disable-automated-backup + | [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] + --automated-backup-start-times=[START_TIMES,...] + : --automated-backup-window=TIMEOUT_PERIOD + [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new AlloyDB cluster within a given project. + +EXAMPLES + To create a new cluster, run: + + $ gcloud alloydb clusters create my-cluster --region=us-central1 \ + --password=postgres + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --password=PASSWORD + Initial postgres user password to set up during cluster creation. + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --network=NETWORK + Network in the current project that the instance will be part of. To + specify using a network with a shared VPC, use the full URL of the + network. For an example host project, 'testproject', and shared + network, 'testsharednetwork', this would be of the + form:--network=projects/testproject/global/networks/testsharednetwork + + Automated backup policy. If unspecified, automated backups are enabled. + + At most one of these can be specified: + + --disable-automated-backup + Disables automated backups on the cluster. + + Enable automated backup policy. + + --automated-backup-days-of-week=[DAYS_OF_WEEK,...] + Comma-separated list of days of the week to perform a backup. At + least one day of the week must be provided. (e.g., + --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY). + DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, + FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-start-times=[START_TIMES,...] + Comma-separated list of times during the day to start a backup. At + least one start time must be provided. The start times are assumed + to be in UTC and required to be an exact hour in the format HH:00. + (e.g., --automated-backup-start-times=01:00,13:00) + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-window=TIMEOUT_PERIOD + The length of the time window beginning at start time during which + a backup can be taken. If a backup does not succeed within this + time window, it will be canceled and considered failed. The backup + window must be at least 5 minutes long. There is no upper bound on + the window. If not set, it will default to 1 hour. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the automated backups. The 'AlloyDB Service + Agent' service account must hold permission 'Cloud KMS CryptoKey + Encrypter/Decrypter'. The arguments in this group can be used to + specify the attributes of this resource. + + --automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. To set + the kms-key attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ◇ provide the argument + --automated-backup-encryption-key-keyring on the command line. + + --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION + The Cloud location for the key. To set the kms-location + attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ◇ provide the argument + --automated-backup-encryption-key-location on the command line. + + --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ◇ provide the argument + --automated-backup-encryption-key-project on the command line; + ◇ set the property core/project. + + Retention policy. If no retention policy is provided, all automated + backups will be retained. + + At most one of these can be specified: + + --automated-backup-retention-count=RETENTION_COUNT + Number of most recent successful backups retained. + + --automated-backup-retention-period=RETENTION_PERIOD + Retention period of the backup relative to creation time. See $ + gcloud topic datetimes for information on duration formats. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the cluster. The 'AlloyDB Service Agent' service + account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. + The arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + +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 alloydb clusters create + + $ gcloud beta alloydb clusters create + diff --git a/gcloud/alloydb/clusters/delete b/gcloud/alloydb/clusters/delete new file mode 100644 index 000000000..91913a1b7 --- /dev/null +++ b/gcloud/alloydb/clusters/delete @@ -0,0 +1,54 @@ +NAME + gcloud alloydb clusters delete - delete an AlloyDB cluster in a given + region + +SYNOPSIS + gcloud alloydb clusters delete CLUSTER --region=REGION [--async] [--force] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an AlloyDB cluster in a given region. + +EXAMPLES + To delete a cluster, run: + + $ gcloud alloydb clusters delete my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --force + Default value is false. + + If flag is specified, deletes instances (if any) within this cluster, + before deleting the cluster. + + If flag is not specified, cluster delete will fail if there are + instances present in the cluster. + +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 alloydb clusters delete + + $ gcloud beta alloydb clusters delete + diff --git a/gcloud/alloydb/clusters/describe b/gcloud/alloydb/clusters/describe new file mode 100644 index 000000000..d19a91716 --- /dev/null +++ b/gcloud/alloydb/clusters/describe @@ -0,0 +1,40 @@ +NAME + gcloud alloydb clusters describe - describe an AlloyDB cluster in a given + project and region + +SYNOPSIS + gcloud alloydb clusters describe CLUSTER --region=REGION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe an AlloyDB cluster in a given project and region. + +EXAMPLES + To describe a cluster, run: + + $ gcloud alloydb clusters describe my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +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 alloydb clusters describe + + $ gcloud beta alloydb clusters describe + diff --git a/gcloud/alloydb/clusters/help b/gcloud/alloydb/clusters/help new file mode 100644 index 000000000..a32c0e497 --- /dev/null +++ b/gcloud/alloydb/clusters/help @@ -0,0 +1,43 @@ +NAME + gcloud alloydb clusters - provide commands for managing AlloyDB clusters + +SYNOPSIS + gcloud alloydb clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Provide commands for managing AlloyDB clusters including creating, + configuring, restarting, and deleting clusters. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a new AlloyDB cluster within a given project. + + delete + Delete an AlloyDB cluster in a given region. + + describe + Describe an AlloyDB cluster in a given project and region. + + list + List AlloyDB clusters in a given project and region. + + restore + Restore an AlloyDB cluster from a given backup. + + update + Update an AlloyDB cluster within a given project and region. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb clusters + + $ gcloud beta alloydb clusters + diff --git a/gcloud/alloydb/clusters/list b/gcloud/alloydb/clusters/list new file mode 100644 index 000000000..91b7300e5 --- /dev/null +++ b/gcloud/alloydb/clusters/list @@ -0,0 +1,71 @@ +NAME + gcloud alloydb clusters list - list AlloyDB clusters in a given project and + region + +SYNOPSIS + gcloud alloydb clusters list [--region=REGION; default="-"] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List AlloyDB clusters in a given project in alphabetical order based on the + cluster name. + +EXAMPLES + To list clusters, run: + + $ gcloud alloydb clusters list --region=us-central1 + +FLAGS + --region=REGION; default="-" + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + Default: list clusters in all regions. + +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 alloydb clusters list + + $ gcloud beta alloydb clusters list + diff --git a/gcloud/alloydb/clusters/restore b/gcloud/alloydb/clusters/restore new file mode 100644 index 000000000..16c0917bc --- /dev/null +++ b/gcloud/alloydb/clusters/restore @@ -0,0 +1,92 @@ +NAME + gcloud alloydb clusters restore - restore an AlloyDB cluster from a given + backup + +SYNOPSIS + gcloud alloydb clusters restore CLUSTER --backup=BACKUP --region=REGION + [--async] [--network=NETWORK] + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Restore an AlloyDB cluster from a given backup. + +EXAMPLES + To restore a cluster from a backup, run: + + $ gcloud alloydb clusters restore my-cluster --region=us-central1 \ + --backup=my-backup + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --backup=BACKUP + AlloyDB backup ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --network=NETWORK + Network in the current project that the instance will be part of. To + specify using a network with a shared VPC, use the full URL of the + network. For an example host project, 'testproject', and shared + network, 'testsharednetwork', this would be of the + form:--network=projects/testproject/global/networks/testsharednetwork + + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the cluster. The 'AlloyDB Service Agent' service + account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. + The arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + +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 alloydb clusters restore + + $ gcloud beta alloydb clusters restore + diff --git a/gcloud/alloydb/clusters/update b/gcloud/alloydb/clusters/update new file mode 100644 index 000000000..5d18de9b9 --- /dev/null +++ b/gcloud/alloydb/clusters/update @@ -0,0 +1,143 @@ +NAME + gcloud alloydb clusters update - update an AlloyDB cluster within a given + project and region + +SYNOPSIS + gcloud alloydb clusters update CLUSTER --region=REGION [--async] + [--clear-automated-backup | --disable-automated-backup + | [--automated-backup-days-of-week=[DAYS_OF_WEEK,...] + --automated-backup-start-times=[START_TIMES,...] + : --automated-backup-window=TIMEOUT_PERIOD + [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an AlloyDB cluster within a given project and region. + +EXAMPLES + To update a cluster, run: + + $ gcloud alloydb clusters update my-cluster --region=us-central1 \ + --automated-backup-start-times=12:00 \ + --automated-backup-days-of-week=MONDAY \ + --automated-backup-retention-count=10 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Automated backup policy. + + At most one of these can be specified: + + --clear-automated-backup + Clears the automated backup policy on the cluster. The default + automated backup policy will be used. + + --disable-automated-backup + Disables automated backups on the cluster. + + Enable automated backup policy. + + --automated-backup-days-of-week=[DAYS_OF_WEEK,...] + Comma-separated list of days of the week to perform a backup. At + least one day of the week must be provided. (e.g., + --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY). + DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, + FRIDAY, SATURDAY, SUNDAY. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-start-times=[START_TIMES,...] + Comma-separated list of times during the day to start a backup. At + least one start time must be provided. The start times are assumed + to be in UTC and required to be an exact hour in the format HH:00. + (e.g., --automated-backup-start-times=01:00,13:00) + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --automated-backup-window=TIMEOUT_PERIOD + The length of the time window beginning at start time during which + a backup can be taken. If a backup does not succeed within this + time window, it will be canceled and considered failed. The backup + window must be at least 5 minutes long. There is no upper bound on + the window. If not set, it will default to 1 hour. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that + will be used to protect the automated backups. The 'AlloyDB Service + Agent' service account must hold permission 'Cloud KMS CryptoKey + Encrypter/Decrypter'. The arguments in this group can be used to + specify the attributes of this resource. + + --automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY + ID of the key or fully qualified identifier for the key. To set + the kms-key attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ◇ provide the argument + --automated-backup-encryption-key-keyring on the command line. + + --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION + The Cloud location for the key. To set the kms-location + attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ◇ provide the argument + --automated-backup-encryption-key-location on the command line. + + --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ◇ provide the argument --automated-backup-encryption-key on the + command line with a fully specified name; + ◇ provide the argument + --automated-backup-encryption-key-project on the command line; + ◇ set the property core/project. + + Retention policy. If no retention policy is provided, all automated + backups will be retained. + + At most one of these can be specified: + + --automated-backup-retention-count=RETENTION_COUNT + Number of most recent successful backups retained. + + --automated-backup-retention-period=RETENTION_PERIOD + Retention period of the backup relative to creation time. See $ + gcloud topic datetimes for information on duration formats. + +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 alloydb clusters update + + $ gcloud beta alloydb clusters update + diff --git a/gcloud/alloydb/help b/gcloud/alloydb/help new file mode 100644 index 000000000..1fdabe532 --- /dev/null +++ b/gcloud/alloydb/help @@ -0,0 +1,43 @@ +NAME + gcloud alloydb - create and manage AlloyDB databases + +SYNOPSIS + gcloud alloydb GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + The gcloud alloydb command group lets you create and manage Google Cloud + AlloyDB databases. + + AlloyDB is a fully-managed database service that makes it easy to set up, + maintain, manage, and administer your Alloydb databases in the cloud. + + More information on AlloyDB can be found at + https://cloud.google.com/alloydb + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + backups + Provide commands for managing AlloyDB backups. + + clusters + Provide commands for managing AlloyDB clusters. + + instances + Provide commands for managing AlloyDB instances. + + operations + Provide commands for managing AlloyDB operations. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb + + $ gcloud beta alloydb + diff --git a/gcloud/alloydb/instances/create b/gcloud/alloydb/instances/create new file mode 100644 index 000000000..c6cfee57e --- /dev/null +++ b/gcloud/alloydb/instances/create @@ -0,0 +1,96 @@ +NAME + gcloud alloydb instances create - creates a new AlloyDB instance within a + given cluster + +SYNOPSIS + gcloud alloydb instances create INSTANCE --cluster=CLUSTER + --cpu-count=CPU_COUNT --instance-type=INSTANCE_TYPE --region=REGION + [--async] [--availability-type=AVAILABILITY_TYPE] + [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]] + [--read-pool-node-count=READ_POOL_NODE_COUNT] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Creates a new AlloyDB instance within a given cluster. + +EXAMPLES + To create a new primary instance, run: + + $ gcloud alloydb instances create my-instance --cluster=my-cluster \ + --region=us-central1 --instance-type=PRIMARY --cpu-count=4 + + To create a new read pool instance, run: + + $ gcloud alloydb instances create my-instance --cluster=my-cluster \ + --region=us-central1 --instance-type=READ_POOL \ + --read-pool-node-count=1 --cpu-count=4 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --cpu-count=CPU_COUNT + Whole number value indicating how many vCPUs the machine should + contain. Each vCPU count corresponds to a N2 high-mem machine: + (https://cloud.google.com/compute/docs/general-purpose-machines#n2_machines). + CPU_COUNT must be one of: 2, 4, 8, 16, 32, 64. + + --instance-type=INSTANCE_TYPE + Specifies instance type. INSTANCE_TYPE must be one of: + + PRIMARY + PRIMARY instances support read and write operations. + READ_POOL + READ_POOL instances support read operations only. Each read pool + instance consists of one or more homogeneous nodes. * Read pool of + size 1 can only have zonal availability. * Read pools with node + count of 2 or more can have regional availability (nodes are + present in 2 or more zones in a region). + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --availability-type=AVAILABILITY_TYPE + Specifies level of availability. AVAILABILITY_TYPE must be (currently + only one value is supported): + + REGIONAL + Provides high availability and is recommended for production + instances; instance automatically fails over to another zone within + your selected region. + + --database-flags=FLAG=VALUE,[FLAG=VALUE,...] + Comma-separated list of database flags to set on the instance. Use an + equals sign to separate flag name and value. Flags without values, like + skip_grant_tables, can be written out without a value after, e.g., + skip_grant_tables=. Use on/off for booleans. View the Instance Resource + API for allowed flags. (e.g., --database-flags + max_allowed_packet=55555,skip_grant_tables=,log_output=1) + + --read-pool-node-count=READ_POOL_NODE_COUNT + Read capacity, i.e. number of nodes in a read pool instance. + +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 alloydb instances create + + $ gcloud beta alloydb instances create + diff --git a/gcloud/alloydb/instances/delete b/gcloud/alloydb/instances/delete new file mode 100644 index 000000000..6926a1d8c --- /dev/null +++ b/gcloud/alloydb/instances/delete @@ -0,0 +1,49 @@ +NAME + gcloud alloydb instances delete - deletes an AlloyDB instance within a + given cluster + +SYNOPSIS + gcloud alloydb instances delete INSTANCE --cluster=CLUSTER --region=REGION + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Deletes an AlloyDB instance within a given cluster. + +EXAMPLES + To delete an instance, run: + + $ gcloud alloydb instances delete my-instance --cluster=my-cluster \ + --region=us-central1 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb instances delete + + $ gcloud beta alloydb instances delete + diff --git a/gcloud/alloydb/instances/describe b/gcloud/alloydb/instances/describe new file mode 100644 index 000000000..1bef25af2 --- /dev/null +++ b/gcloud/alloydb/instances/describe @@ -0,0 +1,48 @@ +NAME + gcloud alloydb instances describe - describes an AlloyDB instance within a + given cluster + +SYNOPSIS + gcloud alloydb instances describe INSTANCE --cluster=CLUSTER + --region=REGION [--view=VIEW] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describes an AlloyDB instance within a given cluster. + +EXAMPLES + To describe an instance, run: + + $ gcloud alloydb instances describe my-instance \ + --cluster=my-cluster --region=us-central1 --view=BASIC/FULL + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --view=VIEW + View of the instance to return. VIEW must be one of: basic, full. + +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 alloydb instances describe + + $ gcloud beta alloydb instances describe + diff --git a/gcloud/alloydb/instances/failover b/gcloud/alloydb/instances/failover new file mode 100644 index 000000000..8353a44eb --- /dev/null +++ b/gcloud/alloydb/instances/failover @@ -0,0 +1,49 @@ +NAME + gcloud alloydb instances failover - failover an AlloyDB instance within a + given cluster + +SYNOPSIS + gcloud alloydb instances failover INSTANCE --cluster=CLUSTER + --region=REGION [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Failover an AlloyDB instance within a given cluster. + +EXAMPLES + To failover an instance, run: + + $ gcloud alloydb instances failover my-instance \ + --cluster=my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb instances failover + + $ gcloud beta alloydb instances failover + diff --git a/gcloud/alloydb/instances/help b/gcloud/alloydb/instances/help new file mode 100644 index 000000000..cedcd553c --- /dev/null +++ b/gcloud/alloydb/instances/help @@ -0,0 +1,46 @@ +NAME + gcloud alloydb instances - provide commands for managing AlloyDB instances + +SYNOPSIS + gcloud alloydb instances COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Provide commands for managing AlloyDB clusters including creating, + configuring, restarting, and deleting instances. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Creates a new AlloyDB instance within a given cluster. + + delete + Deletes an AlloyDB instance within a given cluster. + + describe + Describes an AlloyDB instance within a given cluster. + + failover + Failover an AlloyDB instance within a given cluster. + + list + Lists AlloyDB instances in a given cluster. + + restart + Restarts an AlloyDB instance within a given cluster. + + update + Updates an AlloyDB instance within a given cluster. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb instances + + $ gcloud beta alloydb instances + diff --git a/gcloud/alloydb/instances/list b/gcloud/alloydb/instances/list new file mode 100644 index 000000000..fb9077068 --- /dev/null +++ b/gcloud/alloydb/instances/list @@ -0,0 +1,82 @@ +NAME + gcloud alloydb instances list - lists AlloyDB instances in a given cluster + +SYNOPSIS + gcloud alloydb instances list [--cluster=CLUSTER --region=REGION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Lists AlloyDB instances in a given cluster. + +EXAMPLES + To list instances, run: + + $ gcloud alloydb instances list --cluster=my-cluster \ + --region=us-central1 + +FLAGS + Cluster + + --cluster=CLUSTER + AlloyDB cluster ID + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --region=REGION + Regional location (e.g. asia-east1, us-east1) of CLUSTER. See the + full list of regions at + https://cloud.google.com/sql/docs/instance-locations. Default: list + clusters in all regions. + + This flag argument must be specified if any of the other arguments in + this group are specified. + +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 alloydb instances list + + $ gcloud beta alloydb instances list + diff --git a/gcloud/alloydb/instances/restart b/gcloud/alloydb/instances/restart new file mode 100644 index 000000000..01557ccdd --- /dev/null +++ b/gcloud/alloydb/instances/restart @@ -0,0 +1,49 @@ +NAME + gcloud alloydb instances restart - restarts an AlloyDB instance within a + given cluster + +SYNOPSIS + gcloud alloydb instances restart INSTANCE --cluster=CLUSTER --region=REGION + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Restarts an AlloyDB instance within a given cluster. + +EXAMPLES + To describe an instance, run: + + $ gcloud alloydb instances restart my-instance \ + --cluster=my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb instances restart + + $ gcloud beta alloydb instances restart + diff --git a/gcloud/alloydb/instances/update b/gcloud/alloydb/instances/update new file mode 100644 index 000000000..16e1e92c0 --- /dev/null +++ b/gcloud/alloydb/instances/update @@ -0,0 +1,78 @@ +NAME + gcloud alloydb instances update - updates an AlloyDB instance within a + given cluster + +SYNOPSIS + gcloud alloydb instances update INSTANCE --cluster=CLUSTER --region=REGION + [--async] [--availability-type=AVAILABILITY_TYPE] + [--cpu-count=CPU_COUNT] [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]] + [--read-pool-node-count=READ_POOL_NODE_COUNT] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Updates an AlloyDB instance within a given cluster. + +EXAMPLES + To update the number of nodes in the read pool, run: + + $ gcloud alloydb instances update my-read-instance \ + --cluster=my-cluster --region=us-central1 \ + --read-pool-node-count=3 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --availability-type=AVAILABILITY_TYPE + Specifies level of availability. AVAILABILITY_TYPE must be (currently + only one value is supported): + + REGIONAL + Provides high availability and is recommended for production + instances; instance automatically fails over to another zone within + your selected region. + + --cpu-count=CPU_COUNT + Whole number value indicating how many vCPUs the machine should + contain. Each vCPU count corresponds to a N2 high-mem machine: + (https://cloud.google.com/compute/docs/general-purpose-machines#n2_machines). + CPU_COUNT must be one of: 2, 4, 8, 16, 32, 64. + + --database-flags=FLAG=VALUE,[FLAG=VALUE,...] + Comma-separated list of database flags to set on the instance. Use an + equals sign to separate flag name and value. Flags without values, like + skip_grant_tables, can be written out without a value after, e.g., + skip_grant_tables=. Use on/off for booleans. View the Instance Resource + API for allowed flags. (e.g., --database-flags + max_allowed_packet=55555,skip_grant_tables=,log_output=1) + + --read-pool-node-count=READ_POOL_NODE_COUNT + Read capacity, i.e. number of nodes in a read pool instance. + +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 alloydb instances update + + $ gcloud beta alloydb instances update + diff --git a/gcloud/alloydb/operations/cancel b/gcloud/alloydb/operations/cancel new file mode 100644 index 000000000..b2043213a --- /dev/null +++ b/gcloud/alloydb/operations/cancel @@ -0,0 +1,40 @@ +NAME + gcloud alloydb operations cancel - cancels an AlloyDB operation + +SYNOPSIS + gcloud alloydb operations cancel OPERATION --region=REGION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Cancels an AlloyDB operation. + +EXAMPLES + To cancel an operation, run: + + $ gcloud alloydb operations cancel operation-123456789 \ + --region=us-central1 + +POSITIONAL ARGUMENTS + OPERATION + AlloyDB operation ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +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 alloydb operations cancel + + $ gcloud beta alloydb operations cancel + diff --git a/gcloud/alloydb/operations/delete b/gcloud/alloydb/operations/delete new file mode 100644 index 000000000..d53ed4def --- /dev/null +++ b/gcloud/alloydb/operations/delete @@ -0,0 +1,40 @@ +NAME + gcloud alloydb operations delete - deletes an AlloyDB operation + +SYNOPSIS + gcloud alloydb operations delete OPERATION --region=REGION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Deletes an AlloyDB operation. + +EXAMPLES + To delete an operation, run: + + $ gcloud alloydb operations delete operation-123456789 \ + --region=us-central1 + +POSITIONAL ARGUMENTS + OPERATION + AlloyDB operation ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +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 alloydb operations delete + + $ gcloud beta alloydb operations delete + diff --git a/gcloud/alloydb/operations/describe b/gcloud/alloydb/operations/describe new file mode 100644 index 000000000..960e89ced --- /dev/null +++ b/gcloud/alloydb/operations/describe @@ -0,0 +1,40 @@ +NAME + gcloud alloydb operations describe - describes an AlloyDB operation + +SYNOPSIS + gcloud alloydb operations describe OPERATION --region=REGION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describes an AlloyDB operation. + +EXAMPLES + To describe an operation, run: + + $ gcloud alloydb operations describe operation-123456789 \ + --region=us-central1 + +POSITIONAL ARGUMENTS + OPERATION + AlloyDB operation ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +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 alloydb operations describe + + $ gcloud beta alloydb operations describe + diff --git a/gcloud/alloydb/operations/help b/gcloud/alloydb/operations/help new file mode 100644 index 000000000..f6a59229e --- /dev/null +++ b/gcloud/alloydb/operations/help @@ -0,0 +1,38 @@ +NAME + gcloud alloydb operations - provide commands for managing AlloyDB + operations + +SYNOPSIS + gcloud alloydb operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Provide commands for managing AlloyDB operations including cancelling, + deleting, describing, and listing. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + cancel + Cancels an AlloyDB operation. + + delete + Deletes an AlloyDB operation. + + describe + Describes an AlloyDB operation. + + list + Lists AlloyDB operations. + +NOTES + These variants are also available: + + $ gcloud alpha alloydb operations + + $ gcloud beta alloydb operations + diff --git a/gcloud/alloydb/operations/list b/gcloud/alloydb/operations/list new file mode 100644 index 000000000..1d1d5d03a --- /dev/null +++ b/gcloud/alloydb/operations/list @@ -0,0 +1,73 @@ +NAME + gcloud alloydb operations list - lists AlloyDB operations + +SYNOPSIS + gcloud alloydb operations list [--cluster=CLUSTER] + [--region=REGION; default="-"] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Lists AlloyDB operations. + +EXAMPLES + To list operations, run: + + $ gcloud alloydb operations list --region=us-central1 + +FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION; default="-" + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + Default: list operations in all regions. + +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 alloydb operations list + + $ gcloud beta alloydb operations list + diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/create b/gcloud/alpha/access-context-manager/authorized-orgs/create new file mode 100644 index 000000000..6cf98e638 --- /dev/null +++ b/gcloud/alpha/access-context-manager/authorized-orgs/create @@ -0,0 +1,97 @@ +NAME + gcloud alpha access-context-manager authorized-orgs create - create a new + authorized organizations description + +SYNOPSIS + gcloud alpha access-context-manager authorized-orgs create + (AUTHORIZED_ORGS_DESC : --policy=POLICY) --asset_type=ASSET_TYPE + --authorization_direction=AUTHORIZATION_DIRECTION + --authorization_type=AUTHORIZATION_TYPE [--async] [--orgs=[ORGS,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new authorized organizations description in a given access + policy. + +EXAMPLES + To create a new authorized organizations description: + + $ gcloud alpha access-context-manager authorized-orgs create \ + --orgs=organizations/12345 --policy=9876543 + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized organizations description + to create. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized-orgs-desc or fully qualified identifier for the + authorized-orgs-desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. + + To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +REQUIRED FLAGS + --asset_type=ASSET_TYPE + The asset type of this authorized organizations description. For + example, device, or credential strength. ASSET_TYPE must be one of: + asset-type-credential-strength, asset-type-device, + asset-type-unspecified. + + --authorization_direction=AUTHORIZATION_DIRECTION + Authorization direction of this authorization relationship. Specifies + whether to allow specified organizations to evaluate this + organization's traffic, or allow specified organizations traffic to be + evaluated by this org. AUTHORIZATION_DIRECTION must be one of: + authorization-direction-from, authorization-direction-to, + authorization-direction-unspecified. + + --authorization_type=AUTHORIZATION_TYPE + The authorization type of the authorized organizations description. For + example, trust, troubleshooting or logging. AUTHORIZATION_TYPE must be + one of: authorization-type-trust, authorization-type-unspecified. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --orgs=[ORGS,...] + Comma-separated list of organizations (in the following format: + organizations/). + +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 accesscontextmanager/v1alpha API. The full + documentation for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +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 access-context-manager authorized-orgs create + diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/delete b/gcloud/alpha/access-context-manager/authorized-orgs/delete new file mode 100644 index 000000000..c37e5afd8 --- /dev/null +++ b/gcloud/alpha/access-context-manager/authorized-orgs/delete @@ -0,0 +1,71 @@ +NAME + gcloud alpha access-context-manager authorized-orgs delete - delete an + authorized organizations description + +SYNOPSIS + gcloud alpha access-context-manager authorized-orgs delete + (AUTHORIZED_ORGS_DESC : --policy=POLICY) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an authorized organizations description in a given access + policy. + +EXAMPLES + To delete an existing authorized organizations description, run: + + $ gcloud alpha access-context-manager authorized-orgs delete \ + my_authorized_orgs_desc_id + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized organizations description + you want to delete. The arguments in this group can be used to specify the + attributes of this resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized-orgs-desc or fully qualified identifier for the + authorized-orgs-desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. + + To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +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 accesscontextmanager/v1alpha API. The full + documentation for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +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 access-context-manager authorized-orgs delete + diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/describe b/gcloud/alpha/access-context-manager/authorized-orgs/describe new file mode 100644 index 000000000..4cdec1f6c --- /dev/null +++ b/gcloud/alpha/access-context-manager/authorized-orgs/describe @@ -0,0 +1,65 @@ +NAME + gcloud alpha access-context-manager authorized-orgs describe - show details + about an authorized organizations description + +SYNOPSIS + gcloud alpha access-context-manager authorized-orgs describe + (AUTHORIZED_ORGS_DESC : --policy=POLICY) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details about an existing authorized organizations + description. + +EXAMPLES + To get details about an existing authorized organizations description, run: + + $ gcloud alpha access-context-manager authorized-orgs describe \ + my_authorized_orgs_desc_id + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized organizations description + for which you want to show details. The arguments in this group can be + used to specify the attributes of this resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized-orgs-desc or fully qualified identifier for the + authorized-orgs-desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. + + To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +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 accesscontextmanager/v1alpha API. The full + documentation for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +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 access-context-manager authorized-orgs describe + diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/help b/gcloud/alpha/access-context-manager/authorized-orgs/help new file mode 100644 index 000000000..5f7545aa7 --- /dev/null +++ b/gcloud/alpha/access-context-manager/authorized-orgs/help @@ -0,0 +1,48 @@ +NAME + gcloud alpha access-context-manager authorized-orgs - manage Access Context + Manager authorized organizations descriptions + +SYNOPSIS + gcloud alpha access-context-manager authorized-orgs COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) An authorized organizations description describes a list of + organizations (1) that have been authorized to use certain asset (for + example, device) data owned by different organizations at the enforcement + points, or (2) with certain asset (for example, device) have been + authorized to access the resources in another organization at the + enforcement points. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a new authorized organizations description. + + delete + (ALPHA) Delete an authorized organizations description. + + describe + (ALPHA) Show details about an authorized organizations description. + + list + (ALPHA) List authorized organizations descriptions. + + update + (ALPHA) Update the organizations for an existing authorized + organizations description. + +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 access-context-manager authorized-orgs + diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/list b/gcloud/alpha/access-context-manager/authorized-orgs/list new file mode 100644 index 000000000..f74c50994 --- /dev/null +++ b/gcloud/alpha/access-context-manager/authorized-orgs/list @@ -0,0 +1,83 @@ +NAME + gcloud alpha access-context-manager authorized-orgs list - list authorized + organizations descriptions + +SYNOPSIS + gcloud alpha access-context-manager authorized-orgs list [--policy=POLICY] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all service access zones in an access policy object. + +EXAMPLES + To list authorized organizations description in an access policy, run: + + $ gcloud alpha access-context-manager authorized-orgs list + + This will print out a list of authorized organizations descriptions in a + tabular form: + + NAME + my_authorized_orgs_desc + +FLAGS + Policy resource - The access policy for which you want to list the + corresponding authorized organizations descriptions. This represents a + Cloud resource. + + --policy=POLICY + ID of the policy or fully qualified identifier for the policy. To set + the policy attribute: + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy; + ▸ automatically, if the current account belongs to an organization + with exactly one access policy.. + +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 accesscontextmanager/v1alpha API. The full + documentation for this API can be found at: + https://cloud.google.com/access-context-manager/docs/reference/rest/ + +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 access-context-manager authorized-orgs list + diff --git a/gcloud/alpha/access-context-manager/authorized-orgs/update b/gcloud/alpha/access-context-manager/authorized-orgs/update new file mode 100644 index 000000000..3003af0e1 --- /dev/null +++ b/gcloud/alpha/access-context-manager/authorized-orgs/update @@ -0,0 +1,76 @@ +NAME + gcloud alpha access-context-manager authorized-orgs update - update the + organizations for an existing authorized organizations description + +SYNOPSIS + gcloud alpha access-context-manager authorized-orgs update + (AUTHORIZED_ORGS_DESC : --policy=POLICY) + [--add-orgs=[ORGS,...] | --clear-orgs | --remove-orgs=[ORGS,...] + | --set-orgs=[ORGS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) This command updates an authorized organizations description. + +EXAMPLES + To update the organizations for an authorized organizations description: + + $ gcloud alpha access-context-manager authorized-orgs update \ + my-authorized-orgs \ + --add-orgs="organizations/123,organizations/456" + +POSITIONAL ARGUMENTS + Authorized orgs desc resource - The authorized orgs desc to update. The + arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + AUTHORIZED_ORGS_DESC + ID of the authorized_orgs_desc or fully qualified identifier for the + authorized_orgs_desc. To set the authorized_orgs_desc attribute: + ▸ provide the argument authorized_orgs_desc on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --policy=POLICY + The ID of the access policy. To set the policy attribute: + ▸ provide the argument authorized_orgs_desc on the command line + with a fully specified name; + ▸ provide the argument --policy on the command line; + ▸ set the property access_context_manager/policy. + +FLAGS + These flags modify the member orgs of this authorized_orgs_desc. Orgs must + be organizations, in the form organizations/. + + At most one of these can be specified: + + --add-orgs=[ORGS,...] + Append the given values to the current orgs. + + --clear-orgs + Empty the current orgs. + + --remove-orgs=[ORGS,...] + Remove the given values from the current orgs. + + --set-orgs=[ORGS,...] + Completely replace the current orgs with the given values. + +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 access-context-manager authorized-orgs update + diff --git a/gcloud/alpha/access-context-manager/cloud-bindings/create b/gcloud/alpha/access-context-manager/cloud-bindings/create index d2942b1ae..3c27158e9 100644 --- a/gcloud/alpha/access-context-manager/cloud-bindings/create +++ b/gcloud/alpha/access-context-manager/cloud-bindings/create @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha access-context-manager cloud-bindings create - --group-key=GROUP_KEY --level=[LEVEL,...] [--organization=ORGANIZATION] + --group-key=GROUP_KEY [--dry-run-level=[DRY_RUN_LEVEL,...]] + [--level=[LEVEL,...]] [--organization=ORGANIZATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -13,23 +14,31 @@ DESCRIPTION group tries to access the Google cloud console or API. EXAMPLES - To create a new cloud access binding, run: + To create a new cloud access binding including the dry run access level, + run: $ gcloud alpha access-context-manager cloud-bindings create \ --group-key=my-group-key \ - --level=accessPolicies/123/accessLevels/abc + --level=accessPolicies/123/accessLevels/abc \ + --dry-run-level=accessPolicies/123/accessLevels/def REQUIRED FLAGS --group-key=GROUP_KEY Google Group id whose members are subject to the restrictions of this binding. +OPTIONAL FLAGS + --dry-run-level=[DRY_RUN_LEVEL,...] + The dry run access level that will bind to the given group. The dry run + access level will be evaluated but won't be enforced. Denial on dry run + access level will be logged. The input must be the full identifier for + access level, such as accessPolicies/123/accessLevels/new-def. + --level=[LEVEL,...] The access level that will bind to the given group. The input must be the full identifier for the access level, such as accessPolicies/123/accessLevels/abc. -OPTIONAL FLAGS --organization=ORGANIZATION Parent organization for this binding. diff --git a/gcloud/alpha/access-context-manager/cloud-bindings/list b/gcloud/alpha/access-context-manager/cloud-bindings/list index ff472d6bb..13234fe0d 100644 --- a/gcloud/alpha/access-context-manager/cloud-bindings/list +++ b/gcloud/alpha/access-context-manager/cloud-bindings/list @@ -17,8 +17,8 @@ EXAMPLES This will print out a list of gcpUserAccessBindings in a tabular form: - NAME GROUP_KEY ACCESS_LEVEL - organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N a3dad accessPolicies/9522/accessLevels/device_trusted + NAME GROUP_KEY ACCESS_LEVEL DRY_RUN_ACCESS_LEVEL + organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N a3dad accessPolicies/9522/accessLevels/device_trusted accessPolicies/9522/accessLevels/specific_location FLAGS Organization resource - The parent organization of the bindings you want diff --git a/gcloud/alpha/access-context-manager/cloud-bindings/update b/gcloud/alpha/access-context-manager/cloud-bindings/update index 0c0f3ff0b..2560d72c6 100644 --- a/gcloud/alpha/access-context-manager/cloud-bindings/update +++ b/gcloud/alpha/access-context-manager/cloud-bindings/update @@ -4,26 +4,29 @@ NAME SYNOPSIS gcloud alpha access-context-manager cloud-bindings update - --level=[LEVEL,...] (--binding=BINDING : --organization=ORGANIZATION) + (--binding=BINDING : --organization=ORGANIZATION) + [--dry-run-level=[DRY_RUN_LEVEL,...]] [--level=[LEVEL,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Update a existing cloud access binding. You can only update the - level. + (ALPHA) Update an existing cloud access binding. You can only update the + level and dry run level. For level and dry run level, you can update one of + these two or both. They can't be both empty after update. EXAMPLES - To update a existing cloud access binding, run: + To update an existing cloud access binding, run: $ gcloud alpha access-context-manager cloud-bindings update \ --binding=my-binding-id \ --level=accessPolicies/123/accessLevels/new-abc -REQUIRED FLAGS - --level=[LEVEL,...] - The access level that will replace the existing level for the given - binding. The input must be the full identifier for the access level, - such as accessPolicies/123/accessLevels/new-abc. + To update level to empty and add dry run level, run: + $ gcloud alpha access-context-manager cloud-bindings update \ + --binding=my-binding-id --level= \ + --dry-run-level=accessPolicies/123/accessLevels/new-def + +REQUIRED FLAGS Cloud access binding resource - The cloud access binding you want to update. The arguments in this group can be used to specify the attributes of this resource. @@ -47,6 +50,17 @@ REQUIRED FLAGS ▸ provide the argument --organization on the command line; ▸ set the property access_context_manager/organization. +OPTIONAL FLAGS + --dry-run-level=[DRY_RUN_LEVEL,...] + The dry run access level that will replace the dry run existing level + for the given binding. The input must be the full identifier for access + level, such as accessPolicies/123/accessLevels/new-def. + + --level=[LEVEL,...] + The access level that will replace the existing level for the given + binding. The input must be the full identifier for the access level, + such as accessPolicies/123/accessLevels/new-abc. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/access-context-manager/help b/gcloud/alpha/access-context-manager/help index 6c050e408..2233b45e0 100644 --- a/gcloud/alpha/access-context-manager/help +++ b/gcloud/alpha/access-context-manager/help @@ -17,6 +17,10 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + authorized-orgs + (ALPHA) Manage Access Context Manager authorized organizations + descriptions. + cloud-bindings (ALPHA) Manage Access Context Manager cloud access bindings. diff --git a/gcloud/alpha/access-context-manager/levels/config/export b/gcloud/alpha/access-context-manager/levels/config/export index 6bdc5682f..58ac146d5 100644 --- a/gcloud/alpha/access-context-manager/levels/config/export +++ b/gcloud/alpha/access-context-manager/levels/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/access-context-manager/perimeters/config/export b/gcloud/alpha/access-context-manager/perimeters/config/export index c30e4320e..add310831 100644 --- a/gcloud/alpha/access-context-manager/perimeters/config/export +++ b/gcloud/alpha/access-context-manager/perimeters/config/export @@ -81,7 +81,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/access-context-manager/policies/config/export b/gcloud/alpha/access-context-manager/policies/config/export index 19130ff77..aa92b10e7 100644 --- a/gcloud/alpha/access-context-manager/policies/config/export +++ b/gcloud/alpha/access-context-manager/policies/config/export @@ -65,7 +65,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/ai/custom-jobs/create b/gcloud/alpha/ai/custom-jobs/create index dea517bfb..316b16031 100644 --- a/gcloud/alpha/ai/custom-jobs/create +++ b/gcloud/alpha/ai/custom-jobs/create @@ -85,6 +85,9 @@ REQUIRED FLAGS field in WorkerPoolSpec API message. executor-image-uri The URI of a container image that will run the provided package. + output-image-uri + The URI of a custom container image to be built for autopackaged + custom jobs. python-module The Python module name to run within the provided package. local-package-path @@ -136,7 +139,15 @@ REQUIRED FLAGS Example: --worker-pool-spec=machine-type=e2-standard-4,executor-image-uri=us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-4:latest,python-module=trainer.task - local-package-path, executor-image-uri, python-module|script + output-image-uri + Specify this field to push the output custom container training + image to a specific path in Container Registry or Artifact + Registry for an autopackaged custom job. + + Example: + --worker-pool-spec=machine-type=e2-standard-4,executor-image-uri=us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-4:latest,output-image-uri='eu.gcr.io/projectName/imageName',python-module=trainer.task + + local-package-path, executor-image-uri, output-image-uri, python-module|script Specify these fields, optionally with requirements, extra-packages, or extra-dirs, to train using a pre-built container and Python code from a local path. In this case, the diff --git a/gcloud/alpha/ai/models/copy b/gcloud/alpha/ai/models/copy new file mode 100644 index 000000000..0a2807893 --- /dev/null +++ b/gcloud/alpha/ai/models/copy @@ -0,0 +1,79 @@ +NAME + gcloud alpha ai models copy - copy a model + +SYNOPSIS + gcloud alpha ai models copy --source-model=SOURCE_MODEL + [--kms-key-name=KMS_KEY_NAME] [--region=REGION] + [--destination-model-id=DESTINATION_MODEL_ID + | --destination-parent-model=DESTINATION_PARENT_MODEL] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To copy a model 123 of project example from region us-central1 to region + europe-west4, run: + + $ gcloud alpha ai models copy \ + --source-model=projects/example/locations/us-central1/models/\ + 123 --region=projects/example/locations/europe-west4 + +REQUIRED FLAGS + --source-model=SOURCE_MODEL + The resource name of the Model to copy. That Model must be in the same + Project. Format: + projects/{project}/locations/{location}/models/{model}. + +OPTIONAL FLAGS + --kms-key-name=KMS_KEY_NAME + The Cloud KMS resource identifier of the customer managed encryption + key used to protect the resource. Has the form: + projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. + The key needs to be in the same region as where the compute resource is + created. + + Region resource - Cloud region to copy the model into. 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 ai/region with a fully specified name; + ◆ choose one from the prompted list of available regions with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --region=REGION + ID of the region or fully qualified identifier for the region. To set + the region attribute: + ▸ provide the argument --region on the command line; + ▸ set the property ai/region; + ▸ choose one from the prompted list of available regions. + + At most one of these can be specified: + + --destination-model-id=DESTINATION_MODEL_ID + Copy source_model into a new Model with this ID. The ID will become + the final component of the model resource name. This value may be up + to 63 characters, and valid characters are [a-z0-9-]. The first + character cannot be a number or hyphen. + + --destination-parent-model=DESTINATION_PARENT_MODEL + Specify this field to copy source_model into this existing Model as a + new version. Format: + projects/{project}/locations/{location}/models/{model}. + +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 ai models copy + diff --git a/gcloud/alpha/ai/models/help b/gcloud/alpha/ai/models/help index d0034cd5f..ded85cc66 100644 --- a/gcloud/alpha/ai/models/help +++ b/gcloud/alpha/ai/models/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + copy + (ALPHA) Copy a model. + delete (ALPHA) Delete an existing Vertex AI model. diff --git a/gcloud/alpha/ai/models/upload b/gcloud/alpha/ai/models/upload index eee10bd1b..eb73178d5 100644 --- a/gcloud/alpha/ai/models/upload +++ b/gcloud/alpha/ai/models/upload @@ -12,14 +12,20 @@ SYNOPSIS [--description=DESCRIPTION] [--explanation-metadata-file=EXPLANATION_METADATA_FILE] [--explanation-method=EXPLANATION_METHOD] + [--explanation-modality=EXPLANATION_MODALITY; + default="MODALITY_UNSPECIFIED"] + [--explanation-nearest-neighbor-search-config-file=EXPLANATION_NEAREST_NEIGHBOR_SEARCH_CONFIG_FILE] + [--explanation-neighbor-count=EXPLANATION_NEIGHBOR_COUNT] [--explanation-path-count=EXPLANATION_PATH_COUNT] + [--explanation-query=EXPLANATION_QUERY; default="PRECISE"] [--explanation-step-count=EXPLANATION_STEP_COUNT] [--labels=[KEY=VALUE,...]] [--model-id=MODEL_ID] [--parent-model=PARENT_MODEL] [--region=REGION] [--smooth-grad-noise-sigma=SMOOTH_GRAD_NOISE_SIGMA] [--smooth-grad-noise-sigma-by-feature=[KEY=VALUE,...]] [--smooth-grad-noisy-sample-count=SMOOTH_GRAD_NOISY_SAMPLE_COUNT] - [--version-aliases=[VERSION_ALIASES,...]] [GCLOUD_WIDE_FLAG ...] + [--uris=[URIS,...]] [--version-aliases=[VERSION_ALIASES,...]] + [--version-description=VERSION_DESCRIPTION] [GCLOUD_WIDE_FLAG ...] EXAMPLES To upload a model under project example in region us-central1, run: @@ -76,10 +82,51 @@ OPTIONAL FLAGS Method used for explanation. Accepted values are integrated-gradients, xrai and sampled-shapley. + --explanation-modality=EXPLANATION_MODALITY; default="MODALITY_UNSPECIFIED" + Preset option specifying the modality of the uploaded model, which + automatically configures the distance measurement and feature + normalization for the underlying example index and queries. Accepted + values are IMAGE, TEXT and TABULAR. Should be used only when the + explanation method is examples. + + --explanation-nearest-neighbor-search-config-file=EXPLANATION_NEAREST_NEIGHBOR_SEARCH_CONFIG_FILE + Path to a local JSON file that contains the configuration for the + generated index, the semantics are the same as metadata and should + match NearestNeighborSearchConfig. If you specify this parameter, no + need to use explanation-modality and explanation-query for preset. + Should be used only when the explanation method is examples. + + An example of a JSON config file: + + { + "contentsDeltaUri": "", + "config": { + "dimensions": 50, + "approximateNeighborsCount": 10, + "distanceMeasureType": "SQUARED_L2_DISTANCE", + "featureNormType": "NONE", + "algorithmConfig": { + "treeAhConfig": { + "leafNodeEmbeddingCount": 1000, + "leafNodesToSearchPercent": 100 + } + } + } + } + + --explanation-neighbor-count=EXPLANATION_NEIGHBOR_COUNT + The number of items to return when querying for examples. Should be + used only when the explanation method is examples. + --explanation-path-count=EXPLANATION_PATH_COUNT Number of feature permutations to consider when approximating the Shapley values for explanation. + --explanation-query=EXPLANATION_QUERY; default="PRECISE" + Preset option controlling parameters for query speed-precision + trade-off. Accepted values are PRECISE and FAST. Should be used only + when the explanation method is examples. + --explanation-step-count=EXPLANATION_STEP_COUNT Number of steps to approximate the path integral for explanation. @@ -133,11 +180,18 @@ OPTIONAL FLAGS Number of gradient samples used for approximation at explanation. Only applicable to explanation method integrated-gradients or xrai. + --uris=[URIS,...] + Cloud Storage bucket paths where training data is stored. Should be + used only when the explanation method is examples. + --version-aliases=[VERSION_ALIASES,...] Aliases used to reference a model version instead of auto-generated version ID. The aliases mentioned in the flag will replace the aliases set in the model. + --version-description=VERSION_DESCRIPTION + Description of the model version. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/alloydb/backups/create b/gcloud/alpha/alloydb/backups/create index 9b7ffa447..9a2a1a8bf 100644 --- a/gcloud/alpha/alloydb/backups/create +++ b/gcloud/alpha/alloydb/backups/create @@ -80,7 +80,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb backups create $ gcloud beta alloydb backups create diff --git a/gcloud/alpha/alloydb/backups/delete b/gcloud/alpha/alloydb/backups/delete index 99eea5bac..7250b18d8 100644 --- a/gcloud/alpha/alloydb/backups/delete +++ b/gcloud/alpha/alloydb/backups/delete @@ -40,7 +40,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb backups delete $ gcloud beta alloydb backups delete diff --git a/gcloud/alpha/alloydb/backups/describe b/gcloud/alpha/alloydb/backups/describe index 306079582..cfdfa1617 100644 --- a/gcloud/alpha/alloydb/backups/describe +++ b/gcloud/alpha/alloydb/backups/describe @@ -36,7 +36,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb backups describe $ gcloud beta alloydb backups describe diff --git a/gcloud/alpha/alloydb/backups/help b/gcloud/alpha/alloydb/backups/help index fc3e992b2..4d06f5e2f 100644 --- a/gcloud/alpha/alloydb/backups/help +++ b/gcloud/alpha/alloydb/backups/help @@ -33,7 +33,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb backups $ gcloud beta alloydb backups diff --git a/gcloud/alpha/alloydb/backups/list b/gcloud/alpha/alloydb/backups/list index 0350493a3..742e63ee4 100644 --- a/gcloud/alpha/alloydb/backups/list +++ b/gcloud/alpha/alloydb/backups/list @@ -72,7 +72,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb backups list $ gcloud beta alloydb backups list diff --git a/gcloud/alpha/alloydb/clusters/create b/gcloud/alpha/alloydb/clusters/create index 10ddfca2e..037aa1f1d 100644 --- a/gcloud/alpha/alloydb/clusters/create +++ b/gcloud/alpha/alloydb/clusters/create @@ -1,5 +1,5 @@ NAME - gcloud alpha alloydb clusters create - creates a new AlloyDB cluster within + gcloud alpha alloydb clusters create - create a new AlloyDB cluster within a given project SYNOPSIS @@ -11,13 +11,12 @@ SYNOPSIS : --automated-backup-window=TIMEOUT_PERIOD [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] - [--disable-pitr | --pitr-log-retention-window=RETENTION_PERIOD] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Creates a new AlloyDB cluster within a given project. + (ALPHA) Create a new AlloyDB cluster within a given project. EXAMPLES To create a new cluster, run: @@ -134,17 +133,6 @@ OPTIONAL FLAGS Retention period of the backup relative to creation time. See $ gcloud topic datetimes for information on duration formats. - PITR configuration. - - At most one of these can be specified: - - --disable-pitr - Disables PITR on the cluster. - - --pitr-log-retention-window=RETENTION_PERIOD - Retention window of the log files saved to support PITR. See $ gcloud - topic datetimes for information on absolute duration formats. - Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the cluster. The 'AlloyDB Service Agent' service account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. @@ -190,7 +178,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters create $ gcloud beta alloydb clusters create diff --git a/gcloud/alpha/alloydb/clusters/create-secondary b/gcloud/alpha/alloydb/clusters/create-secondary new file mode 100644 index 000000000..f890a56fa --- /dev/null +++ b/gcloud/alpha/alloydb/clusters/create-secondary @@ -0,0 +1,88 @@ +NAME + gcloud alpha alloydb clusters create-secondary - create a new AlloyDB + SECONDARY cluster within a given project + +SYNOPSIS + gcloud alpha alloydb clusters create-secondary CLUSTER + --primary-cluster=PRIMARY_CLUSTER --region=REGION [--async] + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new AlloyDB SECONDARY cluster within a given project. + +EXAMPLES + To create a new cluster, run: + + $ gcloud alpha alloydb clusters create-secondary my-cluster \ + --region=us-central1 \ + --primary-cluster=projects/12345/locations/us-central1/\ + clusters/cluster1 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --primary-cluster=PRIMARY_CLUSTER + AlloyDB primary cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the cluster. The 'AlloyDB Service Agent' service + account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. + The arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + +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 alloydb clusters create-secondary + diff --git a/gcloud/alpha/alloydb/clusters/delete b/gcloud/alpha/alloydb/clusters/delete index 027e6179f..b4b4e3381 100644 --- a/gcloud/alpha/alloydb/clusters/delete +++ b/gcloud/alpha/alloydb/clusters/delete @@ -1,13 +1,13 @@ NAME - gcloud alpha alloydb clusters delete - deletes an AlloyDB cluster in a - given region + gcloud alpha alloydb clusters delete - delete an AlloyDB cluster in a given + region SYNOPSIS gcloud alpha alloydb clusters delete CLUSTER --region=REGION [--async] [--force] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Deletes an AlloyDB cluster in a given region. + (ALPHA) Delete an AlloyDB cluster in a given region. EXAMPLES To delete a cluster, run: @@ -50,7 +50,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters delete $ gcloud beta alloydb clusters delete diff --git a/gcloud/alpha/alloydb/clusters/describe b/gcloud/alpha/alloydb/clusters/describe index e4d968cad..2d3ebc772 100644 --- a/gcloud/alpha/alloydb/clusters/describe +++ b/gcloud/alpha/alloydb/clusters/describe @@ -1,5 +1,5 @@ NAME - gcloud alpha alloydb clusters describe - describes an AlloyDB cluster in a + gcloud alpha alloydb clusters describe - describe an AlloyDB cluster in a given project and region SYNOPSIS @@ -7,7 +7,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Describes an AlloyDB cluster in a given project and region. + (ALPHA) Describe an AlloyDB cluster in a given project and region. EXAMPLES To describe a cluster, run: @@ -36,7 +36,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters describe $ gcloud beta alloydb clusters describe diff --git a/gcloud/alpha/alloydb/clusters/help b/gcloud/alpha/alloydb/clusters/help index 26300ff81..c14a3afda 100644 --- a/gcloud/alpha/alloydb/clusters/help +++ b/gcloud/alpha/alloydb/clusters/help @@ -18,28 +18,37 @@ COMMANDS COMMAND is one of the following: create - (ALPHA) Creates a new AlloyDB cluster within a given project. + (ALPHA) Create a new AlloyDB cluster within a given project. + + create-secondary + (ALPHA) Create a new AlloyDB SECONDARY cluster within a given project. delete - (ALPHA) Deletes an AlloyDB cluster in a given region. + (ALPHA) Delete an AlloyDB cluster in a given region. describe - (ALPHA) Describes an AlloyDB cluster in a given project and region. + (ALPHA) Describe an AlloyDB cluster in a given project and region. list - (ALPHA) Lists AlloyDB clusters in a given project and region. + (ALPHA) List AlloyDB clusters in a given project and region. + + promote + (ALPHA) Promote an AlloyDB SECONDARY cluster in a given project and + region. restore - (ALPHA) Restores an AlloyDB cluster from a given backup. + (ALPHA) Restore an AlloyDB cluster from a given backup. update - (ALPHA) Updates an AlloyDB cluster within a given project and region. + (ALPHA) Update an AlloyDB cluster within a given project and region. 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters $ gcloud beta alloydb clusters diff --git a/gcloud/alpha/alloydb/clusters/list b/gcloud/alpha/alloydb/clusters/list index b433a9d7e..b923d4ab9 100644 --- a/gcloud/alpha/alloydb/clusters/list +++ b/gcloud/alpha/alloydb/clusters/list @@ -1,5 +1,5 @@ NAME - gcloud alpha alloydb clusters list - lists AlloyDB clusters in a given + gcloud alpha alloydb clusters list - list AlloyDB clusters in a given project and region SYNOPSIS @@ -8,8 +8,8 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Lists AlloyDB clusters in a given project in the alphabetical order - of the cluster name. + (ALPHA) List AlloyDB clusters in a given project in alphabetical order + based on the cluster name. EXAMPLES To list clusters, run: @@ -66,7 +66,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters list $ gcloud beta alloydb clusters list diff --git a/gcloud/alpha/alloydb/clusters/promote b/gcloud/alpha/alloydb/clusters/promote new file mode 100644 index 000000000..9719869e9 --- /dev/null +++ b/gcloud/alpha/alloydb/clusters/promote @@ -0,0 +1,47 @@ +NAME + gcloud alpha alloydb clusters promote - promote an AlloyDB SECONDARY + cluster in a given project and region + +SYNOPSIS + gcloud alpha alloydb clusters promote CLUSTER --region=REGION [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Promote an AlloyDB SECONDARY cluster in a given project and region. + +EXAMPLES + To promote a cluster, run: + + $ gcloud alpha alloydb clusters promote my-cluster \ + --region=us-central1 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +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 alloydb clusters promote + diff --git a/gcloud/alpha/alloydb/clusters/restore b/gcloud/alpha/alloydb/clusters/restore index 55c0ed1d8..caeefd23c 100644 --- a/gcloud/alpha/alloydb/clusters/restore +++ b/gcloud/alpha/alloydb/clusters/restore @@ -1,5 +1,5 @@ NAME - gcloud alpha alloydb clusters restore - restores an AlloyDB cluster from a + gcloud alpha alloydb clusters restore - restore an AlloyDB cluster from a given backup SYNOPSIS @@ -10,7 +10,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Restores an AlloyDB cluster from a given backup. + (ALPHA) Restore an AlloyDB cluster from a given backup. EXAMPLES To restore a cluster from a backup, run: @@ -93,7 +93,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters restore $ gcloud beta alloydb clusters restore diff --git a/gcloud/alpha/alloydb/clusters/update b/gcloud/alpha/alloydb/clusters/update index 226026090..8aa413242 100644 --- a/gcloud/alpha/alloydb/clusters/update +++ b/gcloud/alpha/alloydb/clusters/update @@ -1,5 +1,5 @@ NAME - gcloud alpha alloydb clusters update - updates an AlloyDB cluster within a + gcloud alpha alloydb clusters update - update an AlloyDB cluster within a given project and region SYNOPSIS @@ -13,7 +13,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Updates an AlloyDB cluster within a given project and region. + (ALPHA) Update an AlloyDB cluster within a given project and region. EXAMPLES To update a cluster, run: @@ -138,7 +138,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb clusters update $ gcloud beta alloydb clusters update diff --git a/gcloud/alpha/alloydb/help b/gcloud/alpha/alloydb/help index ef0b4845e..5bbbefdb2 100644 --- a/gcloud/alpha/alloydb/help +++ b/gcloud/alpha/alloydb/help @@ -11,7 +11,8 @@ DESCRIPTION AlloyDB is a fully-managed database service that makes it easy to set up, maintain, manage, and administer your Alloydb databases in the cloud. - More information on AlloyDB can be found here at go/alloydb + More information on AlloyDB can be found at + https://cloud.google.com/alloydb GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -37,7 +38,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb $ gcloud beta alloydb diff --git a/gcloud/alpha/alloydb/instances/create b/gcloud/alpha/alloydb/instances/create index c9cb0193a..1b70f5558 100644 --- a/gcloud/alpha/alloydb/instances/create +++ b/gcloud/alpha/alloydb/instances/create @@ -92,7 +92,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances create $ gcloud beta alloydb instances create diff --git a/gcloud/alpha/alloydb/instances/create-secondary b/gcloud/alpha/alloydb/instances/create-secondary new file mode 100644 index 000000000..3765b4b8d --- /dev/null +++ b/gcloud/alpha/alloydb/instances/create-secondary @@ -0,0 +1,50 @@ +NAME + gcloud alpha alloydb instances create-secondary - creates a new AlloyDB + SECONDARY instance within a given cluster + +SYNOPSIS + gcloud alpha alloydb instances create-secondary INSTANCE --cluster=CLUSTER + --region=REGION [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creates a new AlloyDB SECONDARY instance within a given cluster. + +EXAMPLES + To create a new secondary instance, run: + + $ gcloud alpha alloydb instances create-secondary my-instance \ + --cluster=my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +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 alloydb instances create-secondary + diff --git a/gcloud/alpha/alloydb/instances/delete b/gcloud/alpha/alloydb/instances/delete index 88004061a..6bd514452 100644 --- a/gcloud/alpha/alloydb/instances/delete +++ b/gcloud/alpha/alloydb/instances/delete @@ -44,7 +44,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances delete $ gcloud beta alloydb instances delete diff --git a/gcloud/alpha/alloydb/instances/describe b/gcloud/alpha/alloydb/instances/describe index 7f57b9ec7..262925531 100644 --- a/gcloud/alpha/alloydb/instances/describe +++ b/gcloud/alpha/alloydb/instances/describe @@ -43,7 +43,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances describe $ gcloud beta alloydb instances describe diff --git a/gcloud/alpha/alloydb/instances/failover b/gcloud/alpha/alloydb/instances/failover index fa21521f2..4ad32dced 100644 --- a/gcloud/alpha/alloydb/instances/failover +++ b/gcloud/alpha/alloydb/instances/failover @@ -44,7 +44,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances failover $ gcloud beta alloydb instances failover diff --git a/gcloud/alpha/alloydb/instances/help b/gcloud/alpha/alloydb/instances/help index def1ada99..f879d345b 100644 --- a/gcloud/alpha/alloydb/instances/help +++ b/gcloud/alpha/alloydb/instances/help @@ -20,6 +20,10 @@ COMMANDS create (ALPHA) Creates a new AlloyDB instance within a given cluster. + create-secondary + (ALPHA) Creates a new AlloyDB SECONDARY instance within a given + cluster. + delete (ALPHA) Deletes an AlloyDB instance within a given cluster. @@ -42,7 +46,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances $ gcloud beta alloydb instances diff --git a/gcloud/alpha/alloydb/instances/list b/gcloud/alpha/alloydb/instances/list index a06ffaa5f..11b4d38b7 100644 --- a/gcloud/alpha/alloydb/instances/list +++ b/gcloud/alpha/alloydb/instances/list @@ -78,7 +78,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances list $ gcloud beta alloydb instances list diff --git a/gcloud/alpha/alloydb/instances/restart b/gcloud/alpha/alloydb/instances/restart index b2a3c8ab6..aed7fe5a7 100644 --- a/gcloud/alpha/alloydb/instances/restart +++ b/gcloud/alpha/alloydb/instances/restart @@ -44,7 +44,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances restart $ gcloud beta alloydb instances restart diff --git a/gcloud/alpha/alloydb/instances/update b/gcloud/alpha/alloydb/instances/update index 0f8ce51f7..6e8e24360 100644 --- a/gcloud/alpha/alloydb/instances/update +++ b/gcloud/alpha/alloydb/instances/update @@ -73,7 +73,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb instances update $ gcloud beta alloydb instances update diff --git a/gcloud/alpha/alloydb/operations/cancel b/gcloud/alpha/alloydb/operations/cancel index f1e6a34d2..2ff82c265 100644 --- a/gcloud/alpha/alloydb/operations/cancel +++ b/gcloud/alpha/alloydb/operations/cancel @@ -35,7 +35,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb operations cancel $ gcloud beta alloydb operations cancel diff --git a/gcloud/alpha/alloydb/operations/delete b/gcloud/alpha/alloydb/operations/delete index 0ab6f4318..45723183c 100644 --- a/gcloud/alpha/alloydb/operations/delete +++ b/gcloud/alpha/alloydb/operations/delete @@ -35,7 +35,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb operations delete $ gcloud beta alloydb operations delete diff --git a/gcloud/alpha/alloydb/operations/describe b/gcloud/alpha/alloydb/operations/describe index 498c31162..1234705bf 100644 --- a/gcloud/alpha/alloydb/operations/describe +++ b/gcloud/alpha/alloydb/operations/describe @@ -1,12 +1,12 @@ NAME - gcloud alpha alloydb operations describe - describe an AlloyDB operation + gcloud alpha alloydb operations describe - describes an AlloyDB operation SYNOPSIS gcloud alpha alloydb operations describe OPERATION --region=REGION [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Describe an AlloyDB operation. + (ALPHA) Describes an AlloyDB operation. EXAMPLES To describe an operation, run: @@ -35,7 +35,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb operations describe $ gcloud beta alloydb operations describe diff --git a/gcloud/alpha/alloydb/operations/help b/gcloud/alpha/alloydb/operations/help index 871bb4938..03da06338 100644 --- a/gcloud/alpha/alloydb/operations/help +++ b/gcloud/alpha/alloydb/operations/help @@ -24,7 +24,7 @@ COMMANDS (ALPHA) Deletes an AlloyDB operation. describe - (ALPHA) Describe an AlloyDB operation. + (ALPHA) Describes an AlloyDB operation. list (ALPHA) Lists AlloyDB operations. @@ -33,7 +33,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb operations $ gcloud beta alloydb operations diff --git a/gcloud/alpha/alloydb/operations/list b/gcloud/alpha/alloydb/operations/list index 1e4189d21..d6f8f41af 100644 --- a/gcloud/alpha/alloydb/operations/list +++ b/gcloud/alpha/alloydb/operations/list @@ -68,7 +68,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud alloydb operations list $ gcloud beta alloydb operations list diff --git a/gcloud/alpha/app/update b/gcloud/alpha/app/update index 782d8a87c..b365d6cd7 100644 --- a/gcloud/alpha/app/update +++ b/gcloud/alpha/app/update @@ -2,7 +2,8 @@ NAME gcloud alpha app update - updates an App Engine application SYNOPSIS - gcloud alpha app update [--[no-]split-health-checks] [GCLOUD_WIDE_FLAG ...] + gcloud alpha app update [--service-account=SERVICE_ACCOUNT] + [--[no-]split-health-checks] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command is used to update settings on an app engine @@ -13,7 +14,14 @@ EXAMPLES $ gcloud alpha app update --split-health-checks + To update the app-level service account on an application: + + $ gcloud alpha app update --service-account=SERVICE_ACCOUNT + FLAGS + --service-account=SERVICE_ACCOUNT + The app-level default service account to update the app with. + --[no-]split-health-checks Enables/disables split health checks by default on new deployments. Use --split-health-checks to enable and --no-split-health-checks to diff --git a/gcloud/alpha/artifacts/repositories/config/export b/gcloud/alpha/artifacts/repositories/config/export index be8394878..4afcecc62 100644 --- a/gcloud/alpha/artifacts/repositories/config/export +++ b/gcloud/alpha/artifacts/repositories/config/export @@ -84,7 +84,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/asset/analyze-org-policies b/gcloud/alpha/asset/analyze-org-policies index 9be268212..465fd5193 100644 --- a/gcloud/alpha/asset/analyze-org-policies +++ b/gcloud/alpha/asset/analyze-org-policies @@ -76,5 +76,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta asset analyze-org-policies diff --git a/gcloud/alpha/asset/analyze-org-policy-governed-containers b/gcloud/alpha/asset/analyze-org-policy-governed-containers index 49f6f79a6..9dad3ecc3 100644 --- a/gcloud/alpha/asset/analyze-org-policy-governed-containers +++ b/gcloud/alpha/asset/analyze-org-policy-governed-containers @@ -77,5 +77,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta asset analyze-org-policy-governed-containers diff --git a/gcloud/alpha/asset/query b/gcloud/alpha/asset/query index 166f309d2..3f910ed72 100644 --- a/gcloud/alpha/asset/query +++ b/gcloud/alpha/asset/query @@ -13,17 +13,17 @@ SYNOPSIS : --bigquery-dataset=BIGQUERY_DATASET]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Issue an analytical query on Cloud assets using BigQuery Standard + (ALPHA) Issue an analytical query on Cloud assets using a BigQuery Standard SQL compatible statement. EXAMPLES - To count the number of compute instance, run: + To count the number of compute instances, run: $ gcloud alpha asset query --project='test-project' \ --statement='SELECT * FROM compute_googleapis_com_Instance' - To see the query result of previous job, pass the job-reference from - previous response: + To see the query result of the previous job, pass the job-reference from + the previous response: $ gcloud alpha asset query --project='test-project' \ --job-reference= @@ -155,7 +155,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud asset query $ gcloud beta asset query diff --git a/gcloud/alpha/assured/workloads/create b/gcloud/alpha/assured/workloads/create index 79032785a..49763171e 100644 --- a/gcloud/alpha/assured/workloads/create +++ b/gcloud/alpha/assured/workloads/create @@ -83,8 +83,8 @@ OPTIONAL FLAGS --partner=PARTNER The partner choice when creating a workload managed by local trusted - partners. PARTNER must be (currently only one value is supported): - LOCAL_CONTROLS_BY_S3NS. + partners. PARTNER must be one of: LOCAL_CONTROLS_BY_S3NS, + SOVEREIGN_CONTROLS_BY_T_SYSTEMS. --provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT The parent of the provisioned projects, for example, diff --git a/gcloud/alpha/bigtable/app-profiles/config/export b/gcloud/alpha/bigtable/app-profiles/config/export index 84e97f5b4..575ca2c78 100644 --- a/gcloud/alpha/bigtable/app-profiles/config/export +++ b/gcloud/alpha/bigtable/app-profiles/config/export @@ -79,7 +79,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/bigtable/instances/config/export b/gcloud/alpha/bigtable/instances/config/export index bfea50355..cb80bbdca 100644 --- a/gcloud/alpha/bigtable/instances/config/export +++ b/gcloud/alpha/bigtable/instances/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/bigtable/instances/tables/config/export b/gcloud/alpha/bigtable/instances/tables/config/export index a1e55ed4a..4fa177d72 100644 --- a/gcloud/alpha/bigtable/instances/tables/config/export +++ b/gcloud/alpha/bigtable/instances/tables/config/export @@ -78,7 +78,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/bigtable/instances/tables/create b/gcloud/alpha/bigtable/instances/tables/create index ee6799d3f..58eefa830 100644 --- a/gcloud/alpha/bigtable/instances/tables/create +++ b/gcloud/alpha/bigtable/instances/tables/create @@ -122,5 +122,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud bigtable instances tables create + + $ gcloud beta bigtable instances tables create diff --git a/gcloud/alpha/bigtable/instances/tables/delete b/gcloud/alpha/bigtable/instances/tables/delete index 757f08234..d11f56315 100644 --- a/gcloud/alpha/bigtable/instances/tables/delete +++ b/gcloud/alpha/bigtable/instances/tables/delete @@ -57,5 +57,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud bigtable instances tables delete + + $ gcloud beta bigtable instances tables delete diff --git a/gcloud/alpha/bigtable/instances/tables/describe b/gcloud/alpha/bigtable/instances/tables/describe index 6f495eb70..fac42c9da 100644 --- a/gcloud/alpha/bigtable/instances/tables/describe +++ b/gcloud/alpha/bigtable/instances/tables/describe @@ -58,6 +58,9 @@ FLAGS Only populates name and fields related to the table's replication. schema Only populates name and fields related to the table's schema. + stats + Only populates name and fields related to the table's statistics + (e.g. TableStats and ColumnFamilyStats). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/bigtable/instances/tables/restore b/gcloud/alpha/bigtable/instances/tables/restore index fed90e1fa..bb209e6dd 100644 --- a/gcloud/alpha/bigtable/instances/tables/restore +++ b/gcloud/alpha/bigtable/instances/tables/restore @@ -21,12 +21,13 @@ EXAMPLES --source=backup1 --destination-instance=instance1 \ --destination=table2 - To restore table 'table2' from backup 'backup1' using relative names, run: + To restore table 'table2' from backup 'backup1' in a different project, + run: $ gcloud alpha bigtable instances tables restore \ --source=projects/project1/instances/instance1/clusters/\ cluster1/backups/backup1 \ - --destination=projects/project1/instances/instance1/tables/\ + --destination=projects/project2/instances/instance2/tables/\ table2 REQUIRED FLAGS diff --git a/gcloud/alpha/bigtable/instances/tables/update b/gcloud/alpha/bigtable/instances/tables/update index 423370d1c..3a976cbcb 100644 --- a/gcloud/alpha/bigtable/instances/tables/update +++ b/gcloud/alpha/bigtable/instances/tables/update @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha bigtable instances tables update (TABLE : --instance=INSTANCE) - [--deletion-protection] [GCLOUD_WIDE_FLAG ...] + [--async] [--deletion-protection] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update an existing new Cloud Bigtable table with the specified @@ -48,6 +48,10 @@ POSITIONAL ARGUMENTS ▸ provide the argument --instance on the command line. FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --deletion-protection Once specified, the table is deletion protected. @@ -67,5 +71,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud bigtable instances tables update + + $ gcloud beta bigtable instances tables update diff --git a/gcloud/alpha/blockchain-node-engine/help b/gcloud/alpha/blockchain-node-engine/help new file mode 100644 index 000000000..481411b5e --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/help @@ -0,0 +1,31 @@ +NAME + gcloud alpha blockchain-node-engine - create and manipulate Blockchain Node + Engine resources + +SYNOPSIS + gcloud alpha blockchain-node-engine GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud blockchain-node-engine command group lets you create and + manage Blockchain Node Engine nodes. + + Blockchain Node Engine is a fully-managed blockchain node service that + makes it easy to set up and manage your blockchain nodes in the cloud. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + nodes + (ALPHA) List blockchain nodes. + +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. + diff --git a/gcloud/alpha/blockchain-node-engine/nodes/help b/gcloud/alpha/blockchain-node-engine/nodes/help new file mode 100644 index 000000000..06a34b13a --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/nodes/help @@ -0,0 +1,26 @@ +NAME + gcloud alpha blockchain-node-engine nodes - list blockchain nodes + +SYNOPSIS + gcloud alpha blockchain-node-engine nodes COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List blockchain nodes. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + (ALPHA) List Blockchain Node Engine nodes. + +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. + diff --git a/gcloud/alpha/blockchain-node-engine/nodes/list b/gcloud/alpha/blockchain-node-engine/nodes/list new file mode 100644 index 000000000..cf9f8d07f --- /dev/null +++ b/gcloud/alpha/blockchain-node-engine/nodes/list @@ -0,0 +1,89 @@ +NAME + gcloud alpha blockchain-node-engine nodes list - list Blockchain Node + Engine nodes + +SYNOPSIS + gcloud alpha blockchain-node-engine nodes list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Blockchain Node Engine nodes + +EXAMPLES + The following command lists the status of blockchain nodes in location + us-central1-b: + + $ gcloud alpha blockchain-node-engine nodes list \ + --location=us-central1-b + +FLAGS + Location resource - Location from which to list blockchain nodes. + + To find a list of compute zones available for Blockchain Node Engine nodes + in your project, run gcloud alpha blockchain-node-engine nodes locations + list. 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 --location on the command line with a fully + specified name; + ◆ set the property web3/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property web3/location. + +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 blockchainnodeengine/v1alpha1 API. The full + documentation for this API can be found at: https://cloud.google.com/web3 + +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. + diff --git a/gcloud/alpha/bms/help b/gcloud/alpha/bms/help index be310f371..0c2d14fab 100644 --- a/gcloud/alpha/bms/help +++ b/gcloud/alpha/bms/help @@ -28,6 +28,9 @@ GROUPS (ALPHA) Manage SSH keys for accessing the interactive serial console in Bare Metal Solution. + ssh-keys + (ALPHA) Manage SSH keys for Bare Metal Solution. + volumes (ALPHA) Manage bare metal volumes in Bare Metal Solution. diff --git a/gcloud/alpha/bms/ssh-keys/add b/gcloud/alpha/bms/ssh-keys/add new file mode 100644 index 000000000..4c86f632a --- /dev/null +++ b/gcloud/alpha/bms/ssh-keys/add @@ -0,0 +1,67 @@ +NAME + gcloud alpha bms ssh-keys add - add a public SSH key to the project in Bare + Metal Solution + +SYNOPSIS + gcloud alpha bms ssh-keys add SSH_KEY (--key=KEY | --key-file=KEY_FILE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add a public SSH key to the project in Bare Metal Solution. + +EXAMPLES + To add an SSH key called my-ssh-key in project my-project with a public key + ABC6695 + + $ gcloud alpha bms ssh-keys add my-ssh-key --project=my-project \ + --key=ABC6695 + + To add an SSH key called my-ssh-key in project my-project with a public key + stored in /home/user/.ssh/id_rsa.pub + + $ gcloud alpha bms ssh-keys add my-ssh-key --project=my-project \ + --key-file=/home/user/.ssh/id_rsa.pub + +POSITIONAL ARGUMENTS + SSH key resource - ssh_key. 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 ssh_key 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 ssh_key on the command line with a fully + specified name; + ◆ global is the only supported location. + + This must be specified. + + SSH_KEY + ID of the SSH key or fully qualified identifier for the SSH key. To + set the ssh_key attribute: + ▸ provide the argument ssh_key on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --key=KEY + The SSH public key to add + + --key-file=KEY_FILE + The path to a file containing an SSH public key to add + +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. + diff --git a/gcloud/alpha/bms/ssh-keys/help b/gcloud/alpha/bms/ssh-keys/help new file mode 100644 index 000000000..ba79096f3 --- /dev/null +++ b/gcloud/alpha/bms/ssh-keys/help @@ -0,0 +1,32 @@ +NAME + gcloud alpha bms ssh-keys - manage SSH keys for Bare Metal Solution + +SYNOPSIS + gcloud alpha bms ssh-keys COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage SSH keys for Bare Metal Solution. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + add + (ALPHA) Add a public SSH key to the project in Bare Metal Solution. + + list + (ALPHA) List the SSH keys added to the project in Bare Metal Solution. + + remove + (ALPHA) Remove an SSH key in Bare Metal Solution given its name. + +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. + diff --git a/gcloud/alpha/bms/ssh-keys/list b/gcloud/alpha/bms/ssh-keys/list new file mode 100644 index 000000000..0aa11e70e --- /dev/null +++ b/gcloud/alpha/bms/ssh-keys/list @@ -0,0 +1,43 @@ +NAME + gcloud alpha bms ssh-keys list - list the SSH keys added to the project in + Bare Metal Solution + +SYNOPSIS + gcloud alpha bms ssh-keys list [--filter=EXPRESSION] [--limit=LIMIT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the SSH keys added to the project in Bare Metal Solution. + +EXAMPLES + To list all SSH keys within the project, run: + + $ gcloud alpha bms ssh-keys list + +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, --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, --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. + +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. + diff --git a/gcloud/alpha/bms/ssh-keys/remove b/gcloud/alpha/bms/ssh-keys/remove new file mode 100644 index 000000000..5025a2264 --- /dev/null +++ b/gcloud/alpha/bms/ssh-keys/remove @@ -0,0 +1,49 @@ +NAME + gcloud alpha bms ssh-keys remove - remove an SSH key in Bare Metal Solution + given its name + +SYNOPSIS + gcloud alpha bms ssh-keys remove SSH_KEY [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Remove an SSH key in Bare Metal Solution given its name. + +EXAMPLES + To remove an SSH key called my-ssh-key run: + + $ gcloud alpha bms ssh-keys remove my-ssh-key + +POSITIONAL ARGUMENTS + SSH key resource - ssh_key. 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 ssh_key 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 ssh_key on the command line with a fully + specified name; + ◆ global is the only supported location. + + This must be specified. + + SSH_KEY + ID of the SSH key or fully qualified identifier for the SSH key. To + set the ssh_key attribute: + ▸ provide the argument ssh_key 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. + diff --git a/gcloud/alpha/bq/datasets/config/export b/gcloud/alpha/bq/datasets/config/export index fc20c82a8..d5fdaba98 100644 --- a/gcloud/alpha/bq/datasets/config/export +++ b/gcloud/alpha/bq/datasets/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/bq/jobs/config/export b/gcloud/alpha/bq/jobs/config/export index b7357a96f..12e32a787 100644 --- a/gcloud/alpha/bq/jobs/config/export +++ b/gcloud/alpha/bq/jobs/config/export @@ -61,7 +61,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/bq/tables/config/export b/gcloud/alpha/bq/tables/config/export index 283b71de4..f20a17c5f 100644 --- a/gcloud/alpha/bq/tables/config/export +++ b/gcloud/alpha/bq/tables/config/export @@ -77,7 +77,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/builds/cancel b/gcloud/alpha/builds/cancel index 55f503c2e..0b36e02a7 100644 --- a/gcloud/alpha/builds/cancel +++ b/gcloud/alpha/builds/cancel @@ -24,8 +24,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/builds/describe b/gcloud/alpha/builds/describe index 7be1c5265..f652e6f3f 100644 --- a/gcloud/alpha/builds/describe +++ b/gcloud/alpha/builds/describe @@ -20,8 +20,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/create b/gcloud/alpha/builds/enterprise-config/bitbucketserver/create index 3c82e577a..75901fd33 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/create +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/create @@ -53,8 +53,9 @@ OPTIONAL FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --ssl-ca-file=SSL_CA_FILE Path to a local file that contains SSL certificate to use for requests diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete b/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete index dff0a8d73..64df9b42f 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete @@ -16,8 +16,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe b/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe index 12b6086de..21715b15a 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe @@ -16,8 +16,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/list b/gcloud/alpha/builds/enterprise-config/bitbucketserver/list index 95b7033c5..7be7f568b 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/list +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/list @@ -14,8 +14,9 @@ DESCRIPTION FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/update b/gcloud/alpha/builds/enterprise-config/bitbucketserver/update index 02c74fc2f..c9d03ea52 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/update +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/update @@ -37,8 +37,9 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --ssl-ca-file=SSL_CA_FILE Path to a local file that contains SSL certificate to use for requests diff --git a/gcloud/alpha/builds/list b/gcloud/alpha/builds/list index a7092c5e0..66ada299f 100644 --- a/gcloud/alpha/builds/list +++ b/gcloud/alpha/builds/list @@ -25,18 +25,17 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. 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. - With the exception of regex matching, this flag interacts with other - flags that are applied in this order: --flatten, --sort-by, --filter, - --limit. Any regex operations specified by --filter are applied - client-side, after --limit. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. --limit=LIMIT; default=50 Maximum number of resources to list. The default is 50. This flag diff --git a/gcloud/alpha/builds/log b/gcloud/alpha/builds/log index e4332f0eb..d2eb251a5 100644 --- a/gcloud/alpha/builds/log +++ b/gcloud/alpha/builds/log @@ -26,8 +26,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --stream If a build is ongoing, stream the logs to stdout until the build diff --git a/gcloud/alpha/builds/submit b/gcloud/alpha/builds/submit index 6b28dadc5..8cda67330 100644 --- a/gcloud/alpha/builds/submit +++ b/gcloud/alpha/builds/submit @@ -94,8 +94,9 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --substitutions=[KEY=VALUE,...] Parameters to be substituted in the build specification. @@ -168,9 +169,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - You can also run a build locally using the separate component: gcloud - components install cloud-build-local. - 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 diff --git a/gcloud/alpha/builds/triggers/config/export b/gcloud/alpha/builds/triggers/config/export index eea1c0c71..ccee71c07 100644 --- a/gcloud/alpha/builds/triggers/config/export +++ b/gcloud/alpha/builds/triggers/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/builds/triggers/create/bitbucketserver b/gcloud/alpha/builds/triggers/create/bitbucketserver index f92312d7e..c2bb06cc2 100644 --- a/gcloud/alpha/builds/triggers/create/bitbucketserver +++ b/gcloud/alpha/builds/triggers/create/bitbucketserver @@ -7,10 +7,11 @@ SYNOPSIS (--trigger-config=PATH | [--bitbucket-server-config-resource=BITBUCKET_SERVER_CONFIG_RESOURCE --project-key=PROJECT_KEY --repo-slug=REPO_SLUG (--branch-pattern=REGEX | --tag-pattern=REGEX | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, 1)]) (--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) : --description=DESCRIPTION --ignored-files=[GLOB,...] - --included-files=[GLOB,...] --name=NAME --require-approval + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -84,6 +85,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -163,20 +171,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -188,6 +192,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -216,7 +223,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create bitbucketserver $ gcloud beta builds triggers create bitbucketserver diff --git a/gcloud/alpha/builds/triggers/create/cloud-source-repositories b/gcloud/alpha/builds/triggers/create/cloud-source-repositories index caf362f5a..330832b23 100644 --- a/gcloud/alpha/builds/triggers/create/cloud-source-repositories +++ b/gcloud/alpha/builds/triggers/create/cloud-source-repositories @@ -6,10 +6,11 @@ SYNOPSIS gcloud alpha builds triggers create cloud-source-repositories (--trigger-config=PATH | [--repo=REPO (--branch-pattern=REGEX | --tag-pattern=REGEX) (--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) : --description=DESCRIPTION --ignored-files=[GLOB,...] - --included-files=[GLOB,...] --name=NAME --require-approval + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -63,6 +64,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -120,20 +128,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -145,6 +149,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -173,7 +180,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create cloud-source-repositories $ gcloud beta builds triggers create cloud-source-repositories diff --git a/gcloud/alpha/builds/triggers/create/github b/gcloud/alpha/builds/triggers/create/github index b015e71c9..23686859a 100644 --- a/gcloud/alpha/builds/triggers/create/github +++ b/gcloud/alpha/builds/triggers/create/github @@ -4,15 +4,16 @@ NAME SYNOPSIS gcloud alpha builds triggers create github - (--trigger-config=PATH | [--repo-name=REPO_NAME - --repo-owner=REPO_OWNER (--branch-pattern=REGEX | --tag-pattern=REGEX + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED"]) (--build-config=PATH - | --inline-config=PATH | --dockerfile=DOCKERFILE - --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --ignored-files=[GLOB,...] - --include-logs-with-status --included-files=[GLOB,...] --name=NAME + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; default="/" + --dockerfile-image=DOCKERFILE_IMAGE]) (--repository=REPOSITORY + | [--repo-name=REPO_NAME --repo-owner=REPO_OWNER + : --enterprise-config=ENTERPRISE_CONFIG]) : --description=DESCRIPTION + --ignored-files=[GLOB,...] --include-logs-with-status + --included-files=[GLOB,...] --name=NAME --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -21,7 +22,7 @@ DESCRIPTION (ALPHA) Create a build trigger for a GitHub repository. EXAMPLES - To create a push trigger for all branches: + To create a push trigger with a 1st-gen repository for all branches: $ gcloud alpha builds triggers create github --name="my-trigger" \ --service-account="projects/my-project/serviceAccounts/my-byosa@\ @@ -30,7 +31,7 @@ EXAMPLES --repo-name="cloud-builders" --branch-pattern=".*" \ --build-config="cloudbuild.yaml" - To create a pull request trigger for master: + To create a pull request trigger with a 1st-gen repository for master: $ gcloud alpha builds triggers create github --name="my-trigger" \ --service-account="projects/my-project/serviceAccounts/my-byosa@\ @@ -39,6 +40,14 @@ EXAMPLES --repo-name="cloud-builders" --pull-request-pattern="^master$" \ --build-config="cloudbuild.yaml" + To create a pull request trigger with a 2nd gen repository for master: + + $ gcloud alpha builds triggers create github --name="my-trigger" \ + --repository=projects/my-project/locations/us-central1/\ + connections/my-conn/repositories/my-repo \ + --pull-request-pattern="^master$" \ + --build-config="cloudbuild.yaml" + REQUIRED FLAGS Exactly one of these must be specified: @@ -49,18 +58,6 @@ REQUIRED FLAGS Flag based trigger configuration - --repo-name=REPO_NAME - Name of the GitHub Repository. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --repo-owner=REPO_OWNER - Owner of the GitHub Repository. - - This flag argument must be specified if any of the other arguments - in this group are specified. - --description=DESCRIPTION Build trigger description. @@ -79,6 +76,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -170,20 +174,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -195,6 +195,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -211,6 +214,33 @@ REQUIRED FLAGS Use a build configuration (cloudbuild.yaml) file for building multiple images in a single trigger. + Exactly one of these must be specified: + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + 1st-gen repository settings. + + --repo-name=REPO_NAME + Name of the GitHub Repository (1st gen). + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --repo-owner=REPO_OWNER + Owner of the GitHub Repository (1st gen). + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --enterprise-config=ENTERPRISE_CONFIG + Resource name of the GitHub Enterprise config that should be + applied to this installation. + + For example: + "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id} + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -223,7 +253,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create github $ gcloud beta builds triggers create github diff --git a/gcloud/alpha/builds/triggers/create/gitlab-enterprise b/gcloud/alpha/builds/triggers/create/gitlab-enterprise index cb0a709de..ed823b094 100644 --- a/gcloud/alpha/builds/triggers/create/gitlab-enterprise +++ b/gcloud/alpha/builds/triggers/create/gitlab-enterprise @@ -6,15 +6,16 @@ SYNOPSIS gcloud alpha builds triggers create gitlab-enterprise (--trigger-config=PATH | [--gitlab-config-resource=GITLAB_CONFIG_RESOURCE - --project-namespace=PROJECT_NAMESPACE - --region=REGION (--branch-pattern=REGEX | --tag-pattern=REGEX - | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + --project-namespace=PROJECT_NAMESPACE (--branch-pattern=REGEX + | --tag-pattern=REGEX | [--pull-request-pattern=REGEX + : --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, 1)]) (--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) : --description=DESCRIPTION --ignored-files=[GLOB,...] - --included-files=[GLOB,...] --name=NAME --require-approval + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -65,14 +66,6 @@ REQUIRED FLAGS This flag argument must be specified if any of the other arguments in this group are specified. - --region=REGION - The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region - is used. If builds/region is unset,region is set to "global". - - This flag argument must be specified if any of the other arguments - in this group are specified. - --description=DESCRIPTION Build trigger description. @@ -87,6 +80,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -187,6 +187,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -215,7 +218,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create gitlab-enterprise $ gcloud beta builds triggers create gitlab-enterprise diff --git a/gcloud/alpha/builds/triggers/create/help b/gcloud/alpha/builds/triggers/create/help index a1d3da85e..5f77113f1 100644 --- a/gcloud/alpha/builds/triggers/create/help +++ b/gcloud/alpha/builds/triggers/create/help @@ -41,7 +41,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create $ gcloud beta builds triggers create diff --git a/gcloud/alpha/builds/triggers/create/manual b/gcloud/alpha/builds/triggers/create/manual index dd2569381..d09d9c842 100644 --- a/gcloud/alpha/builds/triggers/create/manual +++ b/gcloud/alpha/builds/triggers/create/manual @@ -5,11 +5,11 @@ NAME SYNOPSIS gcloud alpha builds triggers create manual (--trigger-config=PATH | [(--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --name=NAME --require-approval - --service-account=SERVICE_ACCOUNT - --subscription-filter=SUBSCRIPTION_FILTER + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...] --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) [GCLOUD_WIDE_FLAG ...] @@ -39,9 +39,22 @@ REQUIRED FLAGS --description=DESCRIPTION Build trigger description. + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -53,11 +66,6 @@ REQUIRED FLAGS used instead. Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. - --subscription-filter=SUBSCRIPTION_FILTER - CEL filter expression for the trigger. See - https://cloud.google.com/build/docs/filter-build-events-using-cel - for more details. - --substitutions=[KEY=VALUE,...] Parameters to be substituted in the build specification. @@ -80,20 +88,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -105,6 +109,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -157,7 +164,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create manual $ gcloud beta builds triggers create manual diff --git a/gcloud/alpha/builds/triggers/create/pubsub b/gcloud/alpha/builds/triggers/create/pubsub index 2787c7e33..8703d6223 100644 --- a/gcloud/alpha/builds/triggers/create/pubsub +++ b/gcloud/alpha/builds/triggers/create/pubsub @@ -5,11 +5,12 @@ NAME SYNOPSIS gcloud alpha builds triggers create pubsub (--trigger-config=PATH | [--topic=TOPIC (--build-config=PATH - | --inline-config=PATH | --dockerfile=DOCKERFILE - --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --name=NAME --require-approval - --service-account=SERVICE_ACCOUNT + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --subscription-filter=SUBSCRIPTION_FILTER --substitutions=[KEY=VALUE,...] --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) @@ -49,9 +50,22 @@ REQUIRED FLAGS --description=DESCRIPTION Build trigger description. + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -90,20 +104,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -115,6 +125,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -167,7 +180,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create pubsub $ gcloud beta builds triggers create pubsub diff --git a/gcloud/alpha/builds/triggers/create/webhook b/gcloud/alpha/builds/triggers/create/webhook index b8e096476..5ddfdda5c 100644 --- a/gcloud/alpha/builds/triggers/create/webhook +++ b/gcloud/alpha/builds/triggers/create/webhook @@ -5,11 +5,12 @@ NAME SYNOPSIS gcloud alpha builds triggers create webhook (--trigger-config=PATH | [--secret=SECRET (--build-config=PATH - | --inline-config=PATH | --dockerfile=DOCKERFILE - --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --name=NAME --require-approval - --service-account=SERVICE_ACCOUNT + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --subscription-filter=SUBSCRIPTION_FILTER --substitutions=[KEY=VALUE,...] --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) @@ -52,9 +53,22 @@ REQUIRED FLAGS --description=DESCRIPTION Build trigger description. + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -93,20 +107,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -118,6 +128,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -170,7 +183,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers create webhook $ gcloud beta builds triggers create webhook diff --git a/gcloud/alpha/builds/triggers/delete b/gcloud/alpha/builds/triggers/delete index 124d2eb7f..f0160043a 100644 --- a/gcloud/alpha/builds/triggers/delete +++ b/gcloud/alpha/builds/triggers/delete @@ -52,7 +52,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers delete $ gcloud beta builds triggers delete diff --git a/gcloud/alpha/builds/triggers/describe b/gcloud/alpha/builds/triggers/describe index 14be99a69..47d3850b5 100644 --- a/gcloud/alpha/builds/triggers/describe +++ b/gcloud/alpha/builds/triggers/describe @@ -53,7 +53,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers describe $ gcloud beta builds triggers describe diff --git a/gcloud/alpha/builds/triggers/help b/gcloud/alpha/builds/triggers/help index ad3d472d2..44cc822e8 100644 --- a/gcloud/alpha/builds/triggers/help +++ b/gcloud/alpha/builds/triggers/help @@ -47,7 +47,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers $ gcloud beta builds triggers diff --git a/gcloud/alpha/builds/triggers/import b/gcloud/alpha/builds/triggers/import index f5f100aab..880b3c363 100644 --- a/gcloud/alpha/builds/triggers/import +++ b/gcloud/alpha/builds/triggers/import @@ -22,8 +22,9 @@ REQUIRED FLAGS OPTIONAL FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -37,7 +38,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers import $ gcloud beta builds triggers import diff --git a/gcloud/alpha/builds/triggers/list b/gcloud/alpha/builds/triggers/list index 7dcbd6a51..c6ebb5cd0 100644 --- a/gcloud/alpha/builds/triggers/list +++ b/gcloud/alpha/builds/triggers/list @@ -18,8 +18,9 @@ EXAMPLES FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. LIST COMMAND FLAGS --filter=EXPRESSION @@ -65,7 +66,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers list $ gcloud beta builds triggers list diff --git a/gcloud/alpha/builds/triggers/run b/gcloud/alpha/builds/triggers/run index ba1b628b3..accf7d2d5 100644 --- a/gcloud/alpha/builds/triggers/run +++ b/gcloud/alpha/builds/triggers/run @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud alpha builds triggers run (TRIGGER : --region=REGION) - [--branch=BRANCH | --sha=SHA | --tag=TAG] [GCLOUD_WIDE_FLAG ...] + (--branch=BRANCH | --sha=SHA | --tag=TAG) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Run a build trigger. @@ -40,8 +40,8 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property builds/region. -FLAGS - At most one of these can be specified: +REQUIRED FLAGS + Exactly one of these must be specified: --branch=BRANCH Branch to run. @@ -64,7 +64,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud builds triggers run $ gcloud beta builds triggers run diff --git a/gcloud/alpha/builds/worker-pools/create b/gcloud/alpha/builds/worker-pools/create index 5c62f5a03..71baf3980 100644 --- a/gcloud/alpha/builds/worker-pools/create +++ b/gcloud/alpha/builds/worker-pools/create @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud alpha builds worker-pools create WORKER_POOL --region=REGION [--config-from-file=CONFIG_FROM_FILE | --peered-network=PEERED_NETWORK - --no-public-egress --worker-disk-size=WORKER_DISK_SIZE + --peered-network-ip-range=PEERED_NETWORK_IP_RANGE --no-public-egress + --worker-disk-size=WORKER_DISK_SIZE --worker-machine-type=WORKER_MACHINE_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -20,11 +21,13 @@ EXAMPLES To create a private pool in project p1 in region us-central1 where workers are of machine type e2-standard-2 and are peered to the VPC network - projects/123/global/networks/default and have a disk size of 64GB, run: + projects/123/global/networks/default within the IP range 192.168.0.0/28 and + have a disk size of 64GB, run: $ gcloud alpha builds worker-pools create pwp1 --project=p1 \ --region=us-central1 \ --peered-network=projects/123/global/networks/default \ + --peered-network-ip-range=192.168.0.0/28 \ --worker-machine-type=e2-standard-2 --worker-disk-size=64GB ▪ Hybrid pools @@ -78,6 +81,19 @@ OPTIONAL FLAGS If not specified, the workers are not peered to any network. + --peered-network-ip-range=PEERED_NETWORK_IP_RANGE + An IP range for your peered network. Specify the IP range using + Classless Inter-Domain Routing (CIDR) notation with a slash and + the subnet prefix size, such as '/29'. + + Your subnet prefix size must be between 1 and 29. Optional: you + can specify an IP address before the subnet prefix value - for + example 192.168.0.1/24. + + If no IP address is specified, your VPC automatically determines + the starting IP for the range. If no IP range is specified, Cloud + Build uses '/24' as the default network IP range. + --no-public-egress If set, workers in the worker pool are created without an external IP address. diff --git a/gcloud/alpha/composer/environments/check-upgrade b/gcloud/alpha/composer/environments/check-upgrade index f54c2f934..1622dcfb6 100644 --- a/gcloud/alpha/composer/environments/check-upgrade +++ b/gcloud/alpha/composer/environments/check-upgrade @@ -61,6 +61,7 @@ FLAGS Upgrade the environment to a later Apache Airflow version in-place. Must be of the form X[.Y[.Z]], where [] denotes optional fragments. + Examples: 2, 2.3, 2.3.4. The Apache Airflow version is a semantic version or an alias in the form of major or major.minor version numbers, resolved to the latest @@ -76,6 +77,9 @@ FLAGS composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional fragments. + Examples: composer-2-airflow-2, composer-2-airflow-2.2, + composer-2.1.2-airflow-2.3.4. + The Cloud Composer portion of the image version is a semantic version or an alias in the form of major version number or latest, resolved to the current Cloud Composer version. The Apache Airflow portion of diff --git a/gcloud/alpha/composer/environments/create b/gcloud/alpha/composer/environments/create index 49e83888b..7e80168ce 100644 --- a/gcloud/alpha/composer/environments/create +++ b/gcloud/alpha/composer/environments/create @@ -6,7 +6,8 @@ SYNOPSIS gcloud alpha composer environments create (ENVIRONMENT : --location=LOCATION) [--airflow-configs=[KEY=VALUE,...]] [--async] [--cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE] - [--disk-size=DISK_SIZE] [--env-variables=[NAME=VALUE,...]] + [--disk-size=DISK_SIZE] [--enable-cloud-data-lineage-integration] + [--env-variables=[NAME=VALUE,...]] [--environment-size=ENVIRONMENT_SIZE] [--labels=[KEY=VALUE,...]] [--machine-type=MACHINE_TYPE] [--node-count=NODE_COUNT] [--oauth-scopes=[SCOPE,...]] [--python-version=PYTHON_VERSION] @@ -16,8 +17,8 @@ SYNOPSIS [--cloud-sql-ipv4-cidr=CLOUD_SQL_IPV4_CIDR --composer-network-ipv4-cidr=COMPOSER_NETWORK_IPV4_CIDR --connection-subnetwork=CONNECTION_SUBNETWORK - --enable-private-endpoint --enable-private-environment - --enable-privately-used-public-ips + --connection-type=CONNECTION_TYPE --enable-private-endpoint + --enable-private-environment --enable-privately-used-public-ips --master-ipv4-cidr=MASTER_IPV4_CIDR --web-server-ipv4-cidr=WEB_SERVER_IPV4_CIDR] [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR @@ -28,6 +29,12 @@ SYNOPSIS --services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME] [--enable-master-authorized-networks --master-authorized-networks=[NETWORK,...]] + [--enable-scheduled-snapshot-creation + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + --snapshot-location=SNAPSHOT_LOCATION + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE] + [--enable-triggerer + --triggerer-cpu=TRIGGERER_CPU --triggerer-memory=TRIGGERER_MEMORY] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [--maintenance-window-end=MAINTENANCE_WINDOW_END @@ -103,7 +110,9 @@ FLAGS complete. --cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE - Cloud SQL machine type used by the Airflow database. + Cloud SQL machine type used by the Airflow database. The list of + available machine types is available here: + https://cloud.google.com/composer/pricing#db-machine-types. --disk-size=DISK_SIZE The disk size for each VM node in the environment. The minimum size is @@ -111,6 +120,12 @@ FLAGS multiple of gigabytes. Cannot be updated after the environment has been created. If units are not provided, defaults to GB. + Group of arguments for setting Cloud Data Lineage integration + configuration in Composer 2. + + --enable-cloud-data-lineage-integration + Enable Cloud Data Lineage integration. + --env-variables=[NAME=VALUE,...] A comma-delimited list of environment variable NAME=VALUE pairs to provide to the Airflow scheduler, worker, and webserver processes. NAME @@ -180,6 +195,7 @@ FLAGS Version of Apache Airflow to run in the environment. Must be of the form `X[.Y[.Z]]`, where `[]` denotes optional fragments. + Examples: `2`, `2.3`, `2.3.4`. The current Cloud Composer version will be used within the created environment. The Apache Airflow version is a semantic version or an alias @@ -196,6 +212,9 @@ FLAGS `composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]]`, where `[]` denotes optional fragments. + Examples: `composer-2-airflow-2`, `composer-2-airflow-2.2`, + `composer-2.1.2-airflow-2.3.4`. + The Cloud Composer portion of the image version is a semantic version or an alias in the form of major version number or `latest`, resolved to the current Cloud Composer version. The Apache Airflow portion of the image @@ -229,6 +248,17 @@ FLAGS Can be specified for Composer 2.X or greater. Cannot be specified unless --enable-private-environment is also specified. + --connection-type=CONNECTION_TYPE + Mode of internal communication within the Composer environment. Must + be one of VPC_PEERING or PRIVATE_SERVICE_CONNECT. + + Can be specified for Composer 2.X or greater. Cannot be specified + unless --enable-private-environment is also specified. Cannot be set + to VPC_PEERING if --connection-subnetwork is also specified. + + CONNECTION_TYPE must be one of: connection-type-unspecified, + private-service-connect, vpc-peering. + --enable-private-endpoint Environment cluster is managed using the private IP address of the master API endpoint. Therefore access to the master endpoint must be @@ -246,7 +276,8 @@ FLAGS If not specified, cluster nodes will be assigned public IP addresses. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --enable-privately-used-public-ips When enabled GKE pods and services may use public(non-RFC1918) IP @@ -276,14 +307,16 @@ FLAGS IP address range for the pods in this cluster in CIDR notation (e.g. 10.0.0.0/14). - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --cluster-secondary-range-name=CLUSTER_SECONDARY_RANGE_NAME Secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --enable-ip-alias Enable use of alias IPs @@ -299,7 +332,8 @@ FLAGS node's IP address. This is done when sending traffic to destinations outside the cluster's pod CIDR range. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --max-pods-per-node=MAX_PODS_PER_NODE Maximum number of pods that can be assigned to a single node, can be @@ -318,13 +352,15 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME Secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. Master Authorized Networks configuration @@ -340,6 +376,55 @@ FLAGS Cannot be specified unless --enable-master-authorized-networks is also specified. + Group of arguments for setting scheduled snapshots settings in Composer + 2.0.32 or greater. + + --enable-scheduled-snapshot-creation + When specified, snapshots of the environment will be created + according to a schedule. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + Cron expression specifying when snapshots of the environment should + be created. Can be specified for Composer 2.0.32 or greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --snapshot-location=SNAPSHOT_LOCATION + The Cloud Storage location for storing automatically created + snapshots. Can be specified for Composer 2.0.32 or greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE + Timezone that sets the context to interpret + snapshot_creation_schedule. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Group of arguments for setting triggerer settings in Composer 2.0.31 or + greater. + + --enable-triggerer + Enable use of a triggerer, supported in the Environments with + Composer 2.0.31 and Airflow 2.2.5 and greater. + + --triggerer-cpu=TRIGGERER_CPU + CPU allocated to Airflow triggerer. Supported in the Environments + with Composer 2.0.31 and Airflow 2.2.5 and greater. + + --triggerer-memory=TRIGGERER_MEMORY + Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If units + are not provided, defaults to GB. Supported in the Environments with + Composer 2.0.31 and Airflow 2.2.5 and greater. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the environment. The 'Cloud Composer Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/alpha/composer/environments/help b/gcloud/alpha/composer/environments/help index 8b7c9e7d4..37294824f 100644 --- a/gcloud/alpha/composer/environments/help +++ b/gcloud/alpha/composer/environments/help @@ -22,7 +22,7 @@ GROUPS GROUP is one of the following: snapshots - (ALPHA) Saves and loads snapshots of environment. + (ALPHA) Save and load snapshots of environment. storage (ALPHA) Manage Cloud Storage objects stored as part of Cloud Composer diff --git a/gcloud/alpha/composer/environments/run b/gcloud/alpha/composer/environments/run index 6408e47d0..511ea7e89 100644 --- a/gcloud/alpha/composer/environments/run +++ b/gcloud/alpha/composer/environments/run @@ -64,16 +64,16 @@ POSITIONAL ARGUMENTS The Airflow CLI subcommand to run. Available subcommands include (listed with Airflow versions that support): backfill [**, 2.0.0), clear [**, 2.0.0), connections [**, 3.0.0), dag_state [**, 2.0.0), dags - [1.10.14, 3.0.0), delete_dag [1.10.1, 2.0.0), kerberos [**, 3.0.0), - kubernetes [2.1.4, 3.0.0), list_dag_runs [1.10.2, 2.0.0), list_dags - [**, 2.0.0), list_tasks [**, 2.0.0), next_execution [1.10.2, 2.0.0), - pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14, 3.0.0), render - [**, 2.0.0), roles [2.0.0, 3.0.0), run [**, 2.0.0), sync-perm [1.10.14, - 3.0.0), sync_perm [1.10.2, 2.0.0), task_failed_deps [**, 2.0.0), - task_state [**, 2.0.0), tasks [1.10.14, 3.0.0), test [**, 2.0.0), - trigger_dag [**, 2.0.0), unpause [**, 2.0.0), upgrade_check [1.10.15, - 2.0.0), users [1.10.14, 3.0.0), variables [**, 3.0.0), version [**, - 3.0.0) (see + [1.10.14, 3.0.0), db [2.3.0, 3.0.0), delete_dag [1.10.1, 2.0.0), + kerberos [**, 3.0.0), kubernetes [2.1.4, 3.0.0), list_dag_runs [1.10.2, + 2.0.0), list_dags [**, 2.0.0), list_tasks [**, 2.0.0), next_execution + [1.10.2, 2.0.0), pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14, + 3.0.0), render [**, 2.0.0), roles [2.0.0, 3.0.0), run [**, 2.0.0), + sync-perm [1.10.14, 3.0.0), sync_perm [1.10.2, 2.0.0), task_failed_deps + [**, 2.0.0), task_state [**, 2.0.0), tasks [1.10.14, 3.0.0), test [**, + 2.0.0), trigger_dag [**, 2.0.0), unpause [**, 2.0.0), upgrade_check + [1.10.15, 2.0.0), users [1.10.14, 3.0.0), variables [**, 3.0.0), + version [**, 3.0.0) (see https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html for more info). diff --git a/gcloud/alpha/composer/environments/snapshots/help b/gcloud/alpha/composer/environments/snapshots/help index a71e4d03e..55ae9bef9 100644 --- a/gcloud/alpha/composer/environments/snapshots/help +++ b/gcloud/alpha/composer/environments/snapshots/help @@ -1,5 +1,5 @@ NAME - gcloud alpha composer environments snapshots - saves and loads snapshots of + gcloud alpha composer environments snapshots - save and load snapshots of environment SYNOPSIS @@ -27,7 +27,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud composer environments snapshots $ gcloud beta composer environments snapshots diff --git a/gcloud/alpha/composer/environments/snapshots/load b/gcloud/alpha/composer/environments/snapshots/load index b04204e6c..91baacc88 100644 --- a/gcloud/alpha/composer/environments/snapshots/load +++ b/gcloud/alpha/composer/environments/snapshots/load @@ -5,7 +5,9 @@ NAME SYNOPSIS gcloud alpha composer environments snapshots load (ENVIRONMENT : --location=LOCATION) --snapshot-path=SNAPSHOT_PATH - [--async] [--skip-pypi-packages-installation] [GCLOUD_WIDE_FLAG ...] + [--async] [--skip-airflow-overrides-setting] + [--skip-environment-variables-setting] [--skip-gcs-data-copying] + [--skip-pypi-packages-installation] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Load a snapshot into the environment. @@ -55,6 +57,16 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --skip-airflow-overrides-setting + When specified, skips setting Airflow overrides from the snapshot. + + --skip-environment-variables-setting + When specified, skips setting environment variables from the snapshot. + + --skip-gcs-data-copying + When specified, skips copying dags, plugins and data folders from the + snapshot. + --skip-pypi-packages-installation When specified, skips the installation of custom PyPI packages from the snapshot. @@ -71,7 +83,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud composer environments snapshots load $ gcloud beta composer environments snapshots load diff --git a/gcloud/alpha/composer/environments/snapshots/save b/gcloud/alpha/composer/environments/snapshots/save index 2e630ba73..02351a1af 100644 --- a/gcloud/alpha/composer/environments/snapshots/save +++ b/gcloud/alpha/composer/environments/snapshots/save @@ -65,7 +65,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud composer environments snapshots save $ gcloud beta composer environments snapshots save diff --git a/gcloud/alpha/composer/environments/update b/gcloud/alpha/composer/environments/update index afebf389a..023d38810 100644 --- a/gcloud/alpha/composer/environments/update +++ b/gcloud/alpha/composer/environments/update @@ -9,9 +9,16 @@ SYNOPSIS | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE | --airflow-version=AIRFLOW_VERSION | --image-version=IMAGE_VERSION + | --disable-cloud-data-lineage-integration + | --enable-cloud-data-lineage-integration | --disable-master-authorized-networks --enable-master-authorized-networks --master-authorized-networks=[NETWORK,...] + | --disable-scheduled-snapshot-creation + | --enable-scheduled-snapshot-creation + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + --snapshot-location=SNAPSHOT_LOCATION + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE | --maintenance-window-end=MAINTENANCE_WINDOW_END --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE --maintenance-window-start=MAINTENANCE_WINDOW_START @@ -21,7 +28,10 @@ SYNOPSIS --scheduler-storage=SCHEDULER_STORAGE --web-server-cpu=WEB_SERVER_CPU --web-server-memory=WEB_SERVER_MEMORY --web-server-storage=WEB_SERVER_STORAGE --worker-cpu=WORKER_CPU - --worker-memory=WORKER_MEMORY --worker-storage=WORKER_STORAGE + --worker-memory=WORKER_MEMORY + --worker-storage=WORKER_STORAGE --disable-triggerer + | --enable-triggerer + --triggerer-cpu=TRIGGERER_CPU --triggerer-memory=TRIGGERER_MEMORY | --update-airflow-configs=[KEY=VALUE,...] --clear-airflow-configs | --remove-airflow-configs=[KEY,...] | --update-env-variables=[NAME=VALUE,...] --clear-env-variables @@ -79,7 +89,9 @@ REQUIRED FLAGS Exactly one of these must be specified: --cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE - Cloud SQL machine type used by the Airflow database. + Cloud SQL machine type used by the Airflow database. The list of + available machine types is available here: + https://cloud.google.com/composer/pricing#db-machine-types. --environment-size=ENVIRONMENT_SIZE Size of the environment. Unspecified means that the default option @@ -102,6 +114,7 @@ REQUIRED FLAGS Upgrade the environment to a later Apache Airflow version in-place. Must be of the form X[.Y[.Z]], where [] denotes optional fragments. + Examples: 2, 2.3, 2.3.4. The Apache Airflow version is a semantic version or an alias in the form of major or major.minor version numbers, resolved to the @@ -117,6 +130,9 @@ REQUIRED FLAGS composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional fragments. + Examples: composer-2-airflow-2, composer-2-airflow-2.2, + composer-2.1.2-airflow-2.3.4. + The Cloud Composer portion of the image version is a semantic version or an alias in the form of major version number or latest, resolved to the current Cloud Composer version. The Apache Airflow @@ -126,6 +142,17 @@ REQUIRED FLAGS Composer version. The resolved versions are stored in the upgraded environment. + Group of arguments for setting Cloud Data Lineage integration + configuration in Composer 2. + + At most one of these can be specified: + + --disable-cloud-data-lineage-integration + Disable Cloud Data Lineage integration. + + --enable-cloud-data-lineage-integration + Enable Cloud Data Lineage integration. + Group of arguments for setting master authorized networks configuration. --disable-master-authorized-networks @@ -145,6 +172,49 @@ REQUIRED FLAGS Cannot be specified unless --enable-master-authorized-networks is also specified. + Group of arguments used during update of scheduled snapshots settings in + Composer 2.0.32 or greater. + + At most one of these can be specified: + + --disable-scheduled-snapshot-creation + Disables automated snapshots creation. Can be specified for + Composer 2.0.32 or greater. + + Group of arguments for setting scheduled snapshots settings in + Composer 2.0.32 or greater. + + --enable-scheduled-snapshot-creation + When specified, snapshots of the environment will be created + according to a schedule. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + Cron expression specifying when snapshots of the environment + should be created. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --snapshot-location=SNAPSHOT_LOCATION + The Cloud Storage location for storing automatically created + snapshots. Can be specified for Composer 2.0.32 or greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE + Timezone that sets the context to interpret + snapshot_creation_schedule. Can be specified for Composer 2.0.32 + or greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + Group of arguments for setting the maintenance window value. --maintenance-window-end=MAINTENANCE_WINDOW_END @@ -223,6 +293,33 @@ REQUIRED FLAGS Storage allocated to Airflow worker, ex. 600MB, 3GB, 2. If units are not provided, defaults to GB. + Group of arguments for setting triggerer settings in Composer 2.0.31 + or greater. + + At most one of these can be specified: + + --disable-triggerer + Disable a triggerer, supported in the Environments with Composer + 2.0.31 and Airflow 2.2.5 and greater. + + Group of arguments for setting triggerer settings during update in + Composer 2.0.31 or greater. + + --enable-triggerer + Enable use of a triggerer, supported in the Environments with + Composer 2.0.31 and Airflow 2.2.5 and greater. + + --triggerer-cpu=TRIGGERER_CPU + CPU allocated to Airflow triggerer. Supported in the + Environments with Composer 2.0.31 and Airflow 2.2.5 and + greater. + + --triggerer-memory=TRIGGERER_MEMORY + Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If + units are not provided, defaults to GB. Supported in the + Environments with Composer 2.0.31 and Airflow 2.2.5 and + greater. + Group of arguments for modifying the Airflow configuration. --update-airflow-configs=[KEY=VALUE,...] diff --git a/gcloud/alpha/compute/addresses/config/export b/gcloud/alpha/compute/addresses/config/export index 001c74c2d..3246dad91 100644 --- a/gcloud/alpha/compute/addresses/config/export +++ b/gcloud/alpha/compute/addresses/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/addresses/create b/gcloud/alpha/compute/addresses/create index 2c79c6f7c..2fa507ea7 100644 --- a/gcloud/alpha/compute/addresses/create +++ b/gcloud/alpha/compute/addresses/create @@ -74,7 +74,7 @@ FLAGS --endpoint-type=ENDPOINT_TYPE The endpoint type of the external IPv6 address to be reserved. - Currently it can only be 'VM'. ENDPOINT_TYPE must be one of: VM, NETLB. + ENDPOINT_TYPE must be one of: VM, NETLB. --network=NETWORK If specified, the network resource in which the address(es) should be diff --git a/gcloud/alpha/compute/backend-buckets/add-iam-policy-binding b/gcloud/alpha/compute/backend-buckets/add-iam-policy-binding new file mode 100644 index 000000000..2cf3392d4 --- /dev/null +++ b/gcloud/alpha/compute/backend-buckets/add-iam-policy-binding @@ -0,0 +1,81 @@ +NAME + gcloud alpha compute backend-buckets add-iam-policy-binding - add an IAM + policy binding to a Compute Engine backend bucket + +SYNOPSIS + gcloud alpha compute backend-buckets add-iam-policy-binding BACKEND_BUCKET + --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add an IAM policy binding to a Compute Engine backend bucket. + +EXAMPLES + To add an IAM policy binding for the role of + 'compute.loadBalancerServiceUser' for the user 'test-user@gmail.com' with + backend bucket 'my-backend-bucket' run: + + $ gcloud alpha compute backend-buckets add-iam-policy-binding \ + my-backend-bucket --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket for which to add the IAM + policy 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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. + +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 compute/alpha API. The full documentation for this + API can be found at: https://cloud.google.com/compute/ + +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 compute backend-buckets add-iam-policy-binding + diff --git a/gcloud/alpha/compute/backend-buckets/config/export b/gcloud/alpha/compute/backend-buckets/config/export index b37b9ac87..2b0bafff8 100644 --- a/gcloud/alpha/compute/backend-buckets/config/export +++ b/gcloud/alpha/compute/backend-buckets/config/export @@ -65,7 +65,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/backend-buckets/get-iam-policy b/gcloud/alpha/compute/backend-buckets/get-iam-policy new file mode 100644 index 000000000..4fa44e7e0 --- /dev/null +++ b/gcloud/alpha/compute/backend-buckets/get-iam-policy @@ -0,0 +1,86 @@ +NAME + gcloud alpha compute backend-buckets get-iam-policy - get the IAM policy + for a Compute Engine backend bucket + +SYNOPSIS + gcloud alpha compute backend-buckets get-iam-policy BACKEND_BUCKET + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute backend-buckets get-iam-policy displays the + IAM policy associated with a Compute Engine backend bucket in a project. 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 $ {parent} + set-iam-policy for additional details. + +EXAMPLES + To print the IAM policy for a given backend bucket, run: + + $ gcloud alpha compute backend-buckets get-iam-policy \ + my-backend-bucket + +POSITIONAL ARGUMENTS + Backend bucket resource - The network to display the IAM policy for. 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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. + +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 compute/alpha API. The full documentation for this + API can be found at: https://cloud.google.com/compute/ + +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 compute backend-buckets get-iam-policy + diff --git a/gcloud/alpha/compute/backend-buckets/help b/gcloud/alpha/compute/backend-buckets/help index 968a80207..91598d0fc 100644 --- a/gcloud/alpha/compute/backend-buckets/help +++ b/gcloud/alpha/compute/backend-buckets/help @@ -30,6 +30,9 @@ GROUPS COMMANDS COMMAND is one of the following: + add-iam-policy-binding + (ALPHA) Add an IAM policy binding to a Compute Engine backend bucket. + add-signed-url-key (ALPHA) Add Cloud CDN Signed URL key to a backend bucket. @@ -45,9 +48,19 @@ COMMANDS describe (ALPHA) Describe a backend bucket. + get-iam-policy + (ALPHA) Get the IAM policy for a Compute Engine backend bucket. + list (ALPHA) List Google Compute Engine backend buckets. + remove-iam-policy-binding + (ALPHA) Remove an IAM policy binding from a Compute Engine backend + bucket. + + set-iam-policy + (ALPHA) Set the IAM policy binding for a Compute Engine backend bucket. + update (ALPHA) Update a backend bucket. diff --git a/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding b/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding new file mode 100644 index 000000000..4d353e5ae --- /dev/null +++ b/gcloud/alpha/compute/backend-buckets/remove-iam-policy-binding @@ -0,0 +1,82 @@ +NAME + gcloud alpha compute backend-buckets remove-iam-policy-binding - remove an + IAM policy binding from a Compute Engine backend bucket + +SYNOPSIS + gcloud alpha compute backend-buckets remove-iam-policy-binding + BACKEND_BUCKET --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Remove an IAM policy binding from a Compute Engine backend bucket. + +EXAMPLES + To remove an IAM policy binding for the role of + 'roles/compute.loadBalancerServiceUser' for the user 'test-user@gmail.com' + with backend bucket 'my-backend-bucket' run: + + $ gcloud alpha compute backend-buckets remove-iam-policy-binding \ + my-backend-bucket --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket for which to remove the IAM + policy from. 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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. + +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 compute/alpha API. The full documentation for this + API can be found at: https://cloud.google.com/compute/ + +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 compute backend-buckets remove-iam-policy-binding + diff --git a/gcloud/alpha/compute/backend-buckets/set-iam-policy b/gcloud/alpha/compute/backend-buckets/set-iam-policy new file mode 100644 index 000000000..89c7d8cc2 --- /dev/null +++ b/gcloud/alpha/compute/backend-buckets/set-iam-policy @@ -0,0 +1,67 @@ +NAME + gcloud alpha compute backend-buckets set-iam-policy - set the IAM policy + binding for a Compute Engine backend bucket + +SYNOPSIS + gcloud alpha compute backend-buckets set-iam-policy BACKEND_BUCKET + POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Sets the IAM policy for the given backend bucket as defined in a + JSON or YAML file. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file called + 'policy.json' and sets it for the backend bucket called + 'my-backend-bucket': + + $ gcloud alpha compute backend-buckets set-iam-policy \ + my-backend-bucket policy.json + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket to set the IAM policy for. + 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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). + +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 compute/alpha API. The full documentation for this + API can be found at: https://cloud.google.com/compute/ + +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 compute backend-buckets set-iam-policy + diff --git a/gcloud/alpha/compute/backend-services/add-iam-policy-binding b/gcloud/alpha/compute/backend-services/add-iam-policy-binding index f628af7b2..005b9e2aa 100644 --- a/gcloud/alpha/compute/backend-services/add-iam-policy-binding +++ b/gcloud/alpha/compute/backend-services/add-iam-policy-binding @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud alpha compute backend-services add-iam-policy-binding - (BACKEND_SERVICE : --region=REGION) --member=PRINCIPAL --role=ROLE - [GCLOUD_WIDE_FLAG ...] + BACKEND_SERVICE_NAME --member=PRINCIPAL --role=ROLE + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Add an IAM policy binding to a Compute Engine backend service. @@ -16,41 +16,21 @@ EXAMPLES backend service 'my-backend-service' and region 'REGION', run: $ gcloud alpha compute backend-services add-iam-policy-binding \ - my-backend-service --region=REGION \ - --member='user:test-user@gmail.com' \ - --role='roles/compute.loadBalancerServiceUser' + my-backend-service --region=REGION \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + $ gcloud alpha compute backend-services add-iam-policy-binding \ + my-backend-service --global \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' See https://cloud.google.com/iam/docs/managing-policies for details of policy role and member types. POSITIONAL ARGUMENTS - Backend service resource - The backend service for which to add the IAM - policy to. 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. REQUIRED FLAGS --member=PRINCIPAL @@ -73,6 +53,16 @@ REQUIRED FLAGS for a custom role, such as organizations/{ORGANIZATION_ID}/roles/logging.viewer. +OPTIONAL FLAGS + At most one of these can be specified: + + --global + If set, the backend service is global. + + --region=REGION + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -81,10 +71,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/alpha API. The full documentation for this - API can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/compute/backend-services/get-iam-policy b/gcloud/alpha/compute/backend-services/get-iam-policy index 58d4aa144..4e8b7bd4f 100644 --- a/gcloud/alpha/compute/backend-services/get-iam-policy +++ b/gcloud/alpha/compute/backend-services/get-iam-policy @@ -3,9 +3,9 @@ NAME for a Compute Engine backend service SYNOPSIS - gcloud alpha compute backend-services get-iam-policy - (BACKEND_SERVICE : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + gcloud alpha compute backend-services get-iam-policy BACKEND_SERVICE_NAME + [--global | --region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -22,33 +22,22 @@ EXAMPLES $ gcloud alpha compute backend-services get-iam-policy \ my-backend-service --region=REGION + $ gcloud alpha compute backend-services get-iam-policy \ + my-backend-service --global + POSITIONAL ARGUMENTS - Backend service resource - The network to display the IAM policy for. 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. - This must be specified. +FLAGS + At most one of these can be specified: - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. + --global + If set, the backend service is global. --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. LIST COMMAND FLAGS --filter=EXPRESSION @@ -76,6 +65,12 @@ LIST COMMAND FLAGS 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, @@ -84,10 +79,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/alpha API. The full documentation for this - API can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/compute/backend-services/remove-iam-policy-binding b/gcloud/alpha/compute/backend-services/remove-iam-policy-binding index 0d3a63c66..8f3a84caa 100644 --- a/gcloud/alpha/compute/backend-services/remove-iam-policy-binding +++ b/gcloud/alpha/compute/backend-services/remove-iam-policy-binding @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud alpha compute backend-services remove-iam-policy-binding - (BACKEND_SERVICE : --region=REGION) --member=PRINCIPAL --role=ROLE - [GCLOUD_WIDE_FLAG ...] + BACKEND_SERVICE_NAME --member=PRINCIPAL --role=ROLE + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Remove an IAM policy binding from a Compute Engine backend service. @@ -16,41 +16,21 @@ EXAMPLES with backend service 'my-backend-service' and region 'REGION', run: $ gcloud alpha compute backend-services remove-iam-policy-binding \ - my-backend-service --region=REGION \ - --member='user:test-user@gmail.com' \ - --role='roles/compute.loadBalancerServiceUser' + my-backend-service --region=REGION \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + $ gcloud alpha compute backend-services remove-iam-policy-binding \ + my-backend-service --global \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' See https://cloud.google.com/iam/docs/managing-policies for details of policy role and member types. POSITIONAL ARGUMENTS - Backend service resource - The backend service for which to remove the IAM - policy from. 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. REQUIRED FLAGS --member=PRINCIPAL @@ -74,6 +54,16 @@ REQUIRED FLAGS --role=ROLE The role to remove the principal from. +OPTIONAL FLAGS + At most one of these can be specified: + + --global + If set, the backend service is global. + + --region=REGION + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -82,10 +72,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/alpha API. The full documentation for this - API can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/compute/backend-services/set-iam-policy b/gcloud/alpha/compute/backend-services/set-iam-policy index f376c3c27..20dfc21ef 100644 --- a/gcloud/alpha/compute/backend-services/set-iam-policy +++ b/gcloud/alpha/compute/backend-services/set-iam-policy @@ -3,50 +3,29 @@ NAME binding for a Compute Engine backend service SYNOPSIS - gcloud alpha compute backend-services set-iam-policy - (BACKEND_SERVICE : --region=REGION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] + gcloud alpha compute backend-services set-iam-policy BACKEND_SERVICE_NAME + POLICY_FILE [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Sets the IAM policy for the given backend service as defined in a JSON or YAML file. EXAMPLES - The following command will read am IAM policy defined in a JSON file + The following command will read an IAM policy defined in a JSON file 'policy.json' and set it for the backend service my-backend-service: $ gcloud alpha compute backend-services set-iam-policy \ my-backend-service policy.json --region=REGION + $ gcloud alpha compute backend-services set-iam-policy \ + my-backend-service policy.json --global + See https://cloud.google.com/iam/docs/managing-policies for details of the policy file format and contents. POSITIONAL ARGUMENTS - Backend service resource - The backend service to set the IAM policy for. - 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. POLICY_FILE Path to a local JSON or YAML formatted file containing a valid policy. @@ -55,6 +34,16 @@ POSITIONAL ARGUMENTS JSON or YAML file conforming to the structure of a Policy (https://cloud.google.com/iam/reference/rest/v1/Policy). +FLAGS + At most one of these can be specified: + + --global + If set, the backend service is global. + + --region=REGION + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -63,10 +52,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/alpha API. The full documentation for this - API can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index cdf7aa50d..713c44105 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -68,7 +68,8 @@ OPTIONAL FLAGS Enable auto renewal for the commitment. --merge-source-commitments=MERGE_SOURCE_COMMITMENTS - Merge the resources of two or more commitments into one new commitment. + Creates the new commitment by merging the specified source commitments + and combining their resources. --region=REGION Region of the commitment to create. If not specified, you might be @@ -91,7 +92,8 @@ OPTIONAL FLAGS CLOUDSDK_COMPUTE_REGION. --split-source-commitment=SPLIT_SOURCE_COMMITMENT - Split the resources of previous commitment into a new commitment. + Creates the new commitment by splitting the specified source commitment + and redistributing the specified resources. --type=TYPE; default="general-purpose" Type of commitment. memory-optimized indicates that the commitment is diff --git a/gcloud/alpha/compute/disks/bulk/create b/gcloud/alpha/compute/disks/bulk/create new file mode 100644 index 000000000..95d12c6de --- /dev/null +++ b/gcloud/alpha/compute/disks/bulk/create @@ -0,0 +1,89 @@ +NAME + gcloud alpha compute disks bulk create - create multiple Compute Engine + disks + +SYNOPSIS + gcloud alpha compute disks bulk create + --source-consistency-group-policy=SOURCE_CONSISTENCY_GROUP_POLICY + (--region=REGION | --zone=ZONE) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute disks bulk create facilitates the creation of + multiple Compute Engine disks with a single command. Currently, this + includes the ability to consistently clone a set of Async PD secondary + disks with the same consistency group policy. + +EXAMPLES + To consistently clone secondary disks with the same consistency group + policy + 'projects/example-project/regions/us-central1/resourcePolicies/example-group-policy' + to target zone 'us-central1-a', run: + + $ gcloud alpha compute disks bulk create \ + --source-consistency-group-policy=projects/example-project/\ + regions/us-central1/resourcePolicies/example-group-policy \ + --zone=us-central1-a + +REQUIRED FLAGS + --source-consistency-group-policy=SOURCE_CONSISTENCY_GROUP_POLICY + URL of the source consistency group resource policy. The resource + policy is always in the region of the source disks. + + Exactly one of these must be specified: + + --region=REGION + Target region of the created disks, which currently must be the same + as the source region. If not specified, you might be prompted to + select a region (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/region property: + + $ gcloud config set compute/region REGION + + A list of regions can be fetched by running: + + $ gcloud compute regions list + + To unset the property, run: + + $ gcloud config unset compute/region + + Alternatively, the region can be stored in the environment variable + CLOUDSDK_COMPUTE_REGION. + + --zone=ZONE + Target zone of the created disks, which currently must be the same as + the source zone. If not specified and the compute/zone property isn't + set, you might be prompted to select a zone (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/zone property: + + $ gcloud config set compute/zone ZONE + + A list of zones can be fetched by running: + + $ gcloud compute zones list + + To unset the property, run: + + $ gcloud config unset compute/zone + + Alternatively, the zone can be stored in the environment variable + CLOUDSDK_COMPUTE_ZONE. + +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. + diff --git a/gcloud/alpha/compute/disks/bulk/help b/gcloud/alpha/compute/disks/bulk/help new file mode 100644 index 000000000..f031fe254 --- /dev/null +++ b/gcloud/alpha/compute/disks/bulk/help @@ -0,0 +1,28 @@ +NAME + gcloud alpha compute disks bulk - manipulate multiple Compute Engine disks + with single command executions + +SYNOPSIS + gcloud alpha compute disks bulk COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manipulate multiple Compute Engine disks with single command + executions. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create multiple Compute Engine disks. + +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. + diff --git a/gcloud/alpha/compute/disks/config/export b/gcloud/alpha/compute/disks/config/export index 125c74196..3dcc594e5 100644 --- a/gcloud/alpha/compute/disks/config/export +++ b/gcloud/alpha/compute/disks/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/disks/create b/gcloud/alpha/compute/disks/create index b7354172f..e653e2547 100644 --- a/gcloud/alpha/compute/disks/create +++ b/gcloud/alpha/compute/disks/create @@ -21,11 +21,12 @@ SYNOPSIS | --source-snapshot=SOURCE_SNAPSHOT] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] - [--primary-disk-region=PRIMARY_DISK_REGION - | --primary-disk-zone=PRIMARY_DISK_ZONE] [--region=REGION | --zone=ZONE] [--source-disk-region=SOURCE_DISK_REGION - | --source-disk-zone=SOURCE_DISK_ZONE] [GCLOUD_WIDE_FLAG ...] + | --source-disk-zone=SOURCE_DISK_ZONE] + [--primary-disk-project=PRIMARY_DISK_PROJECT] + [--primary-disk-region=PRIMARY_DISK_REGION + | --primary-disk-zone=PRIMARY_DISK_ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute disks create creates one or more Compute @@ -83,13 +84,12 @@ FLAGS https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot#--guest-flush --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - one of: BARE_METAL_LINUX_COMPATIBLE, GVNIC, MULTI_IP_SUBNET, - SEV_CAPABLE, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, UEFI_COMPATIBLE, - VIRTIO_SCSI_MULTIQUEUE, WINDOWS. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be one of: BARE_METAL_LINUX_COMPATIBLE, GVNIC, + MULTI_IP_SUBNET, SEV_CAPABLE, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, + UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS. --interface=INTERFACE Specifies the disk interface to use for attaching this disk. Valid @@ -273,18 +273,6 @@ FLAGS ▸ provide the argument --kms-project on the command line; ▸ set the property core/project. - At most one of these can be specified: - - --primary-disk-region=PRIMARY_DISK_REGION - Region of the primary disk for asynchronous replication. The primary - and secondary disks must not be in the same region. Overrides the - default compute/region property value for this command invocation. - - --primary-disk-zone=PRIMARY_DISK_ZONE - Zone of the primary disk for asynchronous replication. The primary - and secondary disks must not be in the same region. Overrides the - default compute/zone property value for this command invocation. - At most one of these can be specified: --region=REGION @@ -340,6 +328,22 @@ FLAGS disk is in the same zone as the source disk. Overrides the default compute/zone property value for this command invocation. +ASYNC PD FLAGS + --primary-disk-project=PRIMARY_DISK_PROJECT + Project of the primary disk for asynchronous replication. + + At most one of these can be specified: + + --primary-disk-region=PRIMARY_DISK_REGION + Region of the primary disk for asynchronous replication. The primary + and secondary disks must not be in the same region. Overrides the + default compute/region property value for this command invocation. + + --primary-disk-zone=PRIMARY_DISK_ZONE + Zone of the primary disk for asynchronous replication. The primary + and secondary disks must not be in the same region. Overrides the + default compute/zone property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/compute/disks/help b/gcloud/alpha/compute/disks/help index 522f41455..551848dfc 100644 --- a/gcloud/alpha/compute/disks/help +++ b/gcloud/alpha/compute/disks/help @@ -21,6 +21,10 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + bulk + (ALPHA) Manipulate multiple Compute Engine disks with single command + executions. + config (ALPHA) Manage Compute Engine disk configurations. diff --git a/gcloud/alpha/compute/disks/start-async-replication b/gcloud/alpha/compute/disks/start-async-replication index 0c10ffaa9..a07d4416b 100644 --- a/gcloud/alpha/compute/disks/start-async-replication +++ b/gcloud/alpha/compute/disks/start-async-replication @@ -5,6 +5,7 @@ NAME SYNOPSIS gcloud alpha compute disks start-async-replication DISK_NAME --secondary-disk=SECONDARY_DISK [--region=REGION | --zone=ZONE] + [--secondary-disk-project=SECONDARY_DISK_PROJECT] [--secondary-disk-region=SECONDARY_DISK_REGION | --secondary-disk-zone=SECONDARY_DISK_ZONE] [GCLOUD_WIDE_FLAG ...] @@ -29,11 +30,9 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --secondary-disk=SECONDARY_DISK Secondary disk for asynchronous replication. This flag is required when - starting replication. It is also required when stopping replication on - the primary disk. It must not be used when stopping replication on the - secondary disk. + starting replication. -OPTIONAL FLAGS +FLAGS At most one of these can be specified: --region=REGION @@ -77,6 +76,10 @@ OPTIONAL FLAGS Alternatively, the zone can be stored in the environment variable CLOUDSDK_COMPUTE_ZONE. +SECONDARY DISK FLAGS + --secondary-disk-project=SECONDARY_DISK_PROJECT + Project of the secondary disk for asynchronous replication. + At most one of these can be specified: --secondary-disk-region=SECONDARY_DISK_REGION diff --git a/gcloud/alpha/compute/disks/stop-async-replication b/gcloud/alpha/compute/disks/stop-async-replication index 245f7757b..769ebfcb8 100644 --- a/gcloud/alpha/compute/disks/stop-async-replication +++ b/gcloud/alpha/compute/disks/stop-async-replication @@ -11,20 +11,15 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha compute disks stop-async-replication stops async replication on a Compute Engine persistent disk. This command can be - invoked either on the primary or on the secondary disk. If stop replication - is invoked on the primary disk, --secondary-disk and one of - --secondary-disk-zone or secondary-disk-region must be provided. + invoked either on the primary or on the secondary disk. EXAMPLES - When stopping async replication, be sure to include the --zone or --region - option. To stop replication between primary disk 'my-disk-1' in zone - us-east1-a and secondary disk 'my-disk-2' in us-west1-a: + Stop replication on the primary disk 'my-disk-1' in zone us-east1-a: $ gcloud alpha compute disks stop-async-replication my-disk-1 \ - --zone=us-east1-a --secondary-disk=my-disk-2 \ - --secondary-disk-zone=us-west1-a + --zone=us-east1-a - Alternatively, you can stop replication from the secondary disk: + Stop replication on the secondary disk 'my-disk-2' in zone us-west1-a: $ gcloud alpha compute disks stop-async-replication my-disk-2 \ --zone=us-west1-a @@ -35,10 +30,9 @@ POSITIONAL ARGUMENTS FLAGS --secondary-disk=SECONDARY_DISK - Secondary disk for asynchronous replication. This flag is required when - starting replication. It is also required when stopping replication on - the primary disk. It must not be used when stopping replication on the - secondary disk. + (DEPRECATED) Secondary disk for asynchronous replication. + + Flag --secondary-disk is deprecated. At most one of these can be specified: @@ -86,13 +80,15 @@ FLAGS At most one of these can be specified: --secondary-disk-region=SECONDARY_DISK_REGION - Region of the secondary disk for asynchronous replication. Overrides - the default compute/region property value for this command - invocation. + (DEPRECATED) Region of the secondary disk for asynchronous + replication. + + Flag --secondary-disk-zone is deprecated. --secondary-disk-zone=SECONDARY_DISK_ZONE - Zone of the secondary disk for asynchronous replication. Overrides - the default compute/zone property value for this command invocation. + (DEPRECATED) Zone of the secondary disk for asynchronous replication. + + Flag --secondary-disk-zone is deprecated. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/compute/firewall-policies/rules/create b/gcloud/alpha/compute/firewall-policies/rules/create index 7152a6cd8..428bfdc03 100644 --- a/gcloud/alpha/compute/firewall-policies/rules/create +++ b/gcloud/alpha/compute/firewall-policies/rules/create @@ -58,8 +58,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if @@ -99,8 +98,7 @@ OPTIONAL FLAGS is ingress. --src-ip-ranges=[SRC_IP_RANGE,...] - Source IP ranges to match for this rule. Can only be specified if - DIRECTION is ingress. + Source IP ranges to match for this rule. --src-region-codes=[SOURCE_REGION_CODES,...] Source Region Code to match for this rule. Can only be specified if diff --git a/gcloud/alpha/compute/firewall-policies/rules/update b/gcloud/alpha/compute/firewall-policies/rules/update index 4865594e9..74212ea16 100644 --- a/gcloud/alpha/compute/firewall-policies/rules/update +++ b/gcloud/alpha/compute/firewall-policies/rules/update @@ -60,8 +60,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if @@ -104,8 +103,7 @@ OPTIONAL FLAGS is ingress. --src-ip-ranges=[SRC_IP_RANGE,...] - Source IP ranges to match for this rule. Can only be specified if - DIRECTION is ingress. + Source IP ranges to match for this rule. --src-region-codes=[SOURCE_REGION_CODES,...] Source Region Code to match for this rule. Can only be specified if diff --git a/gcloud/alpha/compute/firewall-rules/config/export b/gcloud/alpha/compute/firewall-rules/config/export index 1a71f1b58..ba8df8a7d 100644 --- a/gcloud/alpha/compute/firewall-rules/config/export +++ b/gcloud/alpha/compute/firewall-rules/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/firewall-rules/create b/gcloud/alpha/compute/firewall-rules/create index 419f07f7f..68461b515 100644 --- a/gcloud/alpha/compute/firewall-rules/create +++ b/gcloud/alpha/compute/firewall-rules/create @@ -24,7 +24,7 @@ DESCRIPTION EXAMPLES To create a firewall rule allowing incoming TCP traffic on port 8080, run: - $ gcloud alpha compute firewall-rules create FooService \ + $ gcloud alpha compute firewall-rules create example-service \ --allow=tcp:8080 \ --description="Allow incoming traffic on TCP port 8080" \ --direction=INGRESS @@ -33,7 +33,7 @@ EXAMPLES determines a list of specific IP address blocks that are allowed to make inbound connections, run: - $ gcloud alpha compute firewall-rules create "tcp-rule" \ + $ gcloud alpha compute firewall-rules create tcp-rule \ --allow=tcp:80 --source-ranges="10.0.0.0/22,10.0.0.0/14" \ --description="Narrowing TCP traffic" diff --git a/gcloud/alpha/compute/forwarding-rules/config/export b/gcloud/alpha/compute/forwarding-rules/config/export index 6f34a1c92..36acc0b87 100644 --- a/gcloud/alpha/compute/forwarding-rules/config/export +++ b/gcloud/alpha/compute/forwarding-rules/config/export @@ -86,7 +86,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/forwarding-rules/create b/gcloud/alpha/compute/forwarding-rules/create index 46bacb139..81cb23456 100644 --- a/gcloud/alpha/compute/forwarding-rules/create +++ b/gcloud/alpha/compute/forwarding-rules/create @@ -13,9 +13,10 @@ SYNOPSIS | --target-service-attachment=TARGET_SERVICE_ATTACHMENT | --target-ssl-proxy=TARGET_SSL_PROXY | --target-tcp-proxy=TARGET_TCP_PROXY - | --target-vpn-gateway=TARGET_VPN_GATEWAY) [--allow-global-access] - [--allow-psc-global-access] [--description=DESCRIPTION] - [--disable-automate-dns-zone] [--ip-protocol=IP_PROTOCOL] + | --target-vpn-gateway=TARGET_VPN_GATEWAY) [--address=ADDRESS] + [--allow-global-access] [--allow-psc-global-access] + [--description=DESCRIPTION] [--disable-automate-dns-zone] + [--ip-protocol=IP_PROTOCOL] [--ip-version=IP_VERSION] [--is-mirroring-collector] [--load-balancing-scheme=LOAD_BALANCING_SCHEME] [--network=NETWORK] [--network-tier=NETWORK_TIER] @@ -27,7 +28,6 @@ SYNOPSIS [--target-pool-region=TARGET_POOL_REGION] [--target-service-attachment-region=TARGET_SERVICE_ATTACHMENT_REGION] [--target-vpn-gateway-region=TARGET_VPN_GATEWAY_REGION] - [--address=ADDRESS | --ip-version=IP_VERSION] [--address-region=ADDRESS_REGION | --global-address] [--backend-service-region=BACKEND_SERVICE_REGION | --global-backend-service] [--global | --region=REGION] @@ -168,11 +168,37 @@ REQUIRED FLAGS forwarded traffic. Acceptable values for --ports flag are: 500, 4500. OPTIONAL FLAGS + --address=ADDRESS + The IP address that the forwarding rule serves. When a client sends + traffic to this IP address, the forwarding rule directs the traffic to + the target that you specify in the forwarding rule. + + If you don't specify a reserved IP address, an ephemeral IP address is + assigned. You can specify the IP address as a literal IP address or as + a reference to an existing Address resource. The following examples are + all valid: + ◆ 100.1.2.3 + ◆ 2600:1901::/96 + ◆ https://compute.googleapis.com/compute/v1/projects/project-1/regions/us-central1/addresses/address-1 + ◆ projects/project-1/regions/us-central1/addresses/address-1 + ◆ regions/us-central1/addresses/address-1 + ◆ global/addresses/address-1 + ◆ address-1 + + The load-balancing-scheme (EXTERNAL, EXTERNAL_MANAGED, INTERNAL, + INTERNAL_SELF_MANAGED, INTERNAL_MANAGED) and the target of the + forwarding rule determine the type of IP address that you can use. The + address type must be external for load-balancing-scheme EXTERNAL or + EXTERNAL_MANAGED. For other load-balancing-schemes, the address type + must be internal. For detailed information, refer to + https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications. + --allow-global-access If True, then clients from all regions can access this internal forwarding rule. This can only be specified for forwarding rules with - the LOAD_BALANCING_SCHEME set to INTERNAL and the target must be either - a backend service or a target instance. + the LOAD_BALANCING_SCHEME set to INTERNAL or INTERNAL_MANAGED. For + forwarding rules of type INTERNAL, the target must be either a backend + service or a target instance. --allow-psc-global-access If specified, then clients from all regions can access this Private @@ -202,6 +228,10 @@ OPTIONAL FLAGS IP_PROTOCOL must be one of: AH, ESP, ICMP, SCTP, TCP, UDP, L3_DEFAULT, ALL. + --ip-version=IP_VERSION + Version of the IP address to be allocated or assigned. The default is + IPv4. IP_VERSION must be one of: IPV4, IPV6. + --is-mirroring-collector If set, this forwarding rule can be used as a collector for packet mirroring. This can only be specified for forwarding rules with the @@ -310,36 +340,6 @@ OPTIONAL FLAGS is set to the region of the forwarding rule. Overrides the default compute/region property value for this command invocation. - At most one of these can be specified: - - --address=ADDRESS - IP address that the forwarding rule serves. When a client sends - traffic to this IP address, the forwarding rule directs the traffic - to the target that you specify in the forwarding rule. - - If you don't specify a reserved IP address, an ephemeral IP address - is assigned. You can specify the IP address as a literal IP address - or a reference to an existing Address resource. The following - examples are all valid: - ▸ 100.1.2.3 - ▸ https://compute.googleapis.com/compute/v1/projects/project-1/regions/us-central1/addresses/address-1 - ▸ projects/project-1/regions/us-central1/addresses/address-1 - ▸ regions/us-central1/addresses/address-1 - ▸ global/addresses/address-1 - ▸ address-1 - - The load-balancing-scheme (EXTERNAL, EXTERNAL_MANAGED, INTERNAL, - INTERNAL_SELF_MANAGED, INTERNAL_MANAGED) and the forwarding rule's - target determine the type of IP address that you can use. The address - type must be external for load-balancing-scheme EXTERNAL or - EXTERNAL_MANAGED, and for the other load-balancing-schemes the - address must be internal. For detailed information, refer to - https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications. - - --ip-version=IP_VERSION - Version of the IP address to be allocated if no --address is given. - The default is IPv4. IP_VERSION must be one of: IPV4, IPV6. - At most one of these can be specified: --address-region=ADDRESS_REGION diff --git a/gcloud/alpha/compute/forwarding-rules/update b/gcloud/alpha/compute/forwarding-rules/update index 08a296db8..9e7106f75 100644 --- a/gcloud/alpha/compute/forwarding-rules/update +++ b/gcloud/alpha/compute/forwarding-rules/update @@ -44,8 +44,9 @@ FLAGS --allow-global-access If True, then clients from all regions can access this internal forwarding rule. This can only be specified for forwarding rules with - the LOAD_BALANCING_SCHEME set to INTERNAL and the target must be either - a backend service or a target instance. + the LOAD_BALANCING_SCHEME set to INTERNAL or INTERNAL_MANAGED. For + forwarding rules of type INTERNAL, the target must be either a backend + service or a target instance. --allow-psc-global-access If specified, then clients from all regions can access this Private diff --git a/gcloud/alpha/compute/future-reservations/create b/gcloud/alpha/compute/future-reservations/create index 3240b56df..19de977d0 100644 --- a/gcloud/alpha/compute/future-reservations/create +++ b/gcloud/alpha/compute/future-reservations/create @@ -8,7 +8,7 @@ SYNOPSIS (--source-instance-template=SOURCE_INSTANCE_TEMPLATE | [--machine-type=MACHINE_TYPE : --accelerator=[count=COUNT],[type=TYPE] - --local-ssd=[interface=INTERFACE],[size=SIZE] + --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] --maintenance-freeze-duration=MAINTENANCE_FREEZE_DURATION --maintenance-interval=MAINTENANCE_INTERVAL --min-cpu-platform=MIN_CPU_PLATFORM]) @@ -74,7 +74,7 @@ REQUIRED FLAGS gcloud compute accelerator-types list to learn about all available accelerator types. - --local-ssd=[interface=INTERFACE],[size=SIZE] + --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] Manage the size and the interface of local SSD to use. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. @@ -85,6 +85,8 @@ REQUIRED FLAGS higher performance. size The size of the local SSD in base-2 GB. + count + The number of local SSD to use per VM. Default value is 1. --maintenance-freeze-duration=MAINTENANCE_FREEZE_DURATION Specifies the amount of hours after instance creation where the diff --git a/gcloud/alpha/compute/future-reservations/update b/gcloud/alpha/compute/future-reservations/update index 43cf89596..011d97baa 100644 --- a/gcloud/alpha/compute/future-reservations/update +++ b/gcloud/alpha/compute/future-reservations/update @@ -7,7 +7,7 @@ SYNOPSIS [--planning-status=PLANNING_STATUS] [--total-count=TOTAL_COUNT] [--zone=ZONE] [--accelerator=[count=COUNT],[type=TYPE] - --local-ssd=[interface=INTERFACE],[size=SIZE] + --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] --machine-type=MACHINE_TYPE --maintenance-interval=MAINTENANCE_INTERVAL --min-cpu-platform=MIN_CPU_PLATFORM] @@ -84,7 +84,7 @@ FLAGS compute accelerator-types list to learn about all available accelerator types. - --local-ssd=[interface=INTERFACE],[size=SIZE] + --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] Manage the size and the interface of local SSD to use. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. @@ -95,6 +95,8 @@ FLAGS performance. size The size of the local SSD in base-2 GB. + count + The number of local SSD to use per VM. Default value is 1. --machine-type=MACHINE_TYPE The type of machine (name only) that has a fixed number of vCPUs and diff --git a/gcloud/alpha/compute/images/create b/gcloud/alpha/compute/images/create index 8b636b638..a413b1d14 100644 --- a/gcloud/alpha/compute/images/create +++ b/gcloud/alpha/compute/images/create @@ -148,13 +148,12 @@ OPTIONAL FLAGS Flag force-create is deprecated. Use --force instead. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - one of: BARE_METAL_LINUX_COMPATIBLE, GVNIC, MULTI_IP_SUBNET, - SEV_CAPABLE, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, UEFI_COMPATIBLE, - VIRTIO_SCSI_MULTIQUEUE, WINDOWS. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be one of: BARE_METAL_LINUX_COMPATIBLE, GVNIC, + MULTI_IP_SUBNET, SEV_CAPABLE, SEV_LIVE_MIGRATABLE, SEV_SNP_CAPABLE, + UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS. --key-exchange-key-file=[KEK_VALUE,...] Comma-separated list of file paths that point to X.509 certificates in diff --git a/gcloud/alpha/compute/images/import b/gcloud/alpha/compute/images/import index 9d53ec648..e2d033875 100644 --- a/gcloud/alpha/compute/images/import +++ b/gcloud/alpha/compute/images/import @@ -178,11 +178,11 @@ OPTIONAL FLAGS by default, use --no-guest-environment to disable. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - (currently only one value is supported): UEFI_COMPATIBLE. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be (currently only one value is supported): + UEFI_COMPATIBLE. --log-location=LOG_LOCATION Directory in Cloud Storage to hold build logs. If not set, @@ -255,15 +255,15 @@ OPTIONAL FLAGS Specifies the OS of the disk image being imported. OS must be one of: centos-7, debian-10, debian-11, debian-8, debian-9, opensuse-15, rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, - rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, - sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, - windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, - windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, - windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, - windows-2019, windows-2019-byol, windows-2022, windows-2022-byol, - windows-7-x64-byol, windows-7-x86-byol, windows-8-x64-byol, - windows-8-x86-byol. + rhel-9, rhel-9-byol, rocky-8, sles-12, sles-12-byol, sles-15, + sles-15-byol, sles-sap-12, sles-sap-12-byol, sles-sap-15, + sles-sap-15-byol, ubuntu-1404, ubuntu-1604, ubuntu-1804, ubuntu-2004, + ubuntu-2204, windows-10-x64-byol, windows-10-x86-byol, + windows-11-x64-byol, windows-2008r2, windows-2008r2-byol, + windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, + windows-2016, windows-2016-byol, windows-2019, windows-2019-byol, + windows-2022, windows-2022-byol, windows-7-x64-byol, + windows-7-x86-byol, windows-8-x64-byol, windows-8-x86-byol. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/compute/instance-groups/managed/abandon-instances b/gcloud/alpha/compute/instance-groups/managed/abandon-instances index 23a8d8144..c25f8425e 100644 --- a/gcloud/alpha/compute/instance-groups/managed/abandon-instances +++ b/gcloud/alpha/compute/instance-groups/managed/abandon-instances @@ -25,8 +25,8 @@ DESCRIPTION the zone from the instance name. For a more detailed overview of how abandoning instances from a managed - instance group works, refer to this section: - https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances#abandoning_instances + instance group works, see Abandoning instances from a MIG + (https://cloud.google.com/compute/docs/instance-groups/add-remove-vms-in-mig#abandoning_instances). POSITIONAL ARGUMENTS NAME diff --git a/gcloud/alpha/compute/instance-groups/managed/create b/gcloud/alpha/compute/instance-groups/managed/create index 667003b90..3469c2546 100644 --- a/gcloud/alpha/compute/instance-groups/managed/create +++ b/gcloud/alpha/compute/instance-groups/managed/create @@ -58,8 +58,9 @@ OPTIONAL FLAGS per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If this flag is disabled with -no-force-update-on-repair, then updates are applied in accordance with - the group's update policy type. Use --force-update-on-repair to enable - and --no-force-update-on-repair to disable. + the group's update policy type. By default, this flag is disabled. Use + --force-update-on-repair to enable and --no-force-update-on-repair to + disable. --initial-delay=INITIAL_DELAY Specifies the length of time during which the instance is known to be diff --git a/gcloud/alpha/compute/instance-groups/managed/update b/gcloud/alpha/compute/instance-groups/managed/update index 82c500267..0447a8864 100644 --- a/gcloud/alpha/compute/instance-groups/managed/update +++ b/gcloud/alpha/compute/instance-groups/managed/update @@ -58,8 +58,9 @@ FLAGS per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If this flag is disabled with -no-force-update-on-repair, then updates are applied in accordance with - the group's update policy type. Use --force-update-on-repair to enable - and --no-force-update-on-repair to disable. + the group's update policy type. By default, this flag is disabled. Use + --force-update-on-repair to enable and --no-force-update-on-repair to + disable. --instance-redistribution-type=TYPE Specifies the type of the instance redistribution policy. An instance diff --git a/gcloud/alpha/compute/instance-groups/managed/wait-until b/gcloud/alpha/compute/instance-groups/managed/wait-until index b7d11bd1c..923b072ce 100644 --- a/gcloud/alpha/compute/instance-groups/managed/wait-until +++ b/gcloud/alpha/compute/instance-groups/managed/wait-until @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha compute instance-groups managed wait-until NAME - (--stable | --version-target-reached) [--timeout=TIMEOUT] + (--all-instances-config-effective | --stable + | --version-target-reached) [--timeout=TIMEOUT] [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -23,6 +24,10 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS Exactly one of these must be specified: + --all-instances-config-effective + Wait until the group's all-instances configuration is applied to all + VMs in the group. + --stable Wait until the group is stable. diff --git a/gcloud/alpha/compute/instance-templates/create b/gcloud/alpha/compute/instance-templates/create index 0820de88c..12aa40037 100644 --- a/gcloud/alpha/compute/instance-templates/create +++ b/gcloud/alpha/compute/instance-templates/create @@ -14,10 +14,15 @@ SYNOPSIS [--disk=[auto-delete=AUTO-DELETE], [boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME]] [--[no-]enable-nested-virtualization] [--[no-]enable-uefi-networking] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--instance-template-region=INSTANCE_TEMPLATE_REGION] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] - [--ipv6-network-tier=IPV6_NETWORK_TIER] + [--internal-ipv6-address=INTERNAL_IPV6_ADDRESS] + [--internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH] + [--ipv6-address=IPV6_ADDRESS] [--ipv6-network-tier=IPV6_NETWORK_TIER] + [--ipv6-prefix-length=IPV6_PREFIX_LENGTH] [--key-revocation-action-type=POLICY] [--labels=[KEY=VALUE,...]] [--local-nvdimm=[size=SIZE]] [--local-ssd=[device-name=DEVICE-NAME], @@ -364,6 +369,16 @@ FLAGS --enable-uefi-networking to enable and --no-enable-uefi-networking to disable. + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS The timeout in seconds for host error detection. The value must be set with 30 second increments, with a range of 90 to 330 seconds. If unset, @@ -373,7 +388,9 @@ FLAGS Specifies the region of the regional instance template. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -382,6 +399,24 @@ FLAGS Default. Stop the VM without preserving memory. The VM can be restarted later. + --internal-ipv6-address=INTERNAL_IPV6_ADDRESS + Assigns the given internal IPv6 address or range to the instance that + is created. The address must be the first IP address in the range or a + /96 IP address range. This option can be used only when creating a + single instance. + + --internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH + Optional field that indicates the prefix length of the internal IPv6 + address range, should be used together with --internal-ipv6-address. + Only /96 is supported and the default value is 96. If not set, the + prefix length from --internal-ipv6-address will be used or assigned a + default value of 96. + + --ipv6-address=IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + --ipv6-network-tier=IPV6_NETWORK_TIER Specifies the IPv6 network tier that will be used to configure the instance network interface IPv6 access config. IPV6_NETWORK_TIER must @@ -390,6 +425,11 @@ FLAGS PREMIUM High quality, Google-grade network tier. + --ipv6-prefix-length=IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --ipv6-address. Only the /96 IP address range is + supported, and the default value is 96. + --key-revocation-action-type=POLICY Specifies the behavior of the instance when the KMS key of one of its attached disks is revoked. The default is none. POLICY must be one of: @@ -449,18 +489,22 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration relative to the VM instance's most-recent start time. Format the - duration, MAX_RUN_DURATION, similar to T1h2m3s where you can specify - the number of hours, minutes, and seconds using h, m, and s - respectively. Alternatively, to specify a timestamp, use - --termination-time instead. + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --max-run-duration, the VM instance is terminated whenever the VM's - current runtime reaches MAX_RUN_DURATION; the current runtime is reset - to zero any time the VM instance is stopped and started again. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. --mesh=[gke-cluster=GKE-CLUSTER],[workload=WORKLOAD] Controls whether the Anthos Service Mesh service proxy (Envoy) and @@ -541,8 +585,10 @@ FLAGS Adds a network interface to the instance. Mutually exclusive with any of these flags: --address, --network, --network-tier, --subnet, --private-network-ip, --stack-type, --ipv6-network-tier, - --ipv6-public-ptr-domain. This flag can be repeated to specify multiple - network interfaces. + --ipv6-public-ptr-domain, --internal-ipv6-address, + --internal-ipv6-prefix-length, --ipv6-address, --ipv6-prefix-length, + --external-ipv6-address, --external-ipv6-prefix-length. This flag can + be repeated to specify multiple network interfaces. The following keys are allowed: address @@ -602,14 +648,18 @@ FLAGS --aliases="10.128.1.0/24;range1:/32" - Each IP alias range consists of a range name and an CIDR netmask - (e.g. `/24`) separated by a colon, or just the netmask. + Each IP alias range consists of a range name and a CIDR netmask + (e.g. `/24`) separated by a colon or just the netmask. The range name is the name of the range within the network interface's subnet from which to allocate an IP alias range. If unspecified, it defaults to the primary IP range of the subnet. The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -779,15 +829,19 @@ FLAGS --termination-time=TERMINATION_TIME Limits how long this VM instance can run, specified as a time. Format - the time, TERMINATION_TIME, as a RFC 3339 timestamp. Alternatively, to + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to specify a duration, use --max-run-duration instead. If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --termination-time, the VM instance is terminated only during the - specified time. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable @@ -962,8 +1016,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/alpha/compute/instance-templates/create-with-container b/gcloud/alpha/compute/instance-templates/create-with-container index e02fa65ba..d0e1a510d 100644 --- a/gcloud/alpha/compute/instance-templates/create-with-container +++ b/gcloud/alpha/compute/instance-templates/create-with-container @@ -25,7 +25,12 @@ SYNOPSIS [--create-disk=[PROPERTY=VALUE,...]] [--description=DESCRIPTION] [--disk=[auto-delete=AUTO-DELETE], [boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME]] - [--ipv6-network-tier=IPV6_NETWORK_TIER] [--labels=[KEY=VALUE,...]] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] + [--internal-ipv6-address=INTERNAL_IPV6_ADDRESS] + [--internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH] + [--ipv6-address=IPV6_ADDRESS] [--ipv6-network-tier=IPV6_NETWORK_TIER] + [--ipv6-prefix-length=IPV6_PREFIX_LENGTH] [--labels=[KEY=VALUE,...]] [--local-nvdimm=[size=SIZE]] [--local-ssd=[device-name=DEVICE-NAME], [interface=INTERFACE],[size=SIZE]] [--machine-type=MACHINE_TYPE] @@ -391,6 +396,34 @@ FLAGS the instance, this option won't apply. The default value for this is yes. + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + + --internal-ipv6-address=INTERNAL_IPV6_ADDRESS + Assigns the given internal IPv6 address or range to the instance that + is created. The address must be the first IP address in the range or a + /96 IP address range. This option can be used only when creating a + single instance. + + --internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH + Optional field that indicates the prefix length of the internal IPv6 + address range, should be used together with --internal-ipv6-address. + Only /96 is supported and the default value is 96. If not set, the + prefix length from --internal-ipv6-address will be used or assigned a + default value of 96. + + --ipv6-address=IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + --ipv6-network-tier=IPV6_NETWORK_TIER Specifies the IPv6 network tier that will be used to configure the instance network interface IPv6 access config. IPV6_NETWORK_TIER must @@ -399,6 +432,11 @@ FLAGS PREMIUM High quality, Google-grade network tier. + --ipv6-prefix-length=IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --ipv6-address. Only the /96 IP address range is + supported, and the default value is 96. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -550,14 +588,18 @@ FLAGS --aliases="10.128.1.0/24;range1:/32" - Each IP alias range consists of a range name and an CIDR netmask - (e.g. `/24`) separated by a colon, or just the netmask. + Each IP alias range consists of a range name and a CIDR netmask + (e.g. `/24`) separated by a colon or just the netmask. The range name is the name of the range within the network interface's subnet from which to allocate an IP alias range. If unspecified, it defaults to the primary IP range of the subnet. The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-tier=NETWORK_TIER Specifies the network tier that will be used to configure the instance. NETWORK_TIER must be one of: PREMIUM, STANDARD, FIXED_STANDARD. The diff --git a/gcloud/alpha/compute/instances/bulk/create b/gcloud/alpha/compute/instances/bulk/create index 01ef5296a..b8667c792 100644 --- a/gcloud/alpha/compute/instances/bulk/create +++ b/gcloud/alpha/compute/instances/bulk/create @@ -412,7 +412,9 @@ OPTIONAL FLAGS the default behavior of the host error recovery is used. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -473,18 +475,22 @@ OPTIONAL FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration relative to the VM instance's most-recent start time. Format the - duration, MAX_RUN_DURATION, similar to T1h2m3s where you can specify - the number of hours, minutes, and seconds using h, m, and s - respectively. Alternatively, to specify a timestamp, use - --termination-time instead. + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --max-run-duration, the VM instance is terminated whenever the VM's - current runtime reaches MAX_RUN_DURATION; the current runtime is reset - to zero any time the VM instance is stopped and started again. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -577,6 +583,10 @@ OPTIONAL FLAGS Specifies the Network Interface Controller (NIC) type for the interface. NIC_TYPE must be one of: GVNIC, VIRTIO_NET. + no-address + If specified the interface will have no external IP. If not + specified instances will get ephemeral IPs. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -721,15 +731,19 @@ OPTIONAL FLAGS --termination-time=TERMINATION_TIME Limits how long this VM instance can run, specified as a time. Format - the time, TERMINATION_TIME, as a RFC 3339 timestamp. Alternatively, to + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to specify a duration, use --max-run-duration instead. If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --termination-time, the VM instance is terminated only during the - specified time. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/alpha/compute/instances/config/export b/gcloud/alpha/compute/instances/config/export index 48fd2570a..ae5fa1cc0 100644 --- a/gcloud/alpha/compute/instances/config/export +++ b/gcloud/alpha/compute/instances/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/instances/create b/gcloud/alpha/compute/instances/create index 07387d626..d34cb6017 100644 --- a/gcloud/alpha/compute/instances/create +++ b/gcloud/alpha/compute/instances/create @@ -16,6 +16,8 @@ SYNOPSIS [device-name=DEVICE-NAME],[mode=MODE],[name=NAME],[scope=SCOPE]] [--enable-display-device] [--[no-]enable-nested-virtualization] [--[no-]enable-uefi-networking] [--erase-windows-vss-signature] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--hostname=HOSTNAME] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] @@ -126,7 +128,7 @@ EXAMPLES --zone=central2-a --shielded-secure-boot --shielded-vtpm \ --shielded-integrity-monitoring - To create an preemptible instance called 'instance-1', run: + To create a preemptible instance called 'instance-1', run: $ gcloud alpha compute instances create instance-1 \ --machine-type=n1-standard-1 --zone=us-central1-b \ @@ -465,6 +467,16 @@ FLAGS machine image should erase Windows specific VSS signature. See https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot#--guest-flush + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS The timeout in seconds for host error detection. The value must be set with 30 second increments, with a range of 90 to 330 seconds. If unset, @@ -478,7 +490,9 @@ FLAGS using zonal DNS. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -489,21 +503,21 @@ FLAGS --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to the instance that - is created. The address must be the first IP in the range or a IP range - with /96. This option can only be used when creating a single instance. + is created. The address must be the first IP address in the range or a + /96 IP address range. This option can be used only when creating a + single instance. --internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH Optional field that indicates the prefix length of the internal IPv6 - address range, should be used together with - --internal-ipv6-address=fd20::. Currently only /96 is supported and the - default value is 96. If not set, the prefix length from - --internal-ipv6-address=fd20::/96 will be used or assigned a default - value of 96. + address range, should be used together with --internal-ipv6-address. + Only /96 is supported and the default value is 96. If not set, the + prefix length from --internal-ipv6-address will be used or assigned a + default value of 96. --ipv6-address=IPV6_ADDRESS Assigns the given external IPv6 address to the instance that is - created. The address must be the first IP in the range. This option can - only be used when creating a single instance. + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. --ipv6-network-tier=IPV6_NETWORK_TIER Specifies the IPv6 network tier that will be used to configure the @@ -514,9 +528,9 @@ FLAGS High quality, Google-grade network tier. --ipv6-prefix-length=IPV6_PREFIX_LENGTH - Prefix Length of the External IPv6 address range, should be used - together with --ipv6-address. Currently only /96 is supported and the - default value is 96. + The prefix length of the external IPv6 address range. This field should + be used together with --ipv6-address. Only the /96 IP address range is + supported, and the default value is 96. --ipv6-public-ptr-domain=IPV6_PUBLIC_PTR_DOMAIN Assigns a custom PTR domain for the external IPv6 in the IPv6 access @@ -598,18 +612,22 @@ FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration relative to the VM instance's most-recent start time. Format the - duration, MAX_RUN_DURATION, similar to T1h2m3s where you can specify - the number of hours, minutes, and seconds using h, m, and s - respectively. Alternatively, to specify a timestamp, use - --termination-time instead. + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --max-run-duration, the VM instance is terminated whenever the VM's - current runtime reaches MAX_RUN_DURATION; the current runtime is reset - to zero any time the VM instance is stopped and started again. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -843,15 +861,19 @@ FLAGS --termination-time=TERMINATION_TIME Limits how long this VM instance can run, specified as a time. Format - the time, TERMINATION_TIME, as a RFC 3339 timestamp. Alternatively, to + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to specify a duration, use --max-run-duration instead. If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --termination-time, the VM instance is terminated only during the - specified time. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable @@ -1088,8 +1110,10 @@ FLAGS Adds a network interface to the instance. Mutually exclusive with any of these flags: --address, --network, --network-tier, --subnet, --private-network-ip, --stack-type, --ipv6-network-tier, - --ipv6-public-ptr-domain. This flag can be repeated to specify - multiple network interfaces. + --ipv6-public-ptr-domain, --internal-ipv6-address, + --internal-ipv6-prefix-length, --ipv6-address, --ipv6-prefix-length, + --external-ipv6-address, --external-ipv6-prefix-length. This flag can + be repeated to specify multiple network interfaces. The following keys are allowed: address @@ -1172,6 +1196,10 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should + connect to. Mutually exclusive with --network and --subnet flags. + --network-interface-from-file=KEY=LOCAL_FILE_PATH Same as --network-interface except that the value for the entry will be read from a local file. This is used in case subinterfaces need to @@ -1219,8 +1247,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/alpha/compute/instances/create-with-container b/gcloud/alpha/compute/instances/create-with-container index f5d83cf9a..948e15549 100644 --- a/gcloud/alpha/compute/instances/create-with-container +++ b/gcloud/alpha/compute/instances/create-with-container @@ -26,8 +26,12 @@ SYNOPSIS [--disk=[auto-delete=AUTO-DELETE],[boot=BOOT], [device-name=DEVICE-NAME],[mode=MODE],[name=NAME],[scope=SCOPE]] [--[no-]enable-nested-virtualization] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] + [--internal-ipv6-address=INTERNAL_IPV6_ADDRESS] + [--internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH] [--ipv6-address=IPV6_ADDRESS] [--ipv6-network-tier=IPV6_NETWORK_TIER] [--ipv6-prefix-length=IPV6_PREFIX_LENGTH] [--labels=[KEY=VALUE,...]] [--local-nvdimm=[size=SIZE]] @@ -412,13 +416,25 @@ FLAGS --enable-nested-virtualization to enable and --no-enable-nested-virtualization to disable. + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS The timeout in seconds for host error detection. The value must be set with 30 second increments, with a range of 90 to 330 seconds. If unset, the default behavior of the host error recovery is used. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -427,10 +443,23 @@ FLAGS Default. Stop the VM without preserving memory. The VM can be restarted later. + --internal-ipv6-address=INTERNAL_IPV6_ADDRESS + Assigns the given internal IPv6 address or range to the instance that + is created. The address must be the first IP address in the range or a + /96 IP address range. This option can be used only when creating a + single instance. + + --internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH + Optional field that indicates the prefix length of the internal IPv6 + address range, should be used together with --internal-ipv6-address. + Only /96 is supported and the default value is 96. If not set, the + prefix length from --internal-ipv6-address will be used or assigned a + default value of 96. + --ipv6-address=IPV6_ADDRESS Assigns the given external IPv6 address to the instance that is - created. The address must be the first IP in the range. This option can - only be used when creating a single instance. + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. --ipv6-network-tier=IPV6_NETWORK_TIER Specifies the IPv6 network tier that will be used to configure the @@ -441,9 +470,9 @@ FLAGS High quality, Google-grade network tier. --ipv6-prefix-length=IPV6_PREFIX_LENGTH - Prefix Length of the External IPv6 address range, should be used - together with --ipv6-address. Currently only /96 is supported and the - default value is 96. + The prefix length of the external IPv6 address range. This field should + be used together with --ipv6-address. Only the /96 IP address range is + supported, and the default value is 96. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -609,6 +638,10 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/alpha/compute/instances/delete b/gcloud/alpha/compute/instances/delete index fb4222c8c..525630d3f 100644 --- a/gcloud/alpha/compute/instances/delete +++ b/gcloud/alpha/compute/instances/delete @@ -56,8 +56,9 @@ FLAGS disks' auto-delete configuration. When this flag is provided, the auto-delete bits on the attached disks are modified accordingly before the instance deletion requests are issued. For more - information on disk auto-deletion, see - https://cloud.google.com/compute/docs/disks/persistent-disks#updateautodelete. + information on disk auto-deletion, see Set the auto-delete state of a + zonal persistent disk + (https://cloud.google.com/compute/docs/disks/modify-persistent-disk#updateautodelete). DISK_TYPE must be one of: all @@ -72,8 +73,9 @@ FLAGS the disks' auto-delete configuration. When this flag is provided, the auto-delete bits on the attached disks are modified accordingly before the instance deletion requests are issued. For more - information on disk auto-deletion, see - https://cloud.google.com/compute/docs/disks/persistent-disks#updateautodelete. + information on disk auto-deletion, see Set the auto-delete state of a + zonal persistent disk + (https://cloud.google.com/compute/docs/disks/modify-persistent-disk#updateautodelete). DISK_TYPE must be one of: all diff --git a/gcloud/alpha/compute/instances/import b/gcloud/alpha/compute/instances/import index 87ac44bc2..745ebf387 100644 --- a/gcloud/alpha/compute/instances/import +++ b/gcloud/alpha/compute/instances/import @@ -121,11 +121,11 @@ OPTIONAL FLAGS default, use --no-guest-environment to disable. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - (currently only one value is supported): UEFI_COMPATIBLE. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be (currently only one value is supported): + UEFI_COMPATIBLE. --hostname=HOSTNAME Specify the hostname of the VM instance to be imported. The specified @@ -166,10 +166,10 @@ OPTIONAL FLAGS --os=OS Specifies the OS of the image being imported. OS must be one of: centos-7, debian-10, debian-11, debian-8, debian-9, opensuse-15, - rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, - sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, - sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rhel-9, + rhel-9-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, + sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, + ubuntu-1404, ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, @@ -279,8 +279,10 @@ OPTIONAL FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/alpha/compute/instances/network-interfaces/update b/gcloud/alpha/compute/instances/network-interfaces/update index 969c2e0f9..772c4e5c8 100644 --- a/gcloud/alpha/compute/instances/network-interfaces/update +++ b/gcloud/alpha/compute/instances/network-interfaces/update @@ -4,7 +4,9 @@ NAME SYNOPSIS gcloud alpha compute instances network-interfaces update INSTANCE_NAME - [--aliases=ALIASES] [--internal-ipv6-address=INTERNAL_IPV6_ADDRESS] + [--aliases=ALIASES] [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] + [--internal-ipv6-address=INTERNAL_IPV6_ADDRESS] [--internal-ipv6-prefix-length=INTERNAL_IPV6_PREFIX_LENGTH] [--ipv6-address=IPV6_ADDRESS] [--ipv6-network-tier=IPV6_NETWORK_TIER] [--ipv6-prefix-length=IPV6_PREFIX_LENGTH] [--network=NETWORK] @@ -44,6 +46,16 @@ FLAGS --aliases="10.128.1.0/24;r1:/32" + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to an instance. The address + must be the first IP in the range. This option is applicable only to + dual-stack instances with stack-type=IPV4_ONLY. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This flag should + be used together with --external-ipv6-address. Currently only /96 is + supported and the default value is 96. + --internal-ipv6-address=INTERNAL_IPV6_ADDRESS Assigns the given internal IPv6 address or range to an instance. The address must be the first IP in the range or a IP range with /96. This @@ -59,8 +71,8 @@ FLAGS --ipv6-address=IPV6_ADDRESS Assigns the given external IPv6 address to an instance. The address - must be the first IP in the range. This option can only be used on a - IPv4 only dual stack instance. + must be the first IP in the range. This option is applicable only to + dual-stack instances with stack-type=IPV4_ONLY. --ipv6-network-tier=IPV6_NETWORK_TIER Specifies the IPv6 network tier that will be used to configure the @@ -71,9 +83,9 @@ FLAGS High quality, Google-grade network tier. --ipv6-prefix-length=IPV6_PREFIX_LENGTH - Prefix Length of the External IPv6 address range, should be used - together with --ipv6-address. Currently only /96 is supported and the - default value is 96. + The prefix length of the external IPv6 address range. This flag should + be used together with --ipv6-address. Currently only /96 is supported + and the default value is 96. --network=NETWORK Specifies the network this network interface belongs to. diff --git a/gcloud/alpha/compute/instances/set-scheduling b/gcloud/alpha/compute/instances/set-scheduling index 4052fee14..b6ae3dd0a 100644 --- a/gcloud/alpha/compute/instances/set-scheduling +++ b/gcloud/alpha/compute/instances/set-scheduling @@ -113,7 +113,9 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM - preemption. INSTANCE_TERMINATION_ACTION must be one of: + preemption (--provisioning-model=SPOT or --preemptible) or automatic + instance termination (--max-run-duration or --termination-time). + INSTANCE_TERMINATION_ACTION must be one of: DELETE Permanently delete the VM. @@ -139,8 +141,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/alpha/compute/instances/simulate-maintenance-event b/gcloud/alpha/compute/instances/simulate-maintenance-event index 6726796d2..9787be8f5 100644 --- a/gcloud/alpha/compute/instances/simulate-maintenance-event +++ b/gcloud/alpha/compute/instances/simulate-maintenance-event @@ -4,7 +4,9 @@ NAME SYNOPSIS gcloud alpha compute instances simulate-maintenance-event INSTANCE_NAMES - [INSTANCE_NAMES ...] [--async] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [INSTANCE_NAMES ...] [--async] + [--with-extended-notifications=WITH_EXTENDED_NOTIFICATIONS] + [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute instances simulate-maintenance-event simulates @@ -29,6 +31,10 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --with-extended-notifications=WITH_EXTENDED_NOTIFICATIONS + Send an extended notification before simulating a host maintenance + event on a Compute Engine VM. + --zone=ZONE Zone of the instances to operate on. If not specified, you might be prompted to select a zone (interactive mode only). gcloud attempts to diff --git a/gcloud/alpha/compute/instances/stop b/gcloud/alpha/compute/instances/stop index 92721902d..bed729931 100644 --- a/gcloud/alpha/compute/instances/stop +++ b/gcloud/alpha/compute/instances/stop @@ -3,20 +3,29 @@ NAME SYNOPSIS gcloud alpha compute instances stop INSTANCE_NAMES [INSTANCE_NAMES ...] - [--async] [--discard-local-ssd] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--async] [--discard-local-ssd[=DISCARD_LOCAL_SSD]] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute instances stop is used to stop a Compute Engine virtual machine. Stopping a VM performs a clean shutdown, much like invoking the shutdown functionality of a workstation or laptop. Stopping a - VM with a local SSD is not supported and will result in an API error. - Stopping a VM which is already stopped will return without errors. + VM with a local SSD is not supported and will result in an API error unless + the --discard-local-ssd flag is passed. Stopping a VM which is already + stopped will return without errors. EXAMPLES To stop an instance named test-instance, run: $ gcloud alpha compute instances stop test-instance + To stop an instance named test-instance that has a Local SSD, run: + + $ gcloud alpha compute instances stop test-instance \ + --discard-local-ssd=True + + Using '--discard-local-ssd' without a value defaults to True. + POSITIONAL ARGUMENTS INSTANCE_NAMES [INSTANCE_NAMES ...] Names of the instances to operate on. For details on valid instance @@ -28,8 +37,8 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --discard-local-ssd - If provided, local SSD data is discarded. + --discard-local-ssd[=DISCARD_LOCAL_SSD] + If set to true, local SSD data is discarded. --zone=ZONE Zone of the instances to operate on. If not specified, you might be diff --git a/gcloud/alpha/compute/instances/suspend b/gcloud/alpha/compute/instances/suspend index 8669ef168..a3d2a75cc 100644 --- a/gcloud/alpha/compute/instances/suspend +++ b/gcloud/alpha/compute/instances/suspend @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud alpha compute instances suspend INSTANCE_NAMES [INSTANCE_NAMES ...] - [--async] [--discard-local-ssd] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--async] [--discard-local-ssd[=DISCARD_LOCAL_SSD]] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute instances suspend is used to suspend a Compute @@ -24,6 +25,13 @@ EXAMPLES $ gcloud alpha compute instances suspend test-instance + To suspend an instance named test-instance that has a Local SSD, run: + + $ gcloud alpha compute instances suspend test-instance \ + --discard-local-ssd=True + + Using '--discard-local-ssd' without a value defaults to True. + POSITIONAL ARGUMENTS INSTANCE_NAMES [INSTANCE_NAMES ...] Names of the instances to operate on. For details on valid instance @@ -35,8 +43,8 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --discard-local-ssd - If provided, local SSD data is discarded. + --discard-local-ssd[=DISCARD_LOCAL_SSD] + If set to true, local SSD data is discarded. --zone=ZONE Zone of the instances to operate on. If not specified, you might be diff --git a/gcloud/alpha/compute/instances/update b/gcloud/alpha/compute/instances/update index f2721c97b..798a6c15a 100644 --- a/gcloud/alpha/compute/instances/update +++ b/gcloud/alpha/compute/instances/update @@ -180,8 +180,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/alpha/compute/instances/update-access-config b/gcloud/alpha/compute/instances/update-access-config index 4d8e916a1..8a0fd1aaf 100644 --- a/gcloud/alpha/compute/instances/update-access-config +++ b/gcloud/alpha/compute/instances/update-access-config @@ -15,13 +15,23 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha compute instances update-access-config is used to update access configurations for network interfaces of Compute Engine - virtual machines. + virtual machines. IPv4 and IPv6 access configurations cannot be updated + together. EXAMPLES - To update network interface of an instance to 'nic0', run: + To update public PTR record in IPv4 access config in network interface + 'nic0' of an instance, run: $ gcloud alpha compute instances update-access-config \ - example-instance --network-interface=nic0 --zone=us-central1-b + example-instance --network-interface=nic0 --zone=us-central1-b \ + --public-ptr --public-ptr-domain=exampledomain.com. + + To update public PTR record in IPv6 access config in default network + interface 'nic0' of an instance, run: + + $ gcloud alpha compute instances update-access-config \ + example-instance --zone=us-central1-b \ + --ipv6-public-ptr-domain=exampledomain.com. POSITIONAL ARGUMENTS INSTANCE_NAME diff --git a/gcloud/alpha/compute/machine-images/import b/gcloud/alpha/compute/machine-images/import index e62f0cffc..268300e62 100644 --- a/gcloud/alpha/compute/machine-images/import +++ b/gcloud/alpha/compute/machine-images/import @@ -121,11 +121,11 @@ OPTIONAL FLAGS prepare for the snapshot process. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - (currently only one value is supported): UEFI_COMPATIBLE. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be (currently only one value is supported): + UEFI_COMPATIBLE. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -159,10 +159,10 @@ OPTIONAL FLAGS --os=OS Specifies the OS of the machine image being imported. OS must be one of: centos-7, debian-10, debian-11, debian-8, debian-9, opensuse-15, - rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, - sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, - sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rhel-9, + rhel-9-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, + sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, + ubuntu-1404, ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, diff --git a/gcloud/alpha/compute/network-edge-security-services/create b/gcloud/alpha/compute/network-edge-security-services/create index 83d6ea3b5..aae768a71 100644 --- a/gcloud/alpha/compute/network-edge-security-services/create +++ b/gcloud/alpha/compute/network-edge-security-services/create @@ -6,8 +6,7 @@ SYNOPSIS gcloud alpha compute network-edge-security-services create NAME [--description=DESCRIPTION] [--region=REGION] [--security-policy=SECURITY_POLICY] - [--global-security-policy - | --security-policy-region=SECURITY_POLICY_REGION] + [--security-policy-region=SECURITY_POLICY_REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -44,14 +43,9 @@ FLAGS service. To remove the policy from this network edge security service set the policy to an empty string. - At most one of these can be specified: - - --global-security-policy - If set, the security policy is global. - - --security-policy-region=SECURITY_POLICY_REGION - Region of the security policy to operate on. Overrides the default - compute/region property value for this command invocation. + --security-policy-region=SECURITY_POLICY_REGION + Region of the security policy to operate on. Overrides the default + compute/region property value for this command invocation. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -65,7 +59,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud compute network-edge-security-services create $ gcloud beta compute network-edge-security-services create diff --git a/gcloud/alpha/compute/network-edge-security-services/delete b/gcloud/alpha/compute/network-edge-security-services/delete index 487262885..0ec094aec 100644 --- a/gcloud/alpha/compute/network-edge-security-services/delete +++ b/gcloud/alpha/compute/network-edge-security-services/delete @@ -38,7 +38,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud compute network-edge-security-services delete $ gcloud beta compute network-edge-security-services delete diff --git a/gcloud/alpha/compute/network-edge-security-services/describe b/gcloud/alpha/compute/network-edge-security-services/describe index 9dc182549..1a2147166 100644 --- a/gcloud/alpha/compute/network-edge-security-services/describe +++ b/gcloud/alpha/compute/network-edge-security-services/describe @@ -39,7 +39,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud compute network-edge-security-services describe $ gcloud beta compute network-edge-security-services describe diff --git a/gcloud/alpha/compute/network-edge-security-services/help b/gcloud/alpha/compute/network-edge-security-services/help index 03e52a817..846801127 100644 --- a/gcloud/alpha/compute/network-edge-security-services/help +++ b/gcloud/alpha/compute/network-edge-security-services/help @@ -43,7 +43,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud compute network-edge-security-services $ gcloud beta compute network-edge-security-services diff --git a/gcloud/alpha/compute/network-edge-security-services/list b/gcloud/alpha/compute/network-edge-security-services/list index 72e9bf432..eea14b301 100644 --- a/gcloud/alpha/compute/network-edge-security-services/list +++ b/gcloud/alpha/compute/network-edge-security-services/list @@ -74,7 +74,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud compute network-edge-security-services list $ gcloud beta compute network-edge-security-services list diff --git a/gcloud/alpha/compute/network-edge-security-services/update b/gcloud/alpha/compute/network-edge-security-services/update index acbe493f8..ac0ddc1fc 100644 --- a/gcloud/alpha/compute/network-edge-security-services/update +++ b/gcloud/alpha/compute/network-edge-security-services/update @@ -6,8 +6,7 @@ SYNOPSIS gcloud alpha compute network-edge-security-services update NAME [--description=DESCRIPTION] [--region=REGION] [--security-policy=SECURITY_POLICY] - [--global-security-policy - | --security-policy-region=SECURITY_POLICY_REGION] + [--security-policy-region=SECURITY_POLICY_REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -44,14 +43,9 @@ FLAGS service. To remove the policy from this network edge security service set the policy to an empty string. - At most one of these can be specified: - - --global-security-policy - If set, the security policy is global. - - --security-policy-region=SECURITY_POLICY_REGION - Region of the security policy to operate on. Overrides the default - compute/region property value for this command invocation. + --security-policy-region=SECURITY_POLICY_REGION + Region of the security policy to operate on. Overrides the default + compute/region property value for this command invocation. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -65,7 +59,9 @@ 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: + access allowlist. These variants are also available: + + $ gcloud compute network-edge-security-services update $ gcloud beta compute network-edge-security-services update diff --git a/gcloud/alpha/compute/network-firewall-policies/rules/create b/gcloud/alpha/compute/network-firewall-policies/rules/create index c7de668fd..fa5c49c1d 100644 --- a/gcloud/alpha/compute/network-firewall-policies/rules/create +++ b/gcloud/alpha/compute/network-firewall-policies/rules/create @@ -67,8 +67,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if diff --git a/gcloud/alpha/compute/network-firewall-policies/rules/update b/gcloud/alpha/compute/network-firewall-policies/rules/update index d4f507c4e..44eae3de3 100644 --- a/gcloud/alpha/compute/network-firewall-policies/rules/update +++ b/gcloud/alpha/compute/network-firewall-policies/rules/update @@ -60,8 +60,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if diff --git a/gcloud/alpha/compute/networks/subnets/config/export b/gcloud/alpha/compute/networks/subnets/config/export index e14bd9642..1fde5be2e 100644 --- a/gcloud/alpha/compute/networks/subnets/config/export +++ b/gcloud/alpha/compute/networks/subnets/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/networks/subnets/create b/gcloud/alpha/compute/networks/subnets/create index 6cdc2ed5a..73520d5f4 100644 --- a/gcloud/alpha/compute/networks/subnets/create +++ b/gcloud/alpha/compute/networks/subnets/create @@ -6,8 +6,9 @@ SYNOPSIS gcloud alpha compute networks subnets create NAME --network=NETWORK [--aggregation-interval=AGGREGATION_INTERVAL] [--description=DESCRIPTION] [--enable-flow-logs] - [--enable-private-ip-google-access] [--flow-sampling=FLOW_SAMPLING] - [--ipv6-access-type=IPV6_ACCESS_TYPE] + [--enable-private-ip-google-access] + [--external-ipv6-prefix=EXTERNAL_IPV6_PREFIX] + [--flow-sampling=FLOW_SAMPLING] [--ipv6-access-type=IPV6_ACCESS_TYPE] [--logging-aggregation-interval=LOGGING_AGGREGATION_INTERVAL] [--logging-filter-expr=LOGGING_FILTER_EXPR] [--logging-flow-sampling=LOGGING_FLOW_SAMPLING] @@ -63,6 +64,11 @@ OPTIONAL FLAGS Enable/disable access to Google Cloud APIs from this subnet for instances without a public ip address. + --external-ipv6-prefix=EXTERNAL_IPV6_PREFIX + Set external IPv6 prefix to be allocated for this subnetwork. + + For example, --external-ipv6-prefix 2600:1901:0:0:0:0:0:0/64 + --flow-sampling=FLOW_SAMPLING Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling diff --git a/gcloud/alpha/compute/queued-resources/create b/gcloud/alpha/compute/queued-resources/create index 9cf0ca018..110c5f27b 100644 --- a/gcloud/alpha/compute/queued-resources/create +++ b/gcloud/alpha/compute/queued-resources/create @@ -397,7 +397,9 @@ OPTIONAL FLAGS the default behavior of the host error recovery is used. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -458,18 +460,22 @@ OPTIONAL FLAGS --max-run-duration=MAX_RUN_DURATION Limits how long this VM instance can run, specified as a duration relative to the VM instance's most-recent start time. Format the - duration, MAX_RUN_DURATION, similar to T1h2m3s where you can specify - the number of hours, minutes, and seconds using h, m, and s - respectively. Alternatively, to specify a timestamp, use - --termination-time instead. + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. If neither --max-run-duration nor --termination-time is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --max-run-duration, the VM instance is terminated whenever the VM's - current runtime reaches MAX_RUN_DURATION; the current runtime is reset - to zero any time the VM instance is stopped and started again. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on @@ -562,6 +568,10 @@ OPTIONAL FLAGS Specifies the Network Interface Controller (NIC) type for the interface. NIC_TYPE must be one of: GVNIC, VIRTIO_NET. + no-address + If specified the interface will have no external IP. If not + specified instances will get ephemeral IPs. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -706,15 +716,19 @@ OPTIONAL FLAGS --termination-time=TERMINATION_TIME Limits how long this VM instance can run, specified as a time. Format - the time, TERMINATION_TIME, as a RFC 3339 timestamp. Alternatively, to + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to specify a duration, use --max-run-duration instead. If neither --termination-time nor --max-run-duration is specified (default), the VM instance runs until prompted by a user action or - system event. If either is specified, the VM instance will be - terminated using the action specified by --instance-termination-action. - For --termination-time, the VM instance is terminated only during the - specified time. + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable diff --git a/gcloud/alpha/compute/reservations/create b/gcloud/alpha/compute/reservations/create index 1dd7b1995..fc7d3b890 100644 --- a/gcloud/alpha/compute/reservations/create +++ b/gcloud/alpha/compute/reservations/create @@ -8,7 +8,7 @@ SYNOPSIS (--source-instance-template=SOURCE_INSTANCE_TEMPLATE | [--machine-type=MACHINE_TYPE : --accelerator=[count=COUNT],[type=TYPE] - --local-ssd=[interface=INTERFACE],[size=SIZE] + --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] --maintenance-freeze-duration=MAINTENANCE_FREEZE_DURATION --maintenance-interval=MAINTENANCE_INTERVAL --min-cpu-platform=MIN_CPU_PLATFORM]) @@ -87,7 +87,7 @@ REQUIRED FLAGS reservation. Use gcloud compute accelerator-types list to learn about all available accelerator types. - --local-ssd=[interface=INTERFACE],[size=SIZE] + --local-ssd=[count=COUNT],[interface=INTERFACE],[size=SIZE] Manage the size and the interface of local SSD to use. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. @@ -98,6 +98,8 @@ REQUIRED FLAGS higher performance. size The size of the local SSD in base-2 GB. + count + The number of local SSD to use per VM. Default value is 1. --maintenance-freeze-duration=MAINTENANCE_FREEZE_DURATION Specifies the amount of hours after instance creation where the diff --git a/gcloud/alpha/compute/resource-policies/create/group-placement b/gcloud/alpha/compute/resource-policies/create/group-placement index 2056aa048..ca4fb6350 100644 --- a/gcloud/alpha/compute/resource-policies/create/group-placement +++ b/gcloud/alpha/compute/resource-policies/create/group-placement @@ -6,7 +6,8 @@ SYNOPSIS gcloud alpha compute resource-policies create group-placement NAME [--availability-domain-count=AVAILABILITY_DOMAIN_COUNT] [--collocation=COLLOCATION] [--description=DESCRIPTION] - [--region=REGION] [--scope=SCOPE] [--vm-count=VM_COUNT] + [--max-distance=MAX_DISTANCE] [--region=REGION] [--scope=SCOPE] + [--tpu-topology=TPU_TOPOLOGY] [--vm-count=VM_COUNT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -42,6 +43,9 @@ FLAGS --description=DESCRIPTION An optional, textual description for the backend. + --max-distance=MAX_DISTANCE + Specifies the number of max logical switches. + --region=REGION Region of the resource policy to operate on. If not specified, you might be prompted to select a region (interactive mode only). @@ -73,6 +77,9 @@ FLAGS Instances will be spread across different instrastructure to not share power, host and networking. + --tpu-topology=TPU_TOPOLOGY + Specifies the shape of the TPU pod slice. + --vm-count=VM_COUNT Number of instances targeted by the group placement policy. Google does not recommend that you use this flag unless you use a compact policy diff --git a/gcloud/alpha/compute/security-policies/rules/create b/gcloud/alpha/compute/security-policies/rules/create index a3d2d51fe..ed25a7783 100644 --- a/gcloud/alpha/compute/security-policies/rules/create +++ b/gcloud/alpha/compute/security-policies/rules/create @@ -128,9 +128,14 @@ OPTIONAL FLAGS X-Forwarded-For header as the key ◆ http-cookie: key type takes the value of the HTTP cookie configured in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, - http-cookie. + http-cookie, http-path, sni, region-code. --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the diff --git a/gcloud/alpha/compute/security-policies/rules/update b/gcloud/alpha/compute/security-policies/rules/update index d536fa7c3..7d9b58d13 100644 --- a/gcloud/alpha/compute/security-policies/rules/update +++ b/gcloud/alpha/compute/security-policies/rules/update @@ -116,9 +116,14 @@ FLAGS X-Forwarded-For header as the key ◆ http-cookie: key type takes the value of the HTTP cookie configured in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, - http-cookie. + http-cookie, http-path, sni, region-code. --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the diff --git a/gcloud/alpha/compute/service-attachments/create b/gcloud/alpha/compute/service-attachments/create index fca47501e..29193172b 100644 --- a/gcloud/alpha/compute/service-attachments/create +++ b/gcloud/alpha/compute/service-attachments/create @@ -8,7 +8,7 @@ SYNOPSIS --producer-forwarding-rule=PRODUCER_FORWARDING_RULE [--connection-preference=CONNECTION_PREFERENCE; default="ACCEPT_AUTOMATIC"] - [--consumer-accept-list=[PROJECT=LIMIT,...]] + [--consumer-accept-list=[PROJECT_OR_NETWORK=LIMIT,...]] [--consumer-reject-list=[REJECT_LIST,...]] [--description=DESCRIPTION] [--domain-names=[DOMAIN_NAMES,...]] [--enable-proxy-protocol] [--nat-subnets-region=NAT_SUBNETS_REGION] @@ -64,20 +64,31 @@ OPTIONAL FLAGS Only accept connection requests from consumers with the approval of the service provider. - --consumer-accept-list=[PROJECT=LIMIT,...] - Adds consumer project(s) with connection limit(s) to the accept list of - the service attachment. + --consumer-accept-list=[PROJECT_OR_NETWORK=LIMIT,...] + Specifies which consumer projects or networks are allowed to connect to + the service attachment. Each project or network has a connection limit. + A given service attachment can manage connections at either the project + or network level. Therefore, both the accept and reject lists for a + given service attachment must contain either only projects or only + networks. For example, --consumer-accept-list myProjectId1=20 accepts a consumer - project myProjectId1 with connection limit 20. + project myProjectId1 with connection limit 20; --consumer-accept-list + projects/myProjectId1/global/networks/myNet1=20 accepts a consumer + network myNet1 with connection limit 20 - ◆ PROJECT_ID_OR_NUM - Consumer project id or number. - ◆ CONNECTION_LIMIT - The max number of allowed connections. + ◆ PROJECT_OR_NETWORK - Consumer project ID, project number or network + URL. + ◆ CONNECTION_LIMIT - The maximum number of allowed connections. --consumer-reject-list=[REJECT_LIST,...] - Specifies a comma separated list of projects that are not allowed to - connect to this service attachment. The project can be specified using - its id or number. + Specifies a comma separated list of projects or networks that are not + allowed to connect to this service attachment. The project can be + specified using its project ID or project number and the network can be + specified using its URL. A given service attachment can manage + connections at either the project or network level. Therefore, both the + reject and accept lists for a given service attachment must contain + either only projects or only networks. --description=DESCRIPTION An optional, textual description for the service attachment. diff --git a/gcloud/alpha/compute/service-attachments/update b/gcloud/alpha/compute/service-attachments/update index 97897e93d..b0a4684ce 100644 --- a/gcloud/alpha/compute/service-attachments/update +++ b/gcloud/alpha/compute/service-attachments/update @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud alpha compute service-attachments update NAME [--connection-preference=CONNECTION_PREFERENCE] - [--consumer-accept-list=[PROJECT=LIMIT,...]] + [--consumer-accept-list=[PROJECT_OR_NETWORK=LIMIT,...]] [--consumer-reject-list=[REJECT_LIST,...]] [--description=DESCRIPTION] [--[no-]enable-proxy-protocol] [--nat-subnets=NAT_SUBNETS,[NAT_SUBNETS,...]] @@ -50,20 +50,31 @@ FLAGS Only accept connection requests from consumers with the approval of the service provider. - --consumer-accept-list=[PROJECT=LIMIT,...] - Adds consumer project(s) with connection limit(s) to the accept list of - the service attachment. + --consumer-accept-list=[PROJECT_OR_NETWORK=LIMIT,...] + Specifies which consumer projects or networks are allowed to connect to + the service attachment. Each project or network has a connection limit. + A given service attachment can manage connections at either the project + or network level. Therefore, both the accept and reject lists for a + given service attachment must contain either only projects or only + networks. For example, --consumer-accept-list myProjectId1=20 accepts a consumer - project myProjectId1 with connection limit 20. + project myProjectId1 with connection limit 20; --consumer-accept-list + projects/myProjectId1/global/networks/myNet1=20 accepts a consumer + network myNet1 with connection limit 20 - ◆ PROJECT_ID_OR_NUM - Consumer project id or number. - ◆ CONNECTION_LIMIT - The max number of allowed connections. + ◆ PROJECT_OR_NETWORK - Consumer project ID, project number or network + URL. + ◆ CONNECTION_LIMIT - The maximum number of allowed connections. --consumer-reject-list=[REJECT_LIST,...] - Specifies a comma separated list of projects that are not allowed to - connect to this service attachment. The project can be specified using - its id or number. + Specifies a comma separated list of projects or networks that are not + allowed to connect to this service attachment. The project can be + specified using its project ID or project number and the network can be + specified using its URL. A given service attachment can manage + connections at either the project or network level. Therefore, both the + reject and accept lists for a given service attachment must contain + either only projects or only networks. --description=DESCRIPTION An optional, textual description for the service attachment. diff --git a/gcloud/alpha/compute/sole-tenancy/node-groups/simulate-maintenance-event b/gcloud/alpha/compute/sole-tenancy/node-groups/simulate-maintenance-event index 859356a9b..5df016174 100644 --- a/gcloud/alpha/compute/sole-tenancy/node-groups/simulate-maintenance-event +++ b/gcloud/alpha/compute/sole-tenancy/node-groups/simulate-maintenance-event @@ -14,8 +14,7 @@ EXAMPLES To simulate maintenance of a node group, run: $ gcloud alpha compute sole-tenancy node-groups \ - simulate-maintenance-event my-node-group \ - --nodes=example-template + simulate-maintenance-event my-node-group --nodes=example-nodes POSITIONAL ARGUMENTS NAME @@ -62,5 +61,8 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta compute sole-tenancy node-groups \ + simulate-maintenance-event diff --git a/gcloud/alpha/compute/ssl-policies/config/export b/gcloud/alpha/compute/ssl-policies/config/export index 1c951ca2d..4bd02862f 100644 --- a/gcloud/alpha/compute/ssl-policies/config/export +++ b/gcloud/alpha/compute/ssl-policies/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-grpc-proxies/config/export b/gcloud/alpha/compute/target-grpc-proxies/config/export index 7454464fe..fa664cfdf 100644 --- a/gcloud/alpha/compute/target-grpc-proxies/config/export +++ b/gcloud/alpha/compute/target-grpc-proxies/config/export @@ -66,7 +66,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-http-proxies/config/export b/gcloud/alpha/compute/target-http-proxies/config/export index c416603bc..6433f68c0 100644 --- a/gcloud/alpha/compute/target-http-proxies/config/export +++ b/gcloud/alpha/compute/target-http-proxies/config/export @@ -66,7 +66,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-https-proxies/config/export b/gcloud/alpha/compute/target-https-proxies/config/export index f177db6d8..721736ddf 100644 --- a/gcloud/alpha/compute/target-https-proxies/config/export +++ b/gcloud/alpha/compute/target-https-proxies/config/export @@ -66,7 +66,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-instances/config/export b/gcloud/alpha/compute/target-instances/config/export index 3a91fc74f..c1f7eadad 100644 --- a/gcloud/alpha/compute/target-instances/config/export +++ b/gcloud/alpha/compute/target-instances/config/export @@ -83,7 +83,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-pools/config/export b/gcloud/alpha/compute/target-pools/config/export index 027e5144f..a8182994d 100644 --- a/gcloud/alpha/compute/target-pools/config/export +++ b/gcloud/alpha/compute/target-pools/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-ssl-proxies/config/export b/gcloud/alpha/compute/target-ssl-proxies/config/export index eea8bcb2d..d2f48fa74 100644 --- a/gcloud/alpha/compute/target-ssl-proxies/config/export +++ b/gcloud/alpha/compute/target-ssl-proxies/config/export @@ -66,7 +66,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-tcp-proxies/config/export b/gcloud/alpha/compute/target-tcp-proxies/config/export index 3bb7147f3..39fd77157 100644 --- a/gcloud/alpha/compute/target-tcp-proxies/config/export +++ b/gcloud/alpha/compute/target-tcp-proxies/config/export @@ -66,7 +66,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/target-vpn-gateways/config/export b/gcloud/alpha/compute/target-vpn-gateways/config/export index f0159b45e..ab0a8c0de 100644 --- a/gcloud/alpha/compute/target-vpn-gateways/config/export +++ b/gcloud/alpha/compute/target-vpn-gateways/config/export @@ -85,7 +85,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/tpus/help b/gcloud/alpha/compute/tpus/help index 462eecc81..0ca962d05 100644 --- a/gcloud/alpha/compute/tpus/help +++ b/gcloud/alpha/compute/tpus/help @@ -34,6 +34,9 @@ GROUPS queued-resources (ALPHA) List, create, delete, and manage Queued Resources. + topologies + (ALPHA) List available Cloud TPU topologies. + tpu-vm (ALPHA) List, create, and manage Cloud TPU VM nodes. diff --git a/gcloud/alpha/compute/tpus/topologies/help b/gcloud/alpha/compute/tpus/topologies/help new file mode 100644 index 000000000..19bf146e3 --- /dev/null +++ b/gcloud/alpha/compute/tpus/topologies/help @@ -0,0 +1,26 @@ +NAME + gcloud alpha compute tpus topologies - list available Cloud TPU topologies + +SYNOPSIS + gcloud alpha compute tpus topologies COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List available Cloud TPU topologies. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + (ALPHA) List available topologies for Cloud TPUs. + +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. + diff --git a/gcloud/alpha/compute/tpus/topologies/list b/gcloud/alpha/compute/tpus/topologies/list new file mode 100644 index 000000000..829984235 --- /dev/null +++ b/gcloud/alpha/compute/tpus/topologies/list @@ -0,0 +1,79 @@ +NAME + gcloud alpha compute tpus topologies list - list available topologies for + Cloud TPUs + +SYNOPSIS + gcloud alpha compute tpus topologies list [--zone=ZONE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List available topologies for for Cloud TPUs. + +EXAMPLES + The following command lists all of the topologies available in zone + us-central1-b: + + $ gcloud alpha compute tpus topologies list --zone=us-central1-b + +FLAGS + Location resource - The zone to list topologies versions for. 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 --zone on the command line with a fully + specified name; + ◆ set the property compute/zone with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --zone=ZONE + ID of the location or fully qualified identifier for the location. To + set the zone attribute: + ▸ provide the argument --zone on the command line; + ▸ set the property compute/zone. + +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 tpu/v2alpha1 API. The full documentation for this API + can be found at: https://cloud.google.com/tpu/ + +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. + diff --git a/gcloud/alpha/compute/tpus/tpu-vm/simulate-maintenance-event b/gcloud/alpha/compute/tpus/tpu-vm/simulate-maintenance-event index cf4807a3e..74b1fa2e1 100644 --- a/gcloud/alpha/compute/tpus/tpu-vm/simulate-maintenance-event +++ b/gcloud/alpha/compute/tpus/tpu-vm/simulate-maintenance-event @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha compute tpus tpu-vm simulate-maintenance-event - (TPU : --zone=ZONE) [--workers=[WORKERS,...]] [GCLOUD_WIDE_FLAG ...] + (TPU : --zone=ZONE) [--async] [--workers=[WORKERS,...]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) For testing the resilience of applications build on top of Cloud @@ -50,6 +51,10 @@ POSITIONAL ARGUMENTS ▸ set the property compute/zone. FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --workers=[WORKERS,...] The zero-based ID(s) of workers on which to simulate maintenance. By default, only the first (ID 0) worker VM is flagged for maintenance. diff --git a/gcloud/alpha/compute/url-maps/config/export b/gcloud/alpha/compute/url-maps/config/export index 039b2aeb3..7419bd515 100644 --- a/gcloud/alpha/compute/url-maps/config/export +++ b/gcloud/alpha/compute/url-maps/config/export @@ -84,7 +84,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/vpn-gateways/config/export b/gcloud/alpha/compute/vpn-gateways/config/export index e2cc0c73d..3edd05b46 100644 --- a/gcloud/alpha/compute/vpn-gateways/config/export +++ b/gcloud/alpha/compute/vpn-gateways/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/compute/vpn-tunnels/config/export b/gcloud/alpha/compute/vpn-tunnels/config/export index edf705fc3..4aa97ed07 100644 --- a/gcloud/alpha/compute/vpn-tunnels/config/export +++ b/gcloud/alpha/compute/vpn-tunnels/config/export @@ -80,7 +80,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/config/get b/gcloud/alpha/config/get new file mode 100644 index 000000000..3862de10d --- /dev/null +++ b/gcloud/alpha/config/get @@ -0,0 +1,1334 @@ +NAME + gcloud alpha config get - print the value of a Google Cloud CLI property + +SYNOPSIS + gcloud alpha config get SECTION/PROPERTY [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha config get prints the property value from your active + client side configuration only. + +EXAMPLES + To print the project property in the core section, run: + + $ gcloud alpha config get project + + To print the zone property in the compute section, run: + + $ gcloud alpha config get compute/zone + +POSITIONAL ARGUMENTS + SECTION/PROPERTY + The property to be fetched. Note that SECTION/ is optional while + referring to properties in the core section. + +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. + +AVAILABLE PROPERTIES + core + account + Account gcloud should use for authentication. Run gcloud auth list + to see your currently available accounts. + + console_log_format + Control the format used to display log messages to the console. + + Valid values are: + ▸ standard - Simplified log messages are displayed on the + console. + ▸ detailed - More detailed messages are displayed on the console. + + If unset, default is standard. + + custom_ca_certs_file + Absolute path to a custom CA cert file. + + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + + default_regional_backend_service + If True, backend services in gcloud compute backend-services will + be regional by default. Setting the --global flag is required for + global backend services. + + disable_color + If True, color will not be used when printing messages in the + terminal. + + disable_file_logging + If True, gcloud will not store logs to a file. This may be useful + if disk space is limited. + + disable_prompts + If True, the default answer will be assumed for all user prompts. + However, for any prompts that require user input, an error will be + raised. This is equivalent to either using the global --quiet flag + or setting the environment variable CLOUDSDK_CORE_DISABLE_PROMPTS + to 1. Setting this property is useful when scripting with gcloud. + + disable_usage_reporting + If True, anonymous statistics on SDK usage will not be collected. + This value is set by your choices during installation, but can be + changed at any time. For more information, see Usage statistics. + + enable_feature_flags + If True, remote config-file driven feature flags will be enabled. + + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + + log_http + If True, log HTTP requests and responses to the logs. To see logs + in the terminal, adjust verbosity settings. Otherwise, logs are + available in their respective log files. + + max_log_days + Maximum number of days to retain log files before deleting. If set + to 0, turns off log garbage collection and does not delete log + files. If unset, the default is 30 days. + + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + + pass_credentials_to_gsutil + If True, pass the configured Google Cloud CLI authentication to + gsutil. + + project + Project ID of the Cloud Platform project to operate on by default. + This can be overridden by using the global --project flag. + + show_structured_logs + Control when JSON-structured log messages for the current verbosity + level (and above) will be written to standard error. If this + property is disabled, logs are formatted as text by default. + + Valid values are: + ▸ never - Log messages as text + ▸ always - Always log messages as JSON + ▸ log - Only log messages as JSON if stderr is a file + ▸ terminal - Only log messages as JSON if stderr is a terminal + + If unset, default is never. + + trace_token + Token used to route traces of service requests for investigation of + issues. This token will be provided by Google support. + + user_output_enabled + True, by default. If False, messages to the user and command output + on both standard output and standard error will be suppressed. + + verbosity + Default logging verbosity for gcloud commands. This is the + equivalent of using the global --verbosity flag. Supported + verbosity levels: debug, info, warning, error, critical, and none. + + accessibility + screen_reader + Make gcloud more screen reader friendly. + + ai + region + Default region to use when working with AI Platform resources. When + a --region flag is required but not provided, the command will fall + back to this value, if set. + + ai_platform + region + Default region to use when working with AI Platform Training and + Prediction resources (currently for Prediction only). It is ignored + for training resources for now. The value should be either global + or one of the supported regions. When a --region flag is required + but not provided, the command will fall back to this value, if set. + + api_endpoint_overrides + accessapproval + Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ + + accesscontextmanager + Overrides API endpoint for gcloud access-context-manager command + group. Defaults to https://accesscontextmanager.googleapis.com/ + + ai + Overrides API endpoint for gcloud ai command group. + + aiplatform + Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ + + anthosevents + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ + + anthospolicycontrollerstatus_pa + Overrides API endpoint for gcloud container fleet policycontroller + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ + + apigateway + Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ + + apigee + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ + + appengine + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ + + artifactregistry + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ + + assuredworkloads + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ + + baremetalsolution + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ + + bigtableadmin + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ + + certificatemanager + Overrides API endpoint for gcloud certificate-manager command + group. Defaults to https://certificatemanager.googleapis.com/ + + cloudasset + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ + + cloudbilling + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ + + cloudbuild + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ + + cloudcommerceconsumerprocurement + Overrides API endpoint for gcloud commerce-procurement command + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ + + clouddebugger + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ + + clouddeploy + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ + + clouderrorreporting + Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ + + cloudfunctions + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ + + cloudidentity + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ + + cloudiot + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ + + cloudkms + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ + + cloudresourcemanager + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ + + cloudscheduler + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ + + cloudtasks + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ + + cloudtrace + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ + + composer + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ + + compute + Overrides API endpoint for gcloud compute command group. For + Private Service Connect usage, see + https://cloud.google.com/vpc/docs/configure-private-service-connect-apis#using-endpoints + + config + Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ + + container + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ + + datacatalog + Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ + + dataflow + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ + + datafusion + Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ + + datamigration + Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ + + datapipelines + Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ + + dataplex + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ + + dataproc + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ + + datastore + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ + + datastream + Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ + + deploymentmanager + Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ + + dns + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ + + domains + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ + + edgecontainer + Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ + + eventarc + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ + + eventarcpublishing + Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ + + events + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ + + file + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ + + firestore + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ + + gameservices + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ + + genomics + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ + + gkemulticloud + Overrides API endpoint for gcloud container aws, gcloud container + azure and gcloud container attached command groups. + + healthcare + Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ + + iam + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ + + iap + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ + + ids + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ + + krmapihosting + Overrides API endpoint for gcloud anthos config controller command + group. Defaults to https://krmapihosting.googleapis.com/ + + language + Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ + + lifesciences + Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ + + logging + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ + + managedidentities + Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ + + mediaasset + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ + + memcache + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ + + metastore + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ + + monitoring + Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ + + networkconnectivity + Overrides API endpoint for gcloud network-connectivity command + group. Defaults to https://networkconnectivity.googleapis.com/ + + networkmanagement + Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ + + networksecurity + Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ + + networkservices + Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ + + notebooks + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ + + orgpolicy + Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ + + policyanalyzer + Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ + + privateca + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ + + publicca + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ + + pubsub + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ + + recaptchaenterprise + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ + + recommender + Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ + + redis + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ + + resourcesettings + Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ + + run + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ + + runtimeconfig + Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ + + sddc + Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ + + secretmanager + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ + + securitycenter + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ + + servicedirectory + Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ + + servicemanagement + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ + + sourcerepo + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ + + spanner + Overrides API endpoint for gcloud spanner command group. For + spanner emulator usage, see + https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator + + speech + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ + + sql + Overrides API endpoint for gcloud sql command group. + + storage + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ + + testing + Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ + + vision + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ + + vmwareengine + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ + + workflowexecutions + Overrides API endpoint for gcloud workflows executions command + group. Defaults to https://workflowexecutions.googleapis.com/ + + workflows + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ + + app + cloud_build_timeout + Timeout, in seconds, to wait for Docker builds to complete during + deployments. All Docker builds now use the Cloud Build API. + + promote_by_default + If True, when deploying a new version of a service, that version + will be promoted to receive all traffic for the service. This + property can be overridden with the --promote-by-default or + --no-promote-by-default flags. + + stop_previous_version + If True, when deploying a new version of a service, the previously + deployed version is stopped. If False, older versions must be + stopped manually. + + use_runtime_builders + If set, opt in/out to a new code path for building applications + using pre-fabricated runtimes that can be updated independently of + client tooling. If not set, the default path for each runtime is + used. + + artifacts + location + Default location to use when working with Artifact Registry + resources. When a location value is required but not provided, the + command will fall back to this value, if set. If this value is + unset, the default location is global when location value is + optional. + + repository + Default repository to use when working with Artifact Registry + resources. When a repository value is required but not provided, + the command will fall back to this value, if set. + + auth + access_token_file + A file path to read the access token. Use this property to + authenticate gcloud with an access token. The credentials of the + active account (if it exists) will be ignored. The file should + contain an access token with no other information. + + disable_credentials + If True, gcloud will not attempt to load any credentials or + authenticate any requests. This is useful when behind a proxy that + adds authentication to requests. + + impersonate_service_account + While set, all API requests will be made as the given service + account or target service account in an impersonation delegation + chain instead of the currently selected account. You can specify + either a single service account as the impersonator, or a + comma-separated list of service accounts to create an impersonation + delegation chain. This is done without needing to create, download, + or activate a key for the service account or accounts. + + In order to make API requests as a service account, your currently + selected account must have an IAM role that includes the + iam.serviceAccounts.getAccessToken permission for the service + account or accounts. + + The roles/iam.serviceAccountTokenCreator role has the + iam.serviceAccounts.getAccessToken permission. You can also create + a custom role. + + You can specify a list of service accounts, separated with commas. + This creates an impersonation delegation chain in which each + service account delegates its permissions to the next service + account in the chain. Each service account in the list must have + the roles/iam.serviceAccountTokenCreator role on the next service + account in the list. For example, when the property is set through + gcloud config set auth/impersonate_service_account= + SERVICE_ACCOUNT_1,SERVICE_ACCOUNT_2, the active account must have + the roles/iam.serviceAccountTokenCreator role on SERVICE_ACCOUNT_1, + which must have the roles/iam.serviceAccountTokenCreator role on + SERVICE_ACCOUNT_2. SERVICE_ACCOUNT_1 is the impersonated service + account and SERVICE_ACCOUNT_2 is the delegate. + + token_host + Overrides the token endpoint to provision access tokens. It can be + used with Private Service Connect. + + batch + location + Default location to use when working with Batch resources. When a + location value is required but not provided, the command will fall + back to this value, if set. + + billing + quota_project + The Google Cloud project that is billed and charged quota for + operations performed in gcloud. When unset, the default is + [CURRENT_PROJECT]. This default bills and charges quota against the + current project. If you need to operate on one project, but need to + bill your usage against or use quota from a different project, you + can use this flag to specify the billing project. If both + billing/quota_project and --billing-project are specified, + --billing-project takes precedence. + + builds + kaniko_cache_ttl + TTL, in hours, of cached layers when using Kaniko. If zero, layer + caching is disabled. + + region + Default region to use when working with Cloud Build resources. When + a --region flag is required but not provided, the command will fall + back to this value, if set. + + timeout + Timeout, in seconds, to wait for builds to complete. If unset, + defaults to 10 minutes. + + use_kaniko + If True, kaniko will be used to build images described by a + Dockerfile, instead of docker build. + + component_manager + additional_repositories + Comma separated list of additional repositories to check for + components. This property is automatically managed by the gcloud + components repositories commands. + + disable_update_check + If True, Google Cloud CLI will not automatically check for updates. + + composer + location + Composer location to use. Each Composer location constitutes an + independent resource namespace constrained to deploying + environments into Compute Engine regions inside this location. This + parameter corresponds to the /locations/ segment of the + Composer resource URIs being referenced. + + compute + image_family_scope + Sets how images are selected with image families for disk and + instance creation. By default, zonal image resources are used when + using an image family in a public image project, and global image + resources are used for all other projects. To override the default + behavior, set this property to zonal or global. + + region + Default region to use when working with regional Compute Engine + resources. When a --region flag is required but not provided, the + command will fall back to this value, if set. To see valid choices, + run gcloud compute regions list. + + use_new_list_usable_subnets_api + If True, use the new API for listing usable subnets which only + returns subnets in the current project. + + zone + Default zone to use when working with zonal Compute Engine + resources. When a --zone flag is required but not provided, the + command will fall back to this value, if set. To see valid choices, + run gcloud compute zones list. + + container + build_timeout + Timeout, in seconds, to wait for container builds to complete. + + cluster + Name of the cluster to use by default when working with Kubernetes + Engine. + + use_application_default_credentials + If True, use application default credentials to authenticate to the + cluster API server. + + use_client_certificate + If True, use the cluster's client certificate to authenticate to + the cluster API server. + + container_attached + location + Default Google Cloud location to use for Attached clusters. + + container_aws + location + Default Google Cloud location to use for Anthos clusters on AWS. + + container_azure + location + Default Google Cloud location to use for Anthos clusters on Azure. + + container_bare_metal + location + Default Google Cloud location to use for Anthos clusters on Bare + Metal. + + container_vmware + location + Default Google Cloud location to use for Anthos clusters on VMware. + + context_aware + use_client_certificate + If True, use client certificate to authorize user device using + Context-aware access. This includes user login as well. Some + services may not support client certificate authorization. If a + command sends requests to such services, the client certificate + will not be validated. Run gcloud topic client-certificate for list + of services supporting this feature. + + dataflow + disable_public_ips + Specifies that Cloud Dataflow workers must not use public IP + addresses. + + enable_streaming_engine + Set this to true to enable Streaming Engine for the job. + + print_only + Prints the container spec to stdout. Does not save in Google Cloud + Storage. + + datafusion + location + Datafusion location to use. Each Datafusion location constitutes an + independent resource namespace constrained to deploying + environments into Compute Engine regions inside this location. This + parameter corresponds to the /locations/ segment of the + Datafusion resource URIs being referenced. + + datapipelines + disable_public_ips + Specifies that Cloud Dataflow workers must not use public IP + addresses. + + enable_streaming_engine + Set this to true to enable Streaming Engine for the job. + + dataplex + asset + Dataplex asset to use. When an asset is required but not provided + by a flag, the command will fall back to this value, if set. + + lake + Dataplex lake to use. When a lake is required but not provided by a + flag, the command will fall back to this value, if set. + + location + Dataplex location to use. When a location is required but not + provided by a flag, the command will fall back to this value, if + set. + + zone + Dataplex zone to use. When a zone is required but not provided by a + flag, the command will fall back to this value, if set. + + dataproc + location + Dataproc location to use. Each Dataproc location constitutes an + independent resource namespace constrained to deploying instances + into Compute Engine zones inside the location. + + region + Dataproc region to use. Each Dataproc region constitutes an + independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. + + deploy + delivery_pipeline + Delivery Pipeline being managed by Cloud Deploy. + + region + Cloud Deploy region to use. Each Cloud Deploy region constitutes an + independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. + + deployment_manager + glob_imports + Enable import path globbing. Uses glob patterns to match multiple + imports in a config file. + + eventarc + location + The default location to use when working with Eventarc resources. + This should be either global or one of the supported regions. When + a --location flag is required but not provided, the command will + fall back to this value, if set. + + filestore + location + Please use the --location flag or set the filestore/zone or + filestore/region property. + + region + Default region to use when working with Cloud Filestore regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + + zone + Default zone to use when working with Cloud Filestore zones. When a + --zone flag is required but not provided, the command will fall + back to this value, if set. + + functions + gen2 + Default environment to use when working with Cloud Functions + resources. When neither --gen2 nor --no-gen2 is provided, the + decision of whether to use Generation 2 falls back to this value. + + region + Default region to use when working with Cloud Functions resources. + When a --region flag is required but not provided, the command will + fall back to this value, if set. To see valid choices, run gcloud + beta functions regions list. + + game_services + default_deployment + Default deployment to use when working with Cloud Game Services + list configs. When a --deployment flag is required in a list + command but not provided, the command will fall back to this value + which envokes aggregated list from the backend. + + default_realm + Default realm to use when working with Cloud Game Services list + clusters. When a --realm flag is required in a list command but not + provided, the command will fall back to this value which envokes + aggregated list from the backend. + + location + Default location to use when working with Cloud Game Services + resources. When a --location flag is required but not provided, the + command will fall back to this value. + + gcloudignore + enabled + If True, do not upload .gcloudignore files (see $ gcloud topic + gcloudignore). If False, turn off the gcloudignore mechanism + entirely and upload all files. + + gkebackup + backup + Default backup ID to use when working with Backup for GKE Services + resources. When a --backup flag is required but not provided, the + command will fall back to this value. + + backup_plan + Default backup plan ID to use when working with Backup for GKE + Services resources. When a --backup-plan flag is required but not + provided, the command will fall back to this value. + + location + Default location to use when working with Backup for GKE Services + resources. When a --location flag is required but not provided, the + command will fall back to this value. + + restore + Default restore ID to use when working with Backup for GKE Services + resources. When a --restore flag is required but not provided, the + command will fall back to this value. + + restore_plan + Default restore plan ID to use when working with Backup for GKE + Services resources. When a --restore-plan flag is required but not + provided, the command will fall back to this value. + + healthcare + dataset + Default dataset to use when working with Cloud Healthcare + resources. When a --dataset flag is required but not provided, the + command will fall back to this value, if set. + + location + Default location to use when working with Cloud Healthcare + resources. When a --location flag is required but not provided, the + command will fall back to this value. + + interactive + bottom_bindings_line + If True, display the bottom key bindings line. + + bottom_status_line + If True, display the bottom status line. + + completion_menu_lines + Number of lines in the completion menu. + + context + Command context string. + + fixed_prompt_position + If True, display the prompt at the same position. + + help_lines + Maximum number of help snippet lines. + + hidden + If True, expose hidden commands/flags. + + justify_bottom_lines + If True, left- and right-justify bottom toolbar lines. + + manpage_generator + If True, use the manpage CLI tree generator for unsupported + commands. + + multi_column_completion_menu + If True, display the completions as a multi-column menu. + + prompt + Command prompt string. + + show_help + If True, show help as command args are being entered. + + suggest + If True, add command line suggestions based on history. + + lifesciences + location + Default location to use when working with Cloud Life Sciences + resources. When a --location flag is required but not provided, the + command will fall back to this value. + + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + + media_asset + location + Default location to use when working with Cloud Media Asset + resources. When a --location flag is required but not provided, the + command will fall back to this value. + + memcache + region + Default region to use when working with Cloud Memorystore for + Memcached resources. When a region is required but not provided by + a flag, the command will fall back to this value, if set. + + metastore + location + Default location to use when working with Dataproc Metastore. When + a location is required but not provided by a flag, the command will + fall back to this value, if set. + + tier + Default tier to use when creating Dataproc Metastore services. When + a tier is required but not provided by a flag, the command will + fall back to this value, if set. + + Valid values are: + ▸ developer - The developer tier provides limited scalability and + no fault tolerance. Good for low-cost proof-of-concept. + ▸ enterprise - The enterprise tier provides multi-zone high + availability, and sufficient scalability for enterprise-level + Dataproc Metastore workloads. + + ml_engine + local_python + Full path to the Python interpreter to use for Cloud ML Engine + local predict/train jobs. If not specified, the default path is the + one to the Python interpreter found on system PATH. + + polling_interval + Interval (in seconds) at which to poll logs from your Cloud ML + Engine jobs. Note that making it much faster than the default (60) + will quickly use all of your quota. + + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + + notebooks + location + Default location to use when working with Notebook resources. When + a location value is required but not provided, the command will + fall back to this value, if set. + + privateca + location + Default location to use when working with Private CA resources. + When a --location flag is required but not provided, the command + will fall back to this value, if set. + + proxy + address + Hostname or IP address of proxy server. + + password + Password to use when connecting, if the proxy requires + authentication. + + port + Port to use when connected to the proxy server. + + rdns + If True, DNS queries will not be performed locally, and instead, + handed to the proxy to resolve. This is default behavior. + + type + Type of proxy being used. Supported proxy types are: [http, + http_no_tunnel, socks4, socks5]. + + username + Username to use when connecting, if the proxy requires + authentication. + + redis + region + Default region to use when working with Cloud Memorystore for Redis + resources. When a region is required but not provided by a flag, + the command will fall back to this value, if set. + + run + cluster + ID of the cluster or fully qualified identifier for the cluster + + cluster_location + Zone or region in which the cluster is located. + + platform + Target platform for running commands. + + region + Default region to use when working with Cloud Run resources. When a + --region flag is required but not provided, the command will fall + back to this value, if set. + + scc + organization + Default organization gcloud should use for scc surface. + + parent + Default parent gcloud should use for scc surface. + + secrets + locations + A comma separated list of the locations to replicate secrets to. + Only applies to secrets with a user-managed policy. + + replication-policy + The type of replication policy to apply to secrets. Allowed values + are "automatic" and "user-managed". If user-managed then locations + must also be provided. + + spanner + instance + Default instance to use when working with Cloud Spanner resources. + When an instance is required but not provided by a flag, the + command will fall back to this value, if set. + + ssh + putty_force_connect + Whether or not gcloud should automatically accept new or changed + host keys when executing plink/pscp commands on Windows. Defaults + to True, but can be set to False to present these interactive + prompts to the user for host key checking. + + verify_internal_ip + Whether or not gcloud should perform an initial SSH connection to + verify an instance ID is correct when connecting via its internal + IP. Without this check, gcloud will simply connect to the internal + IP of the desired instance, which may be wrong if the desired + instance is in a different subnet but happens to share the same + internal IP as an instance in the current subnet. Defaults to True. + + storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + + base_retry_delay + Second delay between retrying operations. May be multiplied by + exponential_sleep_multiplier. + + check_hashes + 'check_hashes' specifies how strictly to require integrity checking + for downloaded data. Legal values are: + + ▸ 'if_fast_else_fail' - (default) Only integrity check if the + digest will run efficiently (using compiled code), else fail the + download. + + ▸ 'if_fast_else_skip' - Only integrity check if the server + supplies a hash and the local digest computation will run + quickly, else skip the check. + + ▸ 'always' - Always check download integrity regardless of + possible performance costs. + + ▸ 'never' - Don't perform download integrity checks. This setting + is not recommended except for special cases such as measuring + download performance excluding time for integrity checking. + + This option exists to assist users who wish to download a composite + object and are unable to install crcmod with the C-extension. + CRC32c is the only available integrity check for composite objects, + and without the C-extension, download performance can be + significantly degraded by the digest computation. This option is + ignored for daisy-chain copies, which don't compute hashes but + instead (inexpensively) compare the cloud source and destination + hashes. + + check_mv_early_deletion_fee + Block mv commands that may incur an early deletion fee (the source + object in a mv is deleted). + + convert_incompatible_windows_path_characters + Allows automatic conversion of invalid path characters on Windows. + If not enabled, Windows will raise an OSError if an invalid + character is encountered. + + copy_chunk_size + Chunk size used for copying to in clouds or on disk. + + download_chunk_size + Chunk size used for downloadinging to clouds. + + exponential_sleep_multiplier + Used in exponential backoff for retrying operations. + + key_store_path + Path to a yaml file containing an encryption key, and multiple + decryption keys for use in storage commands. The file must be + formatted as follows: + + encryption_key: {A customer-supplied or customer-managed key.} + decryption_keys: + - {A customer-supplied key} + ... + + Customer-supplied encryption keys must be RFC 4648 section 4 + base64-encoded AES256 strings. Customer-managed encryption keys + must be of the form + projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}. + + max_retries + Max number of retries for operations like copy. + + max_retry_delay + Max second delay between retriable operations. + + parallel_composite_upload_compatibility_check + Determines if the GET bucket call should be performed to check if + the default storage class and retention period for the destination + bucket meet the criteria for parallel composite upload. + + parallel_composite_upload_component_size + Specifies the ideal size of a component in bytes, which will act as + an upper bound to the size of the components if ceil(file_size / + parallel_composite_upload_component_size) is less than the maximum + number of objects the API allows composing at once. Values can be + provided either in bytes or as human-readable values (e.g., "150M" + to represent 150 mebibytes). + + parallel_composite_upload_enabled + Determines whether parallel composite upload should be used. + Default value is None which will use parallel composite upload and + log an appropriate warning for the user explaining that parallel + composite upload is being used by default. + + parallel_composite_upload_threshold + Specifies the maximum size of a file to upload in a single stream. + Files larger than this threshold will be partitioned into component + parts, uploaded in parallel, then composed into a single object. + The number of components will be the smaller of ceil(file_size / + parallel_composite_upload_component_size) and the maximum number of + objects the API allows composing at once. For Cloud Storage this + limit is 32. This property has no effect if + parallel_composite_upload_enabled is set to False. + + process_count + The maximum number of processes parallel execution should use. When + process_count and thread_count are both 1, commands use sequential + execution. + + resumable_threshold + File operations above this size in bytes will use resumable instead + of one-shot strategies. For example, a resumable download. + + s3_endpoint_url + If set, boto3 client will connect to this endpoint. Otherwise, + boto3 selects a default endpoint based on the AWS service used. + + sliced_object_download_component_size + Target size and upper bound for files to be sliced into. Analogous + to parallel_composite_upload_component_size. + + sliced_object_download_max_components + Specifies the maximum number of slices to be used when performing a + sliced object download. Set None for no limit. + + sliced_object_download_threshold + Slice files larger than this value. Zero will block sliced + downloads. Analogous to parallel_composite_upload_threshold. + + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + + thread_count + The number of threads parallel execution should use per process. + When process_count and thread_count are both 1, commands use + sequential execution. + + tracker_files_directory + Directory path to tracker files for resumable operations. + + upload_chunk_size + Chunk size used for uploading to clouds. + + use_gcloud_crc32c + If True, data integrity checks use a binary subprocess to calculate + CRC32C hashes with the included gcloud-crc32c tool rather than the + google-crc32c Python library. This behavior is also triggered when + the google-crc32c Python library is unavailable even if this + property is False. + + use_gsutil + If True, use the deprecated upload implementation which uses + gsutil. + + use_magicfile + If True, uses the file --mime command to guess content + types instead of the default filename extension-based mechanism. + Available on UNIX and macOS (and possibly on Windows, if you're + running Cygwin or some other package that provides implementations + of UNIX-like commands). When available and enabled use_magicfile + should be more robust because it analyzes file contents in addition + to extensions. + + use_threading_local + If True, reuses some resource if they are already declared on a + thread. If False, creates duplicates of resources like API clients + on the same thread. Turning off can help with some bugs but will + hurt performance. + + survey + disable_prompts + If True, gcloud will not prompt you to take periodic usage + experience surveys. + + vmware + region + Default region to use when working with VMware Engine resources. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + +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 config get + + $ gcloud beta config get + diff --git a/gcloud/alpha/config/help b/gcloud/alpha/config/help index b9992096d..c356a28c2 100644 --- a/gcloud/alpha/config/help +++ b/gcloud/alpha/config/help @@ -49,6 +49,9 @@ GROUPS COMMANDS COMMAND is one of the following: + get + (ALPHA) Print the value of a Google Cloud CLI property. + list (ALPHA) List Google Cloud CLI properties for the currently active configuration. @@ -78,6 +81,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -106,6 +121,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -116,6 +142,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -171,97 +202,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -270,69 +328,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -340,110 +420,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -451,29 +572,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -892,6 +1019,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -933,6 +1066,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1028,6 +1172,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1153,6 +1302,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/alpha/config/list b/gcloud/alpha/config/list index d1dd6972e..8a60db09e 100644 --- a/gcloud/alpha/config/list +++ b/gcloud/alpha/config/list @@ -7,30 +7,36 @@ SYNOPSIS [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha config list lists all properties of the active - configuration. These include the account used to authorize access to Google - Cloud, the current Google Cloud project, and the default Compute Engine - region and zone, if set. See gcloud topic configurations for more about - configurations. + (ALPHA) gcloud alpha config list lists the properties of the specified + section using the active configuration. These include the account used to + authorize access to Google Cloud, the current Google Cloud project, and the + default Compute Engine region and zone, if set. See gcloud topic + configurations for more about configurations. EXAMPLES - To list the project property in the core section, run: + To list the set project property in the core section, run: $ gcloud alpha config list project - To list the zone property in the compute section, run: + To list the set zone property in the compute section, run: $ gcloud alpha config list compute/zone - To list all the properties in the compute section, run: + To list all the set properties in the compute section, run: $ gcloud alpha config list compute/ + To list all the properties in the compute section, run: + + $ gcloud alpha config list compute/ --all + To list all the properties, run: $ gcloud alpha config list --all - Note, you cannot specify both --all and a property name. + Note, you cannot specify both --all and a property name. Only a section + name and the --all flag can be used together in the format gcloud config + list
/ --all. POSITIONAL ARGUMENTS [SECTION/PROPERTY] @@ -87,6 +93,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -115,6 +133,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -125,6 +154,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -180,97 +214,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -279,69 +340,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -349,110 +432,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -460,29 +584,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -901,6 +1031,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -942,6 +1078,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1037,6 +1184,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1162,6 +1314,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/alpha/config/set b/gcloud/alpha/config/set index 3e8acb1dd..57b1c9178 100644 --- a/gcloud/alpha/config/set +++ b/gcloud/alpha/config/set @@ -96,6 +96,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -124,6 +136,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -134,6 +157,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -189,97 +217,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -288,69 +343,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -358,110 +435,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -469,29 +587,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -910,6 +1034,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -951,6 +1081,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1046,6 +1187,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1171,6 +1317,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/alpha/config/unset b/gcloud/alpha/config/unset index b00638560..ae4aa3bb4 100644 --- a/gcloud/alpha/config/unset +++ b/gcloud/alpha/config/unset @@ -57,6 +57,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -85,6 +97,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -95,6 +118,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -150,97 +178,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -249,69 +304,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -319,110 +396,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -430,29 +548,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -871,6 +995,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -912,6 +1042,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1007,6 +1148,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1132,6 +1278,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/alpha/container/attached/clusters/delete b/gcloud/alpha/container/attached/clusters/delete new file mode 100644 index 000000000..921f9d7ce --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/delete @@ -0,0 +1,79 @@ +NAME + gcloud alpha container attached clusters delete - delete a registered + AttachedCluster resource + +SYNOPSIS + gcloud alpha container attached clusters delete + (CLUSTER : --location=LOCATION) [--allow-missing] [--async] + [--ignore-errors] [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a registered AttachedCluster resource. + +EXAMPLES + To delete an AttachedCluster resource named my-cluster managed in location + us-west1, run: + + $ gcloud alpha container attached clusters delete my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --ignore-errors + Force delete an Attached cluster. Deletion of Attached cluster will + succeed even if errors occur during deleting in-cluster resources. + Using this parameter may result in orphaned resources in the cluster. + + --validate-only + Validate the cluster to delete, but don't actually perform it. + +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 container attached clusters delete + diff --git a/gcloud/alpha/container/attached/clusters/describe b/gcloud/alpha/container/attached/clusters/describe new file mode 100644 index 000000000..d2f34a21c --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/describe @@ -0,0 +1,60 @@ +NAME + gcloud alpha container attached clusters describe - describe an Attached + cluster + +SYNOPSIS + gcloud alpha container attached clusters describe + (CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an Attached cluster. + +EXAMPLES + To describe a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container attached clusters describe my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 container attached clusters describe + diff --git a/gcloud/alpha/container/attached/clusters/generate-install-manifest b/gcloud/alpha/container/attached/clusters/generate-install-manifest new file mode 100644 index 000000000..5141494a8 --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/generate-install-manifest @@ -0,0 +1,82 @@ +NAME + gcloud alpha container attached clusters generate-install-manifest - + generate Install Manifest for an Attached cluster + +SYNOPSIS + gcloud alpha container attached clusters generate-install-manifest + (CLUSTER : --location=LOCATION) --platform-version=PLATFORM_VERSION + [--output-file=OUTPUT_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Generate Install Manifest for an Attached cluster. + +EXAMPLES + To generate install manifest for cluster named my-cluster managed in + location us-west1, run: + + $ gcloud alpha container attached clusters \ generate-install-manifest my-cluster --location=us-west1 \ + --platform-version=PLATFORM_VERSION + + To store the manifest in a file named manifest.yaml, run: + + $ gcloud alpha container attached clusters \ generate-install-manifest my-cluster --location=us-west1 \ + --platform-version=PLATFORM_VERSION --output-file=manifest.yaml + +POSITIONAL ARGUMENTS + Cluster resource - cluster to generate install manifest. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +REQUIRED FLAGS + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + +OPTIONAL FLAGS + --output-file=OUTPUT_FILE + Path to the output file to store manifest. + +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 container attached clusters generate-install-manifest + diff --git a/gcloud/alpha/container/attached/clusters/get-credentials b/gcloud/alpha/container/attached/clusters/get-credentials new file mode 100644 index 000000000..b9473ccb6 --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/get-credentials @@ -0,0 +1,85 @@ +NAME + gcloud alpha container attached clusters get-credentials - get credentials + of an Attached cluster + +SYNOPSIS + gcloud alpha container attached clusters get-credentials + (CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Fetch credentials for a running Attached cluster. + + This command updates a kubeconfig file with appropriate credentials and + endpoint information to point kubectl at a specific Attached cluster. + + By default, credentials are written to HOME/.kube/config. You can provide + an alternate path by setting the KUBECONFIG environment variable. If + KUBECONFIG contains multiple paths, the first one is used. + + This command enables switching to a specific cluster, when working with + multiple clusters. It can also be used to access a previously created + cluster from a new workstation. + + By default, the command will configure kubectl to automatically refresh its + credentials using the same identity as the gcloud command-line tool. If you + are running kubectl as part of an application, it is recommended to use + application default credentials + (https://cloud.google.com/docs/authentication/production). To configure a + kubeconfig file to use application default credentials, set the + container/use_application_default_credentials Google Cloud CLI property + (https://cloud.google.com/sdk/docs/properties) to true before running the + command. + + See https://cloud.google.com/kubernetes-engine/docs/kubectl for kubectl + documentation. + +EXAMPLES + To get credentials of a cluster named my-cluster managed in location + us-west1, run: + + $ gcloud alpha container attached clusters get-credentials \ + my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to get credentials. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 container attached clusters get-credentials + diff --git a/gcloud/alpha/container/attached/clusters/help b/gcloud/alpha/container/attached/clusters/help new file mode 100644 index 000000000..5c848ba64 --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/help @@ -0,0 +1,50 @@ +NAME + gcloud alpha container attached clusters - create and manage Attached + clusters + +SYNOPSIS + gcloud alpha container attached clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Attached clusters. + +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 registered AttachedCluster resource. + + describe + (ALPHA) Describe an Attached cluster. + + generate-install-manifest + (ALPHA) Generate Install Manifest for an Attached cluster. + + get-credentials + (ALPHA) Get credentials of an Attached cluster. + + import + (ALPHA) Import fleet membership for an Attached cluster. + + list + (ALPHA) List Attached clusters. + + register + (ALPHA) Register an Attached cluster. + + update + (ALPHA) Update an Attached cluster. + +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 container attached clusters + diff --git a/gcloud/alpha/container/attached/clusters/import b/gcloud/alpha/container/attached/clusters/import new file mode 100644 index 000000000..002a6aaf4 --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/import @@ -0,0 +1,130 @@ +NAME + gcloud alpha container attached clusters import - import fleet membership + for an Attached cluster + +SYNOPSIS + gcloud alpha container attached clusters import --distribution=DISTRIBUTION + --platform-version=PLATFORM_VERSION + (--context=CONTEXT : --kubeconfig=KUBECONFIG) + (--fleet-membership=FLEET_MEMBERSHIP + : --fleet-membership-location=FLEET_MEMBERSHIP_LOCATION; + default="global") [--async] [--location=LOCATION] [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import fleet membership for an Attached cluster. + +EXAMPLES + To import the fleet membership of an attached cluster in fleet + FLEET_MEMBERSHIP managed in location us-west1, run: + + $ gcloud alpha container attached clusters import \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-membership=FLEET_MEMBERSHIP \ + --distribution=DISTRIBUTION --context=CLUSTER_CONTEXT \ + --kubeconfig=KUBECONFIG_PATH + +REQUIRED FLAGS + --distribution=DISTRIBUTION + Set the base platform type of the cluster to attach. + + Examples: + + $ gcloud alpha container attached clusters import --distribution=aks + $ gcloud alpha container attached clusters import --distribution=eks + + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + + kubectl config + + This must be specified. + + --context=CONTEXT + Context to use in the kubeconfig. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kubeconfig=KUBECONFIG + Path to the kubeconfig file. + + If not provided, the default at ~/.kube/config will be used. + + Fleet membership resource - Membership of the registered cluster. + Membership can be the membership ID or the full resource name. 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 --fleet-membership 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. + + --fleet-membership=FLEET_MEMBERSHIP + ID of the fleet_membership or fully qualified identifier for the + fleet_membership. To set the fleet_membership attribute: + ▸ provide the argument --fleet-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --fleet-membership-location=FLEET_MEMBERSHIP_LOCATION; default="global" + Google Cloud location for the fleet_membership. To set the location + attribute: + ▸ provide the argument --fleet-membership on the command line with + a fully specified name; + ▸ provide the argument --fleet-membership-location on the command + line; + ▸ set the property container_attached/location. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Location resource - Google Cloud location to import attached cluster.. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + + --validate-only + Validate the cluster to import, but don't actually perform it. + +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 container attached clusters import + diff --git a/gcloud/alpha/container/attached/clusters/list b/gcloud/alpha/container/attached/clusters/list new file mode 100644 index 000000000..13827275f --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/list @@ -0,0 +1,81 @@ +NAME + gcloud alpha container attached clusters list - list Attached clusters + +SYNOPSIS + gcloud alpha container attached clusters list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Attached clusters. + +EXAMPLES + To lists all clusters managed in location us-west1, run: + + $ gcloud alpha container attached clusters list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list. 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 + 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 container attached clusters list + diff --git a/gcloud/alpha/container/attached/clusters/register b/gcloud/alpha/container/attached/clusters/register new file mode 100644 index 000000000..434fcb577 --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/register @@ -0,0 +1,177 @@ +NAME + gcloud alpha container attached clusters register - register an Attached + cluster + +SYNOPSIS + gcloud alpha container attached clusters register + (CLUSTER : --location=LOCATION) --distribution=DISTRIBUTION + --fleet-project=FLEET_PROJECT --platform-version=PLATFORM_VERSION + (--context=CONTEXT : --kubeconfig=KUBECONFIG) + (--has-private-issuer | --issuer-url=ISSUER_URL) + [--admin-users=[USER,...]] [--annotations=ANNOTATION,[ANNOTATION,...]] + [--description=DESCRIPTION] [--enable-managed-prometheus] + [--logging=COMPONENT,[COMPONENT,...]] [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Register an Attached cluster. + +EXAMPLES + Register a cluster to a fleet. + + To register a cluster with a private OIDC issuer, run: + + $ gcloud alpha container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --has-private-issuer + + To register a cluster with a public OIDC issuer, run: + + $ gcloud alpha container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --issuer-url=https://ISSUER_URL + + To specify a kubeconfig file, run: + + $ gcloud alpha container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --has-private-issuer \ + --kubeconfig=KUBECONFIG_PATH + + To register and set cluster admin users, run: + + $ gcloud alpha container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --issuer-url=https://ISSUER_URL \ + --admin-users=USER1,USER2 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to register. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +REQUIRED FLAGS + --distribution=DISTRIBUTION + Set the base platform type of the cluster to attach. + + Examples: + + $ gcloud alpha container attached clusters register \ + --distribution=aks + $ gcloud alpha container attached clusters register \ + --distribution=eks + + --fleet-project=FLEET_PROJECT + ID or number of the Fleet host project where the cluster is registered. + + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + + kubectl config + + This must be specified. + + --context=CONTEXT + Context to use in the kubeconfig. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kubeconfig=KUBECONFIG + Path to the kubeconfig file. + + If not provided, the default at ~/.kube/config will be used. + + OIDC config + + Exactly one of these must be specified: + + --has-private-issuer + Indicates no publicly routable OIDC discovery endpoint exists for the + Kubernetes service account token issuer. + + If this flag is set, gcloud will read the issuer URL and JWKs from + the cluster's api server. + + --issuer-url=ISSUER_URL + Issuer url of the cluster to attach. + +OPTIONAL FLAGS + --admin-users=[USER,...] + Users that can perform operations as a cluster administrator. + + There is no way to completely remove admin users after setting. + + --annotations=ANNOTATION,[ANNOTATION,...] + Annotations for the cluster. + + --description=DESCRIPTION + Description for the cluster. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + + --logging=COMPONENT,[COMPONENT,...] + Set the components that have logging enabled. + + Examples: + + $ gcloud alpha container attached clusters register --logging=SYSTEM + $ gcloud alpha container attached clusters register \ + --logging=SYSTEM,WORKLOAD + $ gcloud alpha container attached clusters register --logging=NONE + + COMPONENT must be one of: NONE, SYSTEM, WORKLOAD. + + --validate-only + Validate the cluster to create, but don't actually perform it. + +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 container attached clusters register + diff --git a/gcloud/alpha/container/attached/clusters/update b/gcloud/alpha/container/attached/clusters/update new file mode 100644 index 000000000..7e475d2ea --- /dev/null +++ b/gcloud/alpha/container/attached/clusters/update @@ -0,0 +1,120 @@ +NAME + gcloud alpha container attached clusters update - update an Attached + cluster + +SYNOPSIS + gcloud alpha container attached clusters update + (CLUSTER : --location=LOCATION) [--admin-users=[USER,...]] + [--annotations=ANNOTATION,[ANNOTATION,...]] [--async] + [--clear-description] [--description=DESCRIPTION] + [--logging=COMPONENT,[COMPONENT,...]] + [--platform-version=PLATFORM_VERSION] [--validate-only] + [--disable-managed-prometheus | --enable-managed-prometheus] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an Attached cluster. + +EXAMPLES + To update a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container attached clusters update my-cluster \ + --location=us-west1 --description=testcluster + +POSITIONAL ARGUMENTS + Cluster resource - cluster to update. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +FLAGS + --admin-users=[USER,...] + Users that can perform operations as a cluster administrator. + + There is no way to completely remove admin users after setting. + + --annotations=ANNOTATION,[ANNOTATION,...] + Annotations for the cluster. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --clear-description + Clear the description for the cluster. + + --description=DESCRIPTION + Description for the cluster. + + --logging=COMPONENT,[COMPONENT,...] + Set the components that have logging enabled. + + Examples: + + $ gcloud alpha container attached clusters update --logging=SYSTEM + $ gcloud alpha container attached clusters update \ + --logging=SYSTEM,WORKLOAD + $ gcloud alpha container attached clusters update --logging=NONE + + COMPONENT must be one of: NONE, SYSTEM, WORKLOAD. + + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + + --validate-only + Validate the update of the cluster, but don't actually perform it. + + Monitoring Config + + At most one of these can be specified: + + --disable-managed-prometheus + Disable managed collection for Managed Service for Prometheus. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + +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 container attached clusters update + diff --git a/gcloud/alpha/container/attached/get-server-config b/gcloud/alpha/container/attached/get-server-config new file mode 100644 index 000000000..392734d5e --- /dev/null +++ b/gcloud/alpha/container/attached/get-server-config @@ -0,0 +1,52 @@ +NAME + gcloud alpha container attached get-server-config - get Anthos Multi-Cloud + server configuration for Attached clusters + +SYNOPSIS + gcloud alpha container attached get-server-config [--location=LOCATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get Anthos Multi-Cloud server configuration for Attached clusters. + +EXAMPLES + To return supported Attached cluster valid platform versions in location + us-west1, run: + + $ gcloud alpha container attached get-server-config \ + --location=us-west1 + +FLAGS + Location resource - Google Cloud location to get server configuration. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 container attached get-server-config + diff --git a/gcloud/alpha/container/attached/help b/gcloud/alpha/container/attached/help new file mode 100644 index 000000000..8d37c9f39 --- /dev/null +++ b/gcloud/alpha/container/attached/help @@ -0,0 +1,40 @@ +NAME + gcloud alpha container attached - manage Attached clusters for running + containers + +SYNOPSIS + gcloud alpha container attached GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Attached clusters for running containers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + clusters + (ALPHA) Create and manage Attached clusters. + + operations + (ALPHA) Manage Anthos Multi-Cloud long running operations for Attached + clusters. + +COMMANDS + COMMAND is one of the following: + + get-server-config + (ALPHA) Get Anthos Multi-Cloud server configuration for Attached + clusters. + +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 container attached + diff --git a/gcloud/alpha/container/attached/operations/describe b/gcloud/alpha/container/attached/operations/describe new file mode 100644 index 000000000..0cc816262 --- /dev/null +++ b/gcloud/alpha/container/attached/operations/describe @@ -0,0 +1,60 @@ +NAME + gcloud alpha container attached operations describe - describe an operation + +SYNOPSIS + gcloud alpha container attached operations describe + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an operation. + +EXAMPLES + To describe an operation in location us-west1, run: + + $ gcloud alpha container attached operations describe OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 container attached operations describe + diff --git a/gcloud/alpha/container/attached/operations/help b/gcloud/alpha/container/attached/operations/help new file mode 100644 index 000000000..e1ba45747 --- /dev/null +++ b/gcloud/alpha/container/attached/operations/help @@ -0,0 +1,36 @@ +NAME + gcloud alpha container attached operations - manage Anthos Multi-Cloud long + running operations for Attached clusters + +SYNOPSIS + gcloud alpha container attached operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Anthos Multi-Cloud long running operations for Attached + clusters. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe an operation. + + list + (ALPHA) List operations. + + wait + (ALPHA) Wait for an operation to complete. + +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 container attached operations + diff --git a/gcloud/alpha/container/attached/operations/list b/gcloud/alpha/container/attached/operations/list new file mode 100644 index 000000000..098a19feb --- /dev/null +++ b/gcloud/alpha/container/attached/operations/list @@ -0,0 +1,82 @@ +NAME + gcloud alpha container attached operations list - list operations + +SYNOPSIS + gcloud alpha container attached operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List operations. + +EXAMPLES + To list all operations in location us-west1, run: + + $ gcloud alpha container attached operations list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list operations. 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 + 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 container attached operations list + diff --git a/gcloud/alpha/container/attached/operations/wait b/gcloud/alpha/container/attached/operations/wait new file mode 100644 index 000000000..745b8af66 --- /dev/null +++ b/gcloud/alpha/container/attached/operations/wait @@ -0,0 +1,61 @@ +NAME + gcloud alpha container attached operations wait - wait for an operation to + complete + +SYNOPSIS + gcloud alpha container attached operations wait + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Wait for an operation to complete. + +EXAMPLES + To wait for an operation in location us-west1 to complete, run: + + $ gcloud alpha container attached operations wait OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to wait for. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 container attached operations wait + diff --git a/gcloud/alpha/container/aws/clusters/delete b/gcloud/alpha/container/aws/clusters/delete index 814222f04..b642f0e90 100644 --- a/gcloud/alpha/container/aws/clusters/delete +++ b/gcloud/alpha/container/aws/clusters/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container aws clusters delete (CLUSTER : --location=LOCATION) - [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete an Anthos cluster on AWS. @@ -43,6 +43,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_aws/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/alpha/container/aws/clusters/update b/gcloud/alpha/container/aws/clusters/update index 62d633494..f0ce6c236 100644 --- a/gcloud/alpha/container/aws/clusters/update +++ b/gcloud/alpha/container/aws/clusters/update @@ -21,7 +21,9 @@ SYNOPSIS [--clear-security-group-ids | --security-group-ids=[SECURITY_GROUP_ID,...]] [--clear-ssh-ec2-key-pair | --ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] - [--clear-tags | --tags=TAG,[TAG,...]] [GCLOUD_WIDE_FLAG ...] + [--clear-tags | --tags=TAG,[TAG,...]] + [--disable-managed-prometheus | --enable-managed-prometheus] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update an Anthos cluster on AWS. @@ -191,6 +193,16 @@ FLAGS $ gcloud alpha container aws clusters update EXAMPLE_CONTROL_PLANE \ --tags=tag1=one,tag2=two + Monitoring Config + + At most one of these can be specified: + + --disable-managed-prometheus + Disable managed collection for Managed Service for Prometheus. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/aws/node-pools/create b/gcloud/alpha/container/aws/node-pools/create index ce186ee10..ec50b2e2e 100644 --- a/gcloud/alpha/container/aws/node-pools/create +++ b/gcloud/alpha/container/aws/node-pools/create @@ -19,7 +19,10 @@ SYNOPSIS [--root-volume-type=ROOT_VOLUME_TYPE] [--security-group-ids=[SECURITY_GROUP_ID,...]] [--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] [--tags=TAG,[TAG,...]] - [--validate-only] [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] + [--validate-only] + [--autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY + : --autoscaling-metrics=[AUTOSCALING_METRIC,...]] + [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] [--proxy-secret-arn=PROXY_SECRET_ARN --proxy-secret-version-id=PROXY_SECRET_VERSION_ID] [GCLOUD_WIDE_FLAG ...] @@ -148,6 +151,21 @@ OPTIONAL FLAGS --validate-only Validate the node pool to create, but don't actually perform it. + Node pool autoscaling metrics collection + + --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY + Frequency at which EC2 Auto Scaling sends aggregated data to AWS + CloudWatch. The only valid value is "1Minute". + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --autoscaling-metrics=[AUTOSCALING_METRIC,...] + Autoscaling metrics to enable. For a list of valid metrics, refer to + https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html. + If granularity is specified but not any metrics, all metrics are + enabled. + Node pool autoscaling --max-nodes=MAX_NODES diff --git a/gcloud/alpha/container/aws/node-pools/delete b/gcloud/alpha/container/aws/node-pools/delete index 260a43ed0..414b1540b 100644 --- a/gcloud/alpha/container/aws/node-pools/delete +++ b/gcloud/alpha/container/aws/node-pools/delete @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud alpha container aws node-pools delete - (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async] - [--validate-only] [GCLOUD_WIDE_FLAG ...] + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete a node pool in an Anthos cluster on AWS. @@ -52,6 +52,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_aws/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/alpha/container/aws/node-pools/update b/gcloud/alpha/container/aws/node-pools/update index bb92ab00e..29c16eec7 100644 --- a/gcloud/alpha/container/aws/node-pools/update +++ b/gcloud/alpha/container/aws/node-pools/update @@ -12,11 +12,15 @@ SYNOPSIS [--root-volume-size=ROOT_VOLUME_SIZE] [--root-volume-type=ROOT_VOLUME_TYPE] [--validate-only] [--annotations=ANNOTATION,[ANNOTATION,...] | --clear-annotations] + [--clear-autoscaling-metrics + | --autoscaling-metrics=[AUTOSCALING_METRIC,...] + --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY] [--clear-proxy-config | --proxy-secret-arn=PROXY_SECRET_ARN --proxy-secret-version-id=PROXY_SECRET_VERSION_ID] [--clear-security-group-ids | --security-group-ids=[SECURITY_GROUP_ID,...]] [--clear-ssh-ec2-key-pair | --ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] + [--clear-tags | --tags=TAG,[TAG,...]] [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -107,6 +111,27 @@ FLAGS --clear-annotations Clear the annotations for the node pool. + Node pool autoscaling metrics collection + + At most one of these can be specified: + + --clear-autoscaling-metrics + Clear the cloudwatch autoscaling metrics collection associated with + the nodepool. + + Update existing cloudwatch autoscaling metrics collection parameters + + --autoscaling-metrics=[AUTOSCALING_METRIC,...] + Autoscaling metrics to enable. For a list of valid metrics, refer + to + https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html. + If granularity is specified but not any metrics, all metrics are + enabled. + + --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY + Frequency at which EC2 Auto Scaling sends aggregated data to AWS + CloudWatch. The only valid value is "1Minute". + Proxy config At most one of these can be specified: @@ -146,6 +171,19 @@ FLAGS Name of the EC2 key pair authorized to login to the node pool's nodes. + Tags + + At most one of these can be specified: + + --clear-tags + Clear any tags associated with the node pool's nodes. + + --tags=TAG,[TAG,...] + Applies the given tags (comma separated) on the node pool. Example: + + $ gcloud alpha container aws node-pools update EXAMPLE_NODE_POOL \ + --tags=tag1=one,tag2=two + Node pool autoscaling --max-nodes=MAX_NODES diff --git a/gcloud/alpha/container/aws/operations/cancel b/gcloud/alpha/container/aws/operations/cancel new file mode 100644 index 000000000..508faf074 --- /dev/null +++ b/gcloud/alpha/container/aws/operations/cancel @@ -0,0 +1,60 @@ +NAME + gcloud alpha container aws operations cancel - cancel an operation + +SYNOPSIS + gcloud alpha container aws operations cancel + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Cancel an operation. + +EXAMPLES + To cancel an operation in location us-west1, run: + + $ gcloud alpha container aws operations cancel OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to cancel. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_aws/location. + +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 container aws operations cancel + diff --git a/gcloud/alpha/container/aws/operations/help b/gcloud/alpha/container/aws/operations/help index 6503799cb..f62677228 100644 --- a/gcloud/alpha/container/aws/operations/help +++ b/gcloud/alpha/container/aws/operations/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + cancel + (ALPHA) Cancel an operation. + describe (ALPHA) Describe an operation. diff --git a/gcloud/alpha/container/azure/clients/delete b/gcloud/alpha/container/azure/clients/delete index abef33c59..49e73b0f6 100644 --- a/gcloud/alpha/container/azure/clients/delete +++ b/gcloud/alpha/container/azure/clients/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud alpha container azure clients delete (CLIENT : --location=LOCATION) - [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete an Azure client. @@ -41,6 +41,11 @@ POSITIONAL ARGUMENTS ▸ provide the argument --location on the command line; ▸ set the property container_azure/location. +FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/azure/clusters/create b/gcloud/alpha/container/azure/clusters/create index a436ae4a6..009894fd0 100644 --- a/gcloud/alpha/container/azure/clusters/create +++ b/gcloud/alpha/container/azure/clusters/create @@ -5,13 +5,13 @@ NAME SYNOPSIS gcloud alpha container azure clusters create (CLUSTER : --location=LOCATION) --azure-region=AZURE_REGION - --client=CLIENT --cluster-version=CLUSTER_VERSION - --fleet-project=FLEET_PROJECT + --cluster-version=CLUSTER_VERSION --fleet-project=FLEET_PROJECT --pod-address-cidr-blocks=POD_ADDRESS_CIDR_BLOCKS --resource-group-id=RESOURCE_GROUP_ID --service-address-cidr-blocks=SERVICE_ADDRESS_CIDR_BLOCKS --ssh-public-key=SSH_PUBLIC_KEY --vnet-id=VNET_ID - [--admin-users=USER,[USER,...]] + (--client=CLIENT : --azure-application-id=AZURE_APPLICATION_ID + --azure-tenant-id=AZURE_TENANT_ID) [--admin-users=USER,[USER,...]] [--annotations=ANNOTATION,[ANNOTATION,...]] [--async] [--config-encryption-key-id=CONFIG_ENCRYPTION_KEY_ID] [--config-encryption-public-key=CONFIG_ENCRYPTION_PUBLIC_KEY] @@ -74,26 +74,6 @@ REQUIRED FLAGS Azure location to deploy the cluster. Refer to your Azure subscription for available locations. - Client resource - Azure client to use for cluster creation. 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 --client on the command line with a fully - specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. To set the location attribute: - ◆ provide the argument --client on the command line with a fully - specified name; - ◆ provide the argument --location on the command line; - ◆ set the property container_azure/location. - - This must be specified. - - --client=CLIENT - ID of the client or fully qualified identifier for the client. To set - the client attribute: - ▸ provide the argument --client on the command line. - --cluster-version=CLUSTER_VERSION Kubernetes version to use for the cluster. @@ -117,6 +97,42 @@ REQUIRED FLAGS --vnet-id=VNET_ID ID of the Azure Virtual Network to associate with the cluster. + Authentication configuration + + Exactly one of these must be specified: + + Client resource - Azure client to use for cluster creation. 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 --client on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the location attribute: + ▸ provide the argument --client on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_azure/location. + + --client=CLIENT + ID of the client or fully qualified identifier for the client. To + set the client attribute: + ▫ provide the argument --client on the command line. + + Azure services authentication + + --azure-application-id=AZURE_APPLICATION_ID + ID of the Azure Application to manage Azure resources. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --azure-tenant-id=AZURE_TENANT_ID + ID of the Azure Tenant to manage Azure resources. + + This flag argument must be specified if any of the other arguments + in this group are specified. + OPTIONAL FLAGS --admin-users=USER,[USER,...] Users that can perform operations as a cluster administrator. If not diff --git a/gcloud/alpha/container/azure/clusters/delete b/gcloud/alpha/container/azure/clusters/delete index 2c85e13e4..24dfffd99 100644 --- a/gcloud/alpha/container/azure/clusters/delete +++ b/gcloud/alpha/container/azure/clusters/delete @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container azure clusters delete - (CLUSTER : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + (CLUSTER : --location=LOCATION) [--allow-missing] [--async] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete an Anthos cluster on Azure. @@ -43,6 +44,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_azure/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/alpha/container/azure/clusters/update b/gcloud/alpha/container/azure/clusters/update index eca1876be..ef038a63a 100644 --- a/gcloud/alpha/container/azure/clusters/update +++ b/gcloud/alpha/container/azure/clusters/update @@ -4,13 +4,15 @@ NAME SYNOPSIS gcloud alpha container azure clusters update - (CLUSTER : --location=LOCATION) --client=CLIENT - [--admin-users=USER,[USER,...]] [--async] - [--cluster-version=CLUSTER_VERSION] + (CLUSTER : --location=LOCATION) [--admin-users=USER,[USER,...]] + [--async] [--cluster-version=CLUSTER_VERSION] [--logging=COMPONENT,[COMPONENT,...]] [--ssh-public-key=SSH_PUBLIC_KEY] [--validate-only] [--vm-size=VM_SIZE] [--annotations=ANNOTATION,[ANNOTATION,...] | --clear-annotations] [--clear-description | --description=DESCRIPTION] + [--client=CLIENT : --azure-application-id=AZURE_APPLICATION_ID + --azure-tenant-id=AZURE_TENANT_ID] + [--disable-managed-prometheus | --enable-managed-prometheus] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -51,23 +53,6 @@ POSITIONAL ARGUMENTS ▸ set the property container_azure/location. FLAGS - Client resource - Azure client to use for cluster 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 --client on the command line with a fully - specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. To set the location attribute: - ◆ provide the argument --client on the command line with a fully - specified name; - ◆ provide the argument --location on the command line; - ◆ set the property container_azure/location. - - --client=CLIENT - ID of the client or fully qualified identifier for the client. To set - the client attribute: - ▸ provide the argument --client on the command line. - --admin-users=USER,[USER,...] Users that can perform operations as a cluster administrator. @@ -118,6 +103,46 @@ FLAGS --description=DESCRIPTION Description for the cluster. + Authentication configuration + + At most one of these can be specified: + + Client resource - Azure client to use for cluster 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 --client on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the location attribute: + ▸ provide the argument --client on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_azure/location. + + --client=CLIENT + ID of the client or fully qualified identifier for the client. To + set the client attribute: + ▫ provide the argument --client on the command line. + + Azure services authentication + + --azure-application-id=AZURE_APPLICATION_ID + ID of the Azure Application to manage Azure resources. + + --azure-tenant-id=AZURE_TENANT_ID + ID of the Azure Tenant to manage Azure resources. + + Monitoring Config + + At most one of these can be specified: + + --disable-managed-prometheus + Disable managed collection for Managed Service for Prometheus. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/azure/node-pools/delete b/gcloud/alpha/container/azure/node-pools/delete index 5e61acfb5..9f73455e7 100644 --- a/gcloud/alpha/container/azure/node-pools/delete +++ b/gcloud/alpha/container/azure/node-pools/delete @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud alpha container azure node-pools delete - (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async] - [GCLOUD_WIDE_FLAG ...] + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete a node pool in an Anthos cluster on Azure. @@ -52,6 +52,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_azure/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/alpha/container/azure/operations/cancel b/gcloud/alpha/container/azure/operations/cancel new file mode 100644 index 000000000..d21bda289 --- /dev/null +++ b/gcloud/alpha/container/azure/operations/cancel @@ -0,0 +1,60 @@ +NAME + gcloud alpha container azure operations cancel - cancel an operation + +SYNOPSIS + gcloud alpha container azure operations cancel + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Cancel an operation. + +EXAMPLES + To cancel an operation in location us-west1, run: + + $ gcloud alpha container azure operations cancel OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to cancel. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_azure/location. + +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 container azure operations cancel + diff --git a/gcloud/alpha/container/azure/operations/help b/gcloud/alpha/container/azure/operations/help index 4597ba79a..7637be869 100644 --- a/gcloud/alpha/container/azure/operations/help +++ b/gcloud/alpha/container/azure/operations/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + cancel + (ALPHA) Cancel an operation. + describe (ALPHA) Describe an operation. diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/describe b/gcloud/alpha/container/bare-metal/admin-clusters/describe new file mode 100644 index 000000000..39f0c4a97 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/admin-clusters/describe @@ -0,0 +1,60 @@ +NAME + gcloud alpha container bare-metal admin-clusters describe - describe an + Anthos on bare metal admin cluster + +SYNOPSIS + gcloud alpha container bare-metal admin-clusters describe + (ADMIN_CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an Anthos on bare metal admin cluster. + +EXAMPLES + To describe an admin cluster named my-cluster managed in location us-west1, + run: + + $ gcloud alpha container bare-metal admin-clusters describe \ + my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Admin cluster resource - admin cluster 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 admin_cluster 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. + + ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ▸ provide the argument admin_cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the admin_cluster. To set the location + attribute: + ▸ provide the argument admin_cluster on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/enroll b/gcloud/alpha/container/bare-metal/admin-clusters/enroll new file mode 100644 index 000000000..4f8e21016 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/admin-clusters/enroll @@ -0,0 +1,92 @@ +NAME + gcloud alpha container bare-metal admin-clusters enroll - enroll an Anthos + on bare metal admin cluster + +SYNOPSIS + gcloud alpha container bare-metal admin-clusters enroll + (ADMIN_CLUSTER : --location=LOCATION) + (--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global") + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Enroll an Anthos on bare metal admin cluster. + +POSITIONAL ARGUMENTS + Admin cluster resource - admin cluster to enroll 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 admin_cluster 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. + + ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ▸ provide the argument admin_cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the admin_cluster. To set the location + attribute: + ▸ provide the argument admin_cluster on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +REQUIRED FLAGS + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. 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 --admin-cluster-membership 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. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier for + the admin_cluster_membership. To set the admin_cluster_membership + attribute: + ▸ provide the argument --admin-cluster-membership on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global" + Google Cloud location for the admin_cluster_membership. To set the + location attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-location on the + command line. + +OPTIONAL 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. + +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. + diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/help b/gcloud/alpha/container/bare-metal/admin-clusters/help new file mode 100644 index 000000000..fb7dea6f8 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/admin-clusters/help @@ -0,0 +1,40 @@ +NAME + gcloud alpha container bare-metal admin-clusters - create and manage admin + clusters in Anthos on bare metal + +SYNOPSIS + gcloud alpha container bare-metal admin-clusters COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage admin clusters in Anthos on bare metal. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe an Anthos on bare metal admin cluster. + + enroll + (ALPHA) Enroll an Anthos on bare metal admin cluster. + + list + (ALPHA) List Anthos on bare metal admin clusters. + + query-version-config + (ALPHA) Query Anthos on bare metal admin cluster version configuration. + + update + (ALPHA) Update an Anthos on bare metal admin cluster. + +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. + diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/list b/gcloud/alpha/container/bare-metal/admin-clusters/list new file mode 100644 index 000000000..733d17227 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/admin-clusters/list @@ -0,0 +1,82 @@ +NAME + gcloud alpha container bare-metal admin-clusters list - list Anthos on bare + metal admin clusters + +SYNOPSIS + gcloud alpha container bare-metal admin-clusters list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Anthos on bare metal admin clusters. + +EXAMPLES + To list all admin clusters managed in location us-west1, run: + + $ gcloud alpha container bare-metal admin-clusters list \ + --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list Anthos on bare metal + admin clusters. 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 --location on the command line with a fully + specified name; + ◆ set the property container_bare_metal/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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 + 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. + diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config b/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config new file mode 100644 index 000000000..a160a7d14 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/admin-clusters/query-version-config @@ -0,0 +1,75 @@ +NAME + gcloud alpha container bare-metal admin-clusters query-version-config - + query Anthos on bare metal admin cluster version configuration + +SYNOPSIS + gcloud alpha container bare-metal admin-clusters query-version-config + --admin-cluster=ADMIN_CLUSTER [--location=LOCATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Query Anthos on bare metal admin cluster version configuration. + +EXAMPLES + To query versions for creating an admin cluster, run: + + $ gcloud alpha container bare-metal admin-clusters \ query-version-config + + To query versions for upgrading an admin cluster named my-admin-cluster, + run: + + $ gcloud alpha container bare-metal admin-clusters \ query-version-config --admin-cluster=my-admin-cluster + +FLAGS + Version configuration type + + Upgrade configuration + + Admin cluster resource - admin cluster to query version configuration + 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 --admin-cluster on the command line with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. To set the location attribute: + ▫ provide the argument --admin-cluster on the command line with a + fully specified name; + ▫ set the property container_bare_metal/location. + + --admin-cluster=ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ◇ provide the argument --admin-cluster on the command line. + + Location resource - Google Cloud location to query version configuration. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_bare_metal/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/bare-metal/admin-clusters/update b/gcloud/alpha/container/bare-metal/admin-clusters/update new file mode 100644 index 000000000..5779f6c72 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/admin-clusters/update @@ -0,0 +1,68 @@ +NAME + gcloud alpha container bare-metal admin-clusters update - update an Anthos + on bare metal admin cluster + +SYNOPSIS + gcloud alpha container bare-metal admin-clusters update + (ADMIN_CLUSTER : --location=LOCATION) [--async] [--version=VERSION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an Anthos on bare metal admin cluster. + +EXAMPLES + To update a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container bare-metal admin-clusters update \ + my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Admin cluster resource - admin cluster to update 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 admin_cluster 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. + + ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ▸ provide the argument admin_cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the admin_cluster. To set the location + attribute: + ▸ provide the argument admin_cluster on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --version=VERSION + Anthos cluster on bare metal version for the user cluster 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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/create b/gcloud/alpha/container/bare-metal/clusters/create new file mode 100644 index 000000000..a2e1f9dfb --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/create @@ -0,0 +1,391 @@ +NAME + gcloud alpha container bare-metal clusters create - create an Anthos + cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters create + (CLUSTER : --location=LOCATION) --version=VERSION + (--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT) + (--control-plane-load-balancer-port=CONTROL_PLANE_LOAD_BALANCER_PORT + (--control-plane-vip=CONTROL_PLANE_VIP + --ingress-vip=INGRESS_VIP) (--enable-manual-lb + : [--metal-lb-address-pools-from-file=METAL_LB_ADDRESS_POOLS_FROM_FILE : --metal-lb-load-balancer-node-configs-from-file=METAL_LB_LOAD_BALANCER_NODE_CONFIGS_FROM_FILE --metal-lb-load-balancer-node-labels=[KEY=VALUE, + ...] --metal-lb-load-balancer-node-taints=[KEY=VALUE:EFFECT,...]])) + ((((--control-plane-node-configs-from-file=CONTROL_PLANE_NODE_CONFIGS_FROM_FILE : --control-plane-node-labels=[KEY=VALUE, + ...] --control-plane-node-taints=[KEY=VALUE:EFFECT,...]))) + : --api-server-args=[KEY=VALUE,...]) + (--island-mode-pod-address-cidr-blocks=POD_ADDRESS,[POD_ADDRESS,...] + --island-mode-service-address-cidr-blocks=SERVICE_ADDRESS,[...]) + ((--lvp-node-mounts-config-path=LVP_NODE_MOUNTS_CONFIG_PATH + --lvp-node-mounts-config-storage-class=LVP_NODE_MOUNTS_CONFIG_STORAGE_CLASS) ((--lvp-share-path=LVP_SHARE_PATH --lvp-share-storage-class=LVP_SHARE_STORAGE_CLASS) : --shared-path-pv-count=SHARED_PATH_PV_COUNT)) + --admin-users=ADMIN_USERS + --maintenance-address-cidr-blocks=[MAINTENANCE_ADDRESS_CIDR_BLOCKS,...] + [--annotations=[KEY=VALUE,...]] [--async] [--description=DESCRIPTION] + [--enable-application-logs] [--login-user=LOGIN_USER] [--validate-only] + [--container-runtime=CONTAINER_RUNTIME + --max-pods-per-node=MAX_PODS_PER_NODE] + [--uri=URI : --no-proxy=[NO_PROXY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create an Anthos cluster on bare metal. + +EXAMPLES + To create a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container bare-metal clusters create my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to create 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +REQUIRED FLAGS + --version=VERSION + Anthos cluster on bare metal version for the user cluster resource. + + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. The + arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier for + the admin_cluster_membership. To set the admin_cluster_membership + attribute: + ▸ provide the argument --admin-cluster-membership on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION + Google Cloud location for the admin_cluster_membership. To set the + location attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-location on the + command line. + + --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT + Google Cloud project for the admin_cluster_membership. To set the + project attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-project on the + command line. + + Anthos on bare metal cluster load balancer configuration. + + This must be specified. + + Control plane load balancer port configuration. + + This must be specified. + + --control-plane-load-balancer-port=CONTROL_PLANE_LOAD_BALANCER_PORT + Control plane load balancer port configuration. + + VIPs used by the load balancer. + + This must be specified. + + --control-plane-vip=CONTROL_PLANE_VIP + VIP for the Kubernetes API of this cluster. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --ingress-vip=INGRESS_VIP + VIP for ingress traffic into this cluster. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Populate one of the load balancers. + + Exactly one of these must be specified: + + Manual load balancer configuration. + + --enable-manual-lb + ManualLB typed load balancers configuration. + + MetalLB Configuration + + --metal-lb-address-pools-from-file=METAL_LB_ADDRESS_POOLS_FROM_FILE + Path of the YAML/JSON file that contains the MetalLB address + pools. + + Examples: + + addressPools: + - pool: pool-1 + addresses: + - 10.200.0.14/32 + - 10.200.0.15/32 + avoidBuggyIPs: True + manualAssign: True + - pool: pool-2 + addresses: + - 10.200.0.16/32 + avoidBuggyIPs: False + manualAssign: False + + List of supported fields in addressPools + + KEY VALUE NOTE + pool string required, mutable + addresses one or more IP ranges required, mutable + avoidBuggyIPs bool optional, mutable, + defaults to False + manualAssign bool optional, mutable, + defaults to False + + This flag argument must be specified if any of the other + arguments in this group are specified. + + Anthos on bare metal node pool configuration for MetalLB load + balancer nodes. + + MetalLB Node Pool configuration. + + --metal-lb-load-balancer-node-configs-from-file=METAL_LB_LOAD_BALANCER_NODE_CONFIGS_FROM_FILE + Path of the YAML/JSON file that contains the Metal LB node + configs. + + Examples: + + nodeConfigs: + - nodeIP: 10.200.0.10 + labels: + node1: label1 + node2: label2 + - nodeIP: 10.200.0.11 + labels: + node3: label3 + node4: label4 + + List of supported fields in nodeConfigs + + KEY VALUE NOTE + nodeIP string required, + mutable + labels one or more key-val pairs optional, + mutable + + --metal-lb-load-balancer-node-labels=[KEY=VALUE,...] + Labels assigned to nodes of a MetalLB node pool. + + --metal-lb-load-balancer-node-taints=[KEY=VALUE:EFFECT,...] + Node taint applied to every node in a MetalLB node pool. + + Anthos on bare metal cluster control plane configuration. + + At least one of these must be specified: + + --api-server-args=[KEY=VALUE,...] + API Server argument configuration. + + Anthos on bare metal cluster control plane node pool configuration. + + This must be specified. + + Anthos on bare metal node pool configuration for control plane nodes. + + This must be specified. + + Anthos on bare metal node configuration for control plane nodes. + + This must be specified. + + --control-plane-node-configs-from-file=CONTROL_PLANE_NODE_CONFIGS_FROM_FILE + Path of the YAML/JSON file that contains the control plane node + configs. + + Examples: + + nodeConfigs: + - nodeIP: 10.200.0.10 + labels: + node1: label1 + node2: label2 + - nodeIP: 10.200.0.11 + labels: + node3: label3 + node4: label4 + + List of supported fields in nodeConfigs + + KEY VALUE NOTE + nodeIP string required, mutable + labels one or more key-val pairs optional, mutable + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --control-plane-node-labels=[KEY=VALUE,...] + Labels assigned to nodes of a node pool. + + --control-plane-node-taints=[KEY=VALUE:EFFECT,...] + Node taint applied to every Kubernetes node in a node pool. + + Populate one of the network configs. + + This must be specified. + + Island mode CIDR network configuration. + + --island-mode-pod-address-cidr-blocks=POD_ADDRESS,[POD_ADDRESS,...] + IPv4 address range for all pods in the cluster. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --island-mode-service-address-cidr-blocks=SERVICE_ADDRESS,[...] + IPv4 address range for all services in the cluster. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Anthos on bare metal cluster storage configuration. + + This must be specified. + + LVP node mounts class and path used by the storage. + + This must be specified. + + --lvp-node-mounts-config-path=LVP_NODE_MOUNTS_CONFIG_PATH + Path for the LVP node mounts class. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --lvp-node-mounts-config-storage-class=LVP_NODE_MOUNTS_CONFIG_STORAGE_CLASS + Storage class for LVP node mounts. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + LVP share configuration. + + At least one of these must be specified: + + --shared-path-pv-count=SHARED_PATH_PV_COUNT + Number of subdirectories to create under path. + + LVP share class and path used by the storage. + + This must be specified. + + --lvp-share-path=LVP_SHARE_PATH + Path for the LVP share class. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --lvp-share-storage-class=LVP_SHARE_STORAGE_CLASS + Storage class for LVP share. + + This flag argument must be specified if any of the other + arguments in this group are specified. + +OPTIONAL FLAGS + Anthos on bare metal cluster security configuration. + + User cluster authorization configurations to bootstrap onto the admin + cluster + + --admin-users=ADMIN_USERS + Users that will be granted the cluster-admin role on the cluster, + providing full access to the cluster. + + Anthos on bare metal cluster maintenance configuration. + + --maintenance-address-cidr-blocks=[MAINTENANCE_ADDRESS_CIDR_BLOCKS,...] + IPv4 addresses to be placed into maintenance mode. + + --annotations=[KEY=VALUE,...] + Annotations on the Anthos on bare metal resource. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Description for the resource. + + Anthos on bare metal cluster operations configuration. + + --enable-application-logs + Whether collection of application logs/metrics should be enabled (in + addition to system logs/metrics). + + Anthos on bare metal node access related settings for the user cluster. + + --login-user=LOGIN_USER + User name used to access node machines. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + + Anthos on bare metal cluster workload node configuration. + + --container-runtime=CONTAINER_RUNTIME + Container runtime which will be used in the bare metal user cluster. + + --max-pods-per-node=MAX_PODS_PER_NODE + Maximum number of pods a node can run. + + Anthos on bare metal cluster proxy configuration. + + --uri=URI + Address of the proxy server. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --no-proxy=[NO_PROXY,...] + List of IPs, hostnames, and domains that should skip the proxy. + +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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/delete b/gcloud/alpha/container/bare-metal/clusters/delete new file mode 100644 index 000000000..224510c72 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/delete @@ -0,0 +1,76 @@ +NAME + gcloud alpha container bare-metal clusters delete - delete an Anthos + cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters delete + (CLUSTER : --location=LOCATION) [--allow-missing] [--async] [--force] + [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an Anthos cluster on bare metal. + +EXAMPLES + To delete a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container bare-metal clusters delete my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +FLAGS + --allow-missing + If set, and the Bare Metal cluster is not found, the request will + succeed but no action will be taken. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --force + If set, the operation will also apply to the child node pools. This + flag is required if the cluster has any associated node pools. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + +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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/describe b/gcloud/alpha/container/bare-metal/clusters/describe new file mode 100644 index 000000000..fe20a438b --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/describe @@ -0,0 +1,58 @@ +NAME + gcloud alpha container bare-metal clusters describe - describe an Anthos + cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters describe + (CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an Anthos cluster on bare metal. + +EXAMPLES + To describe a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container bare-metal clusters describe my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/enroll b/gcloud/alpha/container/bare-metal/clusters/enroll new file mode 100644 index 000000000..415105ca8 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/enroll @@ -0,0 +1,105 @@ +NAME + gcloud alpha container bare-metal clusters enroll - enroll an Anthos + cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters enroll + (CLUSTER : --location=LOCATION) + (--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Enroll an Anthos cluster on bare metal. + +EXAMPLES + To enroll a cluster named my-cluster managed in location us-west1 with + admin cluster membership of + projects/my-project/locations/us-west1/memberships/my-admin-cluster-membership, + run: + + $ gcloud alpha container bare-metal clusters enroll my-cluster \ + --location=us-west1 \ + --admin-cluster-membership=projects/my-project/locations/\ + us-west1/memberships/my-admin-cluster-membership + +POSITIONAL ARGUMENTS + Cluster resource - cluster to enroll 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +REQUIRED FLAGS + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. The + arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier for + the admin_cluster_membership. To set the admin_cluster_membership + attribute: + ▸ provide the argument --admin-cluster-membership on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION + Google Cloud location for the admin_cluster_membership. To set the + location attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-location on the + command line. + + --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT + Google Cloud project for the admin_cluster_membership. To set the + project attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-project on the + command line. + +OPTIONAL 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. + +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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/help b/gcloud/alpha/container/bare-metal/clusters/help new file mode 100644 index 000000000..2a4ae2252 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/help @@ -0,0 +1,45 @@ +NAME + gcloud alpha container bare-metal clusters - create and manage Anthos + clusters on bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Anthos clusters on bare metal. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an Anthos cluster on bare metal. + + delete + (ALPHA) Delete an Anthos cluster on bare metal. + + describe + (ALPHA) Describe an Anthos cluster on bare metal. + + enroll + (ALPHA) Enroll an Anthos cluster on bare metal. + + list + (ALPHA) List Anthos clusters on bare metal. + + query-version-config + (ALPHA) Query Anthos on bare metal version configuration. + + update + (ALPHA) Update an Anthos cluster on bare metal. + +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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/list b/gcloud/alpha/container/bare-metal/clusters/list new file mode 100644 index 000000000..8e01cace3 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/list @@ -0,0 +1,80 @@ +NAME + gcloud alpha container bare-metal clusters list - list Anthos clusters on + bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Anthos clusters on bare metal. + +EXAMPLES + To lists all clusters managed in location us-west1, run: + + $ gcloud alpha container bare-metal clusters list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list. 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 --location on the command line with a fully + specified name; + ◆ set the property container_bare_metal/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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 + 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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/query-version-config b/gcloud/alpha/container/bare-metal/clusters/query-version-config new file mode 100644 index 000000000..817259169 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/query-version-config @@ -0,0 +1,112 @@ +NAME + gcloud alpha container bare-metal clusters query-version-config - query + Anthos on bare metal version configuration + +SYNOPSIS + gcloud alpha container bare-metal clusters query-version-config + (--cluster=CLUSTER + : [--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global"]) + [--location=LOCATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Query Anthos on bare metal version configuration. + +EXAMPLES + To query versions for creating a cluster with an admin cluster membership + named my-admin-cluster-membership, run: + + $ gcloud alpha container bare-metal clusters query-version-config \ + --admin-cluster-membership=my-admin-cluster-membership + + To query versions for upgrading a user cluster named my-user-cluster, run: + + $ gcloud alpha container bare-metal clusters query-version-config \ + --cluster=my-user-cluster + +REQUIRED FLAGS + Version configuration type + + Exactly one of these must be specified: + + Upgrade configuration + + Cluster resource - cluster to query version configuration 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 --cluster on the command line with a fully + specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. To set the location attribute: + ▫ provide the argument --cluster on the command line with a fully + specified name; + ▫ set the property container_bare_metal/location. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line. + + Create configuration + + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. 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 --admin-cluster-membership on the command + line with a fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier + for the admin_cluster_membership. To set the + admin_cluster_membership attribute: + ◇ provide the argument --admin-cluster-membership on the + command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global" + Google Cloud location for the admin_cluster_membership. To set + the location attribute: + ◇ provide the argument --admin-cluster-membership on the + command line with a fully specified name; + ◇ provide the argument --admin-cluster-membership-location on + the command line. + +OPTIONAL FLAGS + Location resource - Google Cloud location to query version configuration. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_bare_metal/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/bare-metal/clusters/update b/gcloud/alpha/container/bare-metal/clusters/update new file mode 100644 index 000000000..53d187dfd --- /dev/null +++ b/gcloud/alpha/container/bare-metal/clusters/update @@ -0,0 +1,223 @@ +NAME + gcloud alpha container bare-metal clusters update - update an Anthos + cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal clusters update + (CLUSTER : --location=LOCATION) [--admin-users=ADMIN_USERS] + [--allow-missing] [--async] [--description=DESCRIPTION] + [--enable-application-logs] [--login-user=LOGIN_USER] + [--maintenance-address-cidr-blocks=[MAINTENANCE_ADDRESS_CIDR_BLOCKS, + ...]] [--validate-only] [--version=VERSION] + [--api-server-args=[KEY=VALUE,...] + --control-plane-node-configs-from-file=CONTROL_PLANE_NODE_CONFIGS_FROM_FILE --control-plane-node-labels=[KEY=VALUE, + ...] --control-plane-node-taints=[KEY=VALUE:EFFECT,...]] + [--metal-lb-address-pools-from-file=METAL_LB_ADDRESS_POOLS_FROM_FILE + --metal-lb-load-balancer-node-configs-from-file=METAL_LB_LOAD_BALANCER_NODE_CONFIGS_FROM_FILE --metal-lb-load-balancer-node-labels=[KEY=VALUE, + ...] --metal-lb-load-balancer-node-taints=[KEY=VALUE:EFFECT,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an Anthos cluster on bare metal. + +EXAMPLES + To update a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container bare-metal clusters update my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to update 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +FLAGS + Anthos on bare metal cluster security configuration. + + User cluster authorization configurations to bootstrap onto the admin + cluster + + --admin-users=ADMIN_USERS + Users that will be granted the cluster-admin role on the cluster, + providing full access to the cluster. + + --allow-missing + If set, and the Anthos cluster on bare metal is not found, the update + request will try to create a new cluster with the provided + configuration. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Description for the resource. + + Anthos on bare metal cluster operations configuration. + + --enable-application-logs + Whether collection of application logs/metrics should be enabled (in + addition to system logs/metrics). + + Anthos on bare metal node access related settings for the user cluster. + + --login-user=LOGIN_USER + User name used to access node machines. + + Anthos on bare metal cluster maintenance configuration. + + --maintenance-address-cidr-blocks=[MAINTENANCE_ADDRESS_CIDR_BLOCKS,...] + IPv4 addresses to be placed into maintenance mode. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + + --version=VERSION + Anthos cluster on bare metal version for the user cluster resource. + + Anthos on bare metal cluster control plane configuration. + + --api-server-args=[KEY=VALUE,...] + API Server argument configuration. + + Anthos on bare metal cluster control plane node pool configuration. + + Anthos on bare metal node pool configuration for control plane nodes. + + Anthos on bare metal node configuration for control plane nodes. + + --control-plane-node-configs-from-file=CONTROL_PLANE_NODE_CONFIGS_FROM_FILE + Path of the YAML/JSON file that contains the control plane node + configs. + + Examples: + + nodeConfigs: + - nodeIP: 10.200.0.10 + labels: + node1: label1 + node2: label2 + - nodeIP: 10.200.0.11 + labels: + node3: label3 + node4: label4 + + List of supported fields in nodeConfigs + + KEY VALUE NOTE + nodeIP string required, mutable + labels one or more key-val pairs optional, mutable + + --control-plane-node-labels=[KEY=VALUE,...] + Labels assigned to nodes of a node pool. + + --control-plane-node-taints=[KEY=VALUE:EFFECT,...] + Node taint applied to every Kubernetes node in a node pool. + + Anthos on bare metal cluster load balancer configuration. + + Populate one of the load balancers. + + MetalLB Configuration + + --metal-lb-address-pools-from-file=METAL_LB_ADDRESS_POOLS_FROM_FILE + Path of the YAML/JSON file that contains the MetalLB address + pools. + + Examples: + + addressPools: + - pool: pool-1 + addresses: + - 10.200.0.14/32 + - 10.200.0.15/32 + avoidBuggyIPs: True + manualAssign: True + - pool: pool-2 + addresses: + - 10.200.0.16/32 + avoidBuggyIPs: False + manualAssign: False + + List of supported fields in addressPools + + KEY VALUE NOTE + pool string required, mutable + addresses one or more IP ranges required, mutable + avoidBuggyIPs bool optional, mutable, + defaults to False + manualAssign bool optional, mutable, + defaults to False + + Anthos on bare metal node pool configuration for MetalLB load + balancer nodes. + + MetalLB Node Pool configuration. + + --metal-lb-load-balancer-node-configs-from-file=METAL_LB_LOAD_BALANCER_NODE_CONFIGS_FROM_FILE + Path of the YAML/JSON file that contains the Metal LB node + configs. + + Examples: + + nodeConfigs: + - nodeIP: 10.200.0.10 + labels: + node1: label1 + node2: label2 + - nodeIP: 10.200.0.11 + labels: + node3: label3 + node4: label4 + + List of supported fields in nodeConfigs + + KEY VALUE NOTE + nodeIP string required, + mutable + labels one or more key-val pairs optional, + mutable + + --metal-lb-load-balancer-node-labels=[KEY=VALUE,...] + Labels assigned to nodes of a MetalLB node pool. + + --metal-lb-load-balancer-node-taints=[KEY=VALUE:EFFECT,...] + Node taint applied to every node in a MetalLB node pool. + +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. + diff --git a/gcloud/alpha/container/bare-metal/help b/gcloud/alpha/container/bare-metal/help new file mode 100644 index 000000000..21538d543 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/help @@ -0,0 +1,38 @@ +NAME + gcloud alpha container bare-metal - deploy and manage Anthos clusters on + bare metal for running containers + +SYNOPSIS + gcloud alpha container bare-metal GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Deploy and manage Anthos clusters on bare metal for running + containers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + admin-clusters + (ALPHA) Create and manage admin clusters in Anthos on bare metal. + + clusters + (ALPHA) Create and manage Anthos clusters on bare metal. + + node-pools + (ALPHA) Create and manage node pools in an Anthos cluster on bare + metal. + + operations + (ALPHA) Manage Anthos on bare metal long running operations. + +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. + diff --git a/gcloud/alpha/container/bare-metal/node-pools/create b/gcloud/alpha/container/bare-metal/node-pools/create new file mode 100644 index 000000000..d44f6532d --- /dev/null +++ b/gcloud/alpha/container/bare-metal/node-pools/create @@ -0,0 +1,120 @@ +NAME + gcloud alpha container bare-metal node-pools create - create a node pool in + an Anthos cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal node-pools create + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) + (--node-configs-from-file=NODE_CONFIGS_FROM_FILE + : --node-labels=[KEY=VALUE,...] --node-taints=[KEY=VALUE:EFFECT,...]) + [--annotations=[KEY=VALUE,...]] [--async] [--display-name=DISPLAY_NAME] + [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a node pool in an Anthos cluster on bare metal. + +EXAMPLES + To create a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container bare-metal node-pools create my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool to create 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +REQUIRED FLAGS + Anthos on bare metal node pool configuration. + + This must be specified. + + --node-configs-from-file=NODE_CONFIGS_FROM_FILE + Path of the YAML/JSON file that contains the node configs. + + Examples: + + nodeConfigs: + - nodeIP: 10.200.0.10 + labels: + node1: label1 + node2: label2 + - nodeIP: 10.200.0.11 + labels: + node3: label3 + node4: label4 + + List of supported fields in nodeConfigs + + KEY VALUE NOTE + nodeIP string required, mutable + labels one or more key-val pairs optional, mutable + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --node-labels=[KEY=VALUE,...] + Labels assigned to nodes of a node pool. + + --node-taints=[KEY=VALUE:EFFECT,...] + Node taint applied to every Kubernetes node in a node pool. + +OPTIONAL FLAGS + --annotations=[KEY=VALUE,...] + Annotations on the node pool. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + Display name for the resource. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + +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. + diff --git a/gcloud/alpha/container/bare-metal/node-pools/delete b/gcloud/alpha/container/bare-metal/node-pools/delete new file mode 100644 index 000000000..4c99e9a06 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/node-pools/delete @@ -0,0 +1,80 @@ +NAME + gcloud alpha container bare-metal node-pools delete - delete a node pool in + an Anthos cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal node-pools delete + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a node pool in an Anthos cluster on bare metal. + +EXAMPLES + To delete a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container bare-metal node-pools delete my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +FLAGS + --allow-missing + If set, and the Bare Metal Node Pool is not found, the request will + succeed but no action will be taken. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + +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. + diff --git a/gcloud/alpha/container/bare-metal/node-pools/describe b/gcloud/alpha/container/bare-metal/node-pools/describe new file mode 100644 index 000000000..16a98de14 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/node-pools/describe @@ -0,0 +1,67 @@ +NAME + gcloud alpha container bare-metal node-pools describe - describe a node + pool in an Anthos cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal node-pools describe + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a node pool in an Anthos cluster on bare metal. + +EXAMPLES + To describe a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container bare-metal node-pools describe \ + my-node-pool --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/bare-metal/node-pools/help b/gcloud/alpha/container/bare-metal/node-pools/help new file mode 100644 index 000000000..a13a3f1b6 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/node-pools/help @@ -0,0 +1,39 @@ +NAME + gcloud alpha container bare-metal node-pools - create and manage node pools + in an Anthos cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal node-pools COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage node pools in an Anthos cluster on bare metal. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a node pool in an Anthos cluster on bare metal. + + delete + (ALPHA) Delete a node pool in an Anthos cluster on bare metal. + + describe + (ALPHA) Describe a node pool in an Anthos cluster on bare metal. + + list + (ALPHA) List node pools in an Anthos cluster on bare metal. + + update + (ALPHA) Update a node pool in an Anthos cluster on bare metal. + +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. + diff --git a/gcloud/alpha/container/bare-metal/node-pools/list b/gcloud/alpha/container/bare-metal/node-pools/list new file mode 100644 index 000000000..61cac9a21 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/node-pools/list @@ -0,0 +1,93 @@ +NAME + gcloud alpha container bare-metal node-pools list - list node pools in an + Anthos cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal node-pools list + (--cluster=CLUSTER : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List node pools in an Anthos cluster on bare metal. + +EXAMPLES + To list all node pools in a cluster named my-cluster managed in location + us-west1, run: + + $ gcloud alpha container bare-metal node-pools list \ + --cluster=my-cluster --location=us-west1 + +REQUIRED FLAGS + Cluster resource - cluster to list 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 --cluster 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. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument --cluster on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument --cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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 + 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. + diff --git a/gcloud/alpha/container/bare-metal/node-pools/update b/gcloud/alpha/container/bare-metal/node-pools/update new file mode 100644 index 000000000..4aff51de7 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/node-pools/update @@ -0,0 +1,116 @@ +NAME + gcloud alpha container bare-metal node-pools update - update a node pool in + an Anthos cluster on bare metal + +SYNOPSIS + gcloud alpha container bare-metal node-pools update + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [--display-name=DISPLAY_NAME] [--validate-only] + [--node-configs-from-file=NODE_CONFIGS_FROM_FILE + --node-labels=[KEY=VALUE,...] --node-taints=[KEY=VALUE:EFFECT,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a node pool in an Anthos cluster on bare metal. + +EXAMPLES + To update a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container bare-metal node-pools update my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool to update 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +FLAGS + --allow-missing + If set, and the Anthos cluster on bare metal is not found, the update + request will try to create a new cluster with the provided + configuration. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + Display name for the resource. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + + Anthos on bare metal node pool configuration. + + --node-configs-from-file=NODE_CONFIGS_FROM_FILE + Path of the YAML/JSON file that contains the node configs. + + Examples: + + nodeConfigs: + - nodeIP: 10.200.0.10 + labels: + node1: label1 + node2: label2 + - nodeIP: 10.200.0.11 + labels: + node3: label3 + node4: label4 + + List of supported fields in nodeConfigs + + KEY VALUE NOTE + nodeIP string required, mutable + labels one or more key-val pairs optional, mutable + + --node-labels=[KEY=VALUE,...] + Labels assigned to nodes of a node pool. + + --node-taints=[KEY=VALUE:EFFECT,...] + Node taint applied to every Kubernetes node in a node pool. + +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. + diff --git a/gcloud/alpha/container/bare-metal/operations/describe b/gcloud/alpha/container/bare-metal/operations/describe new file mode 100644 index 000000000..36bcf86db --- /dev/null +++ b/gcloud/alpha/container/bare-metal/operations/describe @@ -0,0 +1,59 @@ +NAME + gcloud alpha container bare-metal operations describe - describe an + operation + +SYNOPSIS + gcloud alpha container bare-metal operations describe + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an operation. + +EXAMPLES + To describe an operation in location us-west1, run: + + $ gcloud alpha container bare-metal operations describe \ + OPERATION_ID --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/bare-metal/operations/help b/gcloud/alpha/container/bare-metal/operations/help new file mode 100644 index 000000000..2a789d29b --- /dev/null +++ b/gcloud/alpha/container/bare-metal/operations/help @@ -0,0 +1,33 @@ +NAME + gcloud alpha container bare-metal operations - manage Anthos on bare metal + long running operations + +SYNOPSIS + gcloud alpha container bare-metal operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Anthos on bare metal long running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe an operation. + + list + (ALPHA) List operations. + + wait + (ALPHA) Poll an operation for completion. + +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. + diff --git a/gcloud/alpha/container/bare-metal/operations/list b/gcloud/alpha/container/bare-metal/operations/list new file mode 100644 index 000000000..89e31cef9 --- /dev/null +++ b/gcloud/alpha/container/bare-metal/operations/list @@ -0,0 +1,81 @@ +NAME + gcloud alpha container bare-metal operations list - list operations + +SYNOPSIS + gcloud alpha container bare-metal operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List operations. + +EXAMPLES + To list all operations in location us-west1, run: + + $ gcloud alpha container bare-metal operations list \ + --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list operations. 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 --location on the command line with a fully + specified name; + ◆ set the property container_bare_metal/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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 + 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. + diff --git a/gcloud/alpha/container/bare-metal/operations/wait b/gcloud/alpha/container/bare-metal/operations/wait new file mode 100644 index 000000000..8bd8b82dc --- /dev/null +++ b/gcloud/alpha/container/bare-metal/operations/wait @@ -0,0 +1,59 @@ +NAME + gcloud alpha container bare-metal operations wait - poll an operation for + completion + +SYNOPSIS + gcloud alpha container bare-metal operations wait + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Poll an operation for completion. + +EXAMPLES + To wait for an operation in location us-west1 to complete, run: + + $ gcloud alpha container bare-metal operations wait OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to wait for completion. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_bare_metal/location. + +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. + diff --git a/gcloud/alpha/container/clusters/config/export b/gcloud/alpha/container/clusters/config/export index f27119b19..6f13c9375 100644 --- a/gcloud/alpha/container/clusters/config/export +++ b/gcloud/alpha/container/clusters/config/export @@ -79,7 +79,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/container/clusters/create b/gcloud/alpha/container/clusters/create index af48f7496..1bebc1624 100644 --- a/gcloud/alpha/container/clusters/create +++ b/gcloud/alpha/container/clusters/create @@ -24,7 +24,8 @@ SYNOPSIS [--no-enable-autoupgrade] [--enable-cloud-logging] [--enable-cloud-monitoring] [--enable-cloud-run-alpha] [--enable-confidential-nodes] [--enable-cost-allocation] - [--enable-dataplane-v2] [--enable-gke-oidc] [--enable-gvnic] + [--enable-dataplane-v2] [--enable-gke-oidc] + [--enable-google-cloud-access] [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] [--enable-l4-ilb-subsetting] @@ -53,6 +54,7 @@ SYNOPSIS [--notification-config=[pubsub=ENABLED|DISABLED, pubsub-topic=TOPIC,...]] [--num-nodes=NUM_NODES; default=3] [--placement-type=PLACEMENT_TYPE] [--preemptible] + [--private-endpoint-subnetwork=NAME] [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--release-channel=CHANNEL] [--security-group=SECURITY_GROUP] [--services-ipv4-cidr=CIDR] [--services-secondary-range-name=NAME] @@ -97,6 +99,8 @@ SYNOPSIS --master-ipv4-cidr=MASTER_IPV4_CIDR --private-cluster] [--enable-tpu --enable-tpu-service-networking | --tpu-ipv4-cidr=CIDR] [--ephemeral-storage=[local-ssd-count=LOCAL-SSD-COUNT] + | --ephemeral-storage-local-ssd=[count=COUNT] + | --local-nvme-ssd-block=[count=COUNT] | --local-ssd-count=LOCAL_SSD_COUNT | --local-ssd-volumes=[[count=COUNT], [type=TYPE],[format=FORMAT],...]] @@ -167,7 +171,7 @@ FLAGS ADDON must be one of: HttpLoadBalancing, HorizontalPodAutoscaling, KubernetesDashboard, NetworkPolicy, NodeLocalDNS, ConfigConnector, GcePersistentDiskCsiDriver, GcpFilestoreCsiDriver, BackupRestore, - Istio, ApplicationManager, CloudBuild, CloudRun. + Istio, CloudBuild, CloudRun. --allow-route-overlap Allows the provided cluster CIDRs to overlap with existing routes that @@ -427,6 +431,11 @@ FLAGS Thus, flag --enable-gke-oidc is also deprecated. Please use --enable-identity-service to enable the Identity Service component + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --enable-gvnic Enable the use of GVNIC for this cluster. Requires re-creation of nodes using either a node-pool upgrade or node-pool creation. @@ -616,7 +625,7 @@ FLAGS --logging=[COMPONENT,...] Set the components that have logging enabled. Valid component values - are: SYSTEM, WORKLOAD, NONE + are: SYSTEM, WORKLOAD, API_SERVER, CONTROLLER_MANAGER, SCHEDULER, NONE For more information, look at https://cloud.google.com/stackdriver/docs/solutions/gke/installing#available-logs @@ -624,7 +633,8 @@ FLAGS Examples: $ gcloud alpha container clusters create --logging=SYSTEM - $ gcloud alpha container clusters create --logging=SYSTEM,WORKLOAD + $ gcloud alpha container clusters create \ + --logging=SYSTEM,API_SERVER,WORKLOAD $ gcloud alpha container clusters create --logging=NONE --logging-variant=LOGGING_VARIANT @@ -860,9 +870,9 @@ FLAGS UNSPECIFIED - No requirements on the placement of nodes. This is the default option. - COMPACT - Google will attempt to place the nodes in a close proximity - to each other. This helps to reduce the communication latency between - the nodes, but imposes additional limitations on the node pool size. + COMPACT - GKE will attempt to place the nodes in a close proximity to + each other. This helps to reduce the communication latency between the + nodes, but imposes additional limitations on the node pool size. $ gcloud alpha container clusters create example-cluster \ --placement-type=COMPACT @@ -880,6 +890,10 @@ FLAGS https://cloud.google.com/kubernetes-engine/docs/preemptible-vm for more information on how to use Preemptible VMs with Kubernetes Engine. + --private-endpoint-subnetwork=NAME + Sets the subnetwork GKE uses to provision the control plane's private + endpoint. + --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE Sets the type of private access to Google services over IPv6. @@ -985,8 +999,8 @@ FLAGS VM instances. --stack-type=STACK_TYPE - IP stack type of the node VMs. Defaults to 'ipv4'. STACK_TYPE must be - one of: ipv4, ipv4-ipv6. + IP stack type of the node VMs. STACK_TYPE must be one of: ipv4, + ipv4-ipv6. --subnetwork=SUBNETWORK The Google Compute Engine subnetwork @@ -1157,7 +1171,8 @@ FLAGS --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE Enable Binary Authorization for this cluster. - BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, + BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, MONITORING, + MONITORING_AND_PROJECT_SINGLETON_POLICY_ENFORCE, PROJECT_SINGLETON_POLICY_ENFORCE. --enable-binauthz @@ -1184,7 +1199,7 @@ FLAGS --cluster-dns-scope=CLUSTER_DNS_SCOPE DNS scope for the Cloud DNS zone created - valid only with - --cluster-dns=clouddns + --cluster-dns=clouddns. Defaults to cluster. CLUSTER_DNS_SCOPE must be one of: @@ -1434,7 +1449,8 @@ FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the node @@ -1599,12 +1615,48 @@ FLAGS 'local-ssd-count' specifies the number of local SSDs to use to back ephemeral storage. Local SDDs use NVMe interfaces and each is 375 GB - in size. If 'local-ssd-count=0', it means to disable using local SSDs - as ephemeral storage. + in size. Setting 'local-ssd-count=0' disables using local SSDs as + ephemeral storage. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. + --ephemeral-storage-local-ssd=[count=COUNT] + Parameters for the ephemeral storage filesystem. If unspecified, + ephemeral storage is backed by the boot disk. + + Examples: + + $ gcloud alpha container clusters create example_cluster \ + --ephemeral-storage-local-ssd count=2 + + 'count' specifies the number of local SSDs to use to back ephemeral + storage. Local SDDs use NVMe interfaces and each is 375 GB in size. + Setting 'count=0' disables using local SSDs as ephemeral storage. + + See https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-nvme-ssd-block=[count=COUNT] + Adds the requested local SSDs on all nodes in default node pool(s) in + the new cluster. + + Examples: + + $ gcloud alpha container clusters create example_cluster \ + --local-nvme-ssd-block count=2 + + 'count' must be between 1-8 + + New nodes, including ones created by resize or recreate, will have these + local SSDs. + + Local SSDs have a fixed 375 GB capacity per device. The number of disks + that can be attached to an instance is limited by the maximum number of + disks available on a machine, which differs by compute zone. See + https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + --local-ssd-count=LOCAL_SSD_COUNT --local-ssd-count is the equivalent of using --local-ssd-volumes with type=scsi,format=fs @@ -1620,7 +1672,7 @@ FLAGS --local-ssd-volumes=[[count=COUNT],[type=TYPE],[format=FORMAT],...] Adds the requested local SSDs on all nodes in default node pool(s) in - new cluster. + the new cluster. Examples: diff --git a/gcloud/alpha/container/clusters/create-auto b/gcloud/alpha/container/clusters/create-auto index a986d627c..00116f318 100644 --- a/gcloud/alpha/container/clusters/create-auto +++ b/gcloud/alpha/container/clusters/create-auto @@ -10,10 +10,11 @@ SYNOPSIS [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] [--create-subnetwork=[KEY=VALUE,...]] - [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--network=NETWORK] - [--release-channel=CHANNEL] [--security-group=SECURITY_GROUP] - [--services-ipv4-cidr=CIDR] [--services-secondary-range-name=NAME] - [--subnetwork=SUBNETWORK] + [--database-encryption-key=DATABASE_ENCRYPTION_KEY] + [--enable-google-cloud-access] [--network=NETWORK] + [--private-endpoint-subnetwork=NAME] [--release-channel=CHANNEL] + [--security-group=SECURITY_GROUP] [--services-ipv4-cidr=CIDR] + [--services-secondary-range-name=NAME] [--subnetwork=SUBNETWORK] [--binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE --binauthz-policy=BINAUTHZ_POLICY] [--enable-master-authorized-networks @@ -148,11 +149,20 @@ FLAGS For more information, see https://cloud.google.com/kubernetes-engine/docs/how-to/encrypting-secrets. + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --network=NETWORK The Compute Engine Network that the cluster will connect to. Google Kubernetes Engine will use this network when creating routes and firewalls for the clusters. Defaults to the 'default' network. + --private-endpoint-subnetwork=NAME + Sets the subnetwork GKE uses to provision the control plane's private + endpoint. + --release-channel=CHANNEL Release channel a cluster is subscribed to. @@ -225,7 +235,8 @@ FLAGS --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE Enable Binary Authorization for this cluster. - BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, + BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, MONITORING, + MONITORING_AND_PROJECT_SINGLETON_POLICY_ENFORCE, PROJECT_SINGLETON_POLICY_ENFORCE. --binauthz-policy=BINAUTHZ_POLICY diff --git a/gcloud/alpha/container/clusters/update b/gcloud/alpha/container/clusters/update index 5024d0565..b0ff1d6e1 100644 --- a/gcloud/alpha/container/clusters/update +++ b/gcloud/alpha/container/clusters/update @@ -11,16 +11,16 @@ SYNOPSIS | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling | --enable-cost-allocation | --enable-gke-oidc - | --enable-identity-service | --enable-image-streaming - | --enable-intra-node-visibility | --enable-l4-ilb-subsetting - | --enable-legacy-authorization + | --enable-google-cloud-access | --enable-identity-service + | --enable-image-streaming | --enable-intra-node-visibility + | --enable-l4-ilb-subsetting | --enable-legacy-authorization | --enable-logging-monitoring-system-only | --enable-master-authorized-networks | --enable-master-global-access | --enable-network-policy | --enable-pod-security-policy - | --enable-service-externalips | --enable-shielded-nodes - | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling - | --gateway-api=GATEWAY_API | --generate-password - | --identity-provider=IDENTITY_PROVIDER + | --enable-private-endpoint | --enable-service-externalips + | --enable-shielded-nodes | --enable-stackdriver-kubernetes + | --enable-vertical-pod-autoscaling | --gateway-api=GATEWAY_API + | --generate-password | --identity-provider=IDENTITY_PROVIDER | --logging-variant=LOGGING_VARIANT | --maintenance-window=START_TIME | --notification-config=[pubsub=ENABLED|DISABLED, pubsub-topic=TOPIC,...] @@ -28,8 +28,8 @@ SYNOPSIS | --release-channel=CHANNEL | --remove-labels=[KEY,...] | --security-group=SECURITY_GROUP | --security-profile=SECURITY_PROFILE | --set-password - | --start-credential-rotation | --start-ip-rotation - | --update-addons=[ADDON=ENABLED|DISABLED,...] + | --stack-type=STACK_TYPE | --start-credential-rotation + | --start-ip-rotation | --update-addons=[ADDON=ENABLED|DISABLED,...] | --update-labels=[KEY=VALUE,...] | --workload-pool=WORKLOAD_POOL | --additional-zones=[ZONE,...] | --node-locations=ZONE,[ZONE,...] | --binauthz-policy=BINAUTHZ_POLICY @@ -187,7 +187,8 @@ REQUIRED FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --enable-cost-allocation Enable the cost management feature. @@ -213,6 +214,11 @@ REQUIRED FLAGS Thus, flag --enable-gke-oidc is also deprecated. Please use --enable-identity-service to enable the Identity Service component + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --enable-identity-service Enable Identity Service component on the cluster. @@ -289,6 +295,10 @@ REQUIRED FLAGS PodSecurityPolicy API objects. For more information, see https://cloud.google.com/kubernetes-engine/docs/how-to/pod-security-policies. + --enable-private-endpoint + Enables cluster's control plane to be accessible using private IP + address only. + --enable-service-externalips Enables use of services with externalIPs field. @@ -479,6 +489,10 @@ REQUIRED FLAGS Set the basic auth password to the specified value, keeping the existing username. + --stack-type=STACK_TYPE + IP stack type of the node VMs. STACK_TYPE must be one of: ipv4, + ipv4-ipv6. + --start-credential-rotation Start the rotation of IP and credentials for this cluster. For example: @@ -505,10 +519,9 @@ REQUIRED FLAGS HorizontalPodAutoscaling=ENABLED|DISABLED HttpLoadBalancing=ENABLED|DISABLED KubernetesDashboard=ENABLED|DISABLED Istio=ENABLED|DISABLED - ApplicationManager=ENABLED|DISABLED BackupRestore=ENABLED|DISABLED - NetworkPolicy=ENABLED|DISABLED CloudRun=ENABLED|DISABLED - CloudBuild=ENABLED|DISABLED ConfigConnector=ENABLED|DISABLED - NodeLocalDNS=ENABLED|DISABLED + BackupRestore=ENABLED|DISABLED NetworkPolicy=ENABLED|DISABLED + CloudRun=ENABLED|DISABLED CloudBuild=ENABLED|DISABLED + ConfigConnector=ENABLED|DISABLED NodeLocalDNS=ENABLED|DISABLED GcePersistentDiskCsiDriver=ENABLED|DISABLED GcpFilestoreCsiDriver=ENABLED|DISABLED @@ -593,7 +606,8 @@ REQUIRED FLAGS --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE Enable Binary Authorization for this cluster. - BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, + BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, MONITORING, + MONITORING_AND_PROJECT_SINGLETON_POLICY_ENFORCE, PROJECT_SINGLETON_POLICY_ENFORCE. --enable-binauthz @@ -756,7 +770,7 @@ REQUIRED FLAGS --cluster-dns-scope=CLUSTER_DNS_SCOPE DNS scope for the Cloud DNS zone created - valid only with - --cluster-dns=clouddns + --cluster-dns=clouddns. Defaults to cluster. CLUSTER_DNS_SCOPE must be one of: @@ -1036,7 +1050,8 @@ REQUIRED FLAGS --logging=[COMPONENT,...] Set the components that have logging enabled. Valid component values - are: SYSTEM, WORKLOAD, NONE + are: SYSTEM, WORKLOAD, API_SERVER, CONTROLLER_MANAGER, SCHEDULER, + NONE For more information, look at https://cloud.google.com/stackdriver/docs/solutions/gke/installing#available-logs @@ -1044,7 +1059,8 @@ REQUIRED FLAGS Examples: $ gcloud alpha container clusters update --logging=SYSTEM - $ gcloud alpha container clusters update --logging=SYSTEM,WORKLOAD + $ gcloud alpha container clusters update \ + --logging=SYSTEM,API_SERVER,WORKLOAD $ gcloud alpha container clusters update --logging=NONE --monitoring=[COMPONENT,...] diff --git a/gcloud/alpha/container/fleet/config-management/apply b/gcloud/alpha/container/fleet/config-management/apply index eb3058c00..5d0d438c1 100644 --- a/gcloud/alpha/container/fleet/config-management/apply +++ b/gcloud/alpha/container/fleet/config-management/apply @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container fleet config-management apply --config=CONFIG - [--membership=MEMBERSHIP] [--version=VERSION] [GCLOUD_WIDE_FLAG ...] + [--version=VERSION] [--membership=MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update a user-specified config file to a ConfigManagement Custom @@ -26,12 +27,33 @@ REQUIRED FLAGS The path to config-management.yaml. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. - --version=VERSION The version of ACM to install. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/fleet/config-management/delete b/gcloud/alpha/container/fleet/config-management/delete index a4da5af0e..791c67adc 100644 --- a/gcloud/alpha/container/fleet/config-management/delete +++ b/gcloud/alpha/container/fleet/config-management/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet config-management delete - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) (DEPRECATED) Remove the Config Management Feature Spec for the @@ -22,8 +22,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/config-management/fetch-for-apply b/gcloud/alpha/container/fleet/config-management/fetch-for-apply index 6f531fe1e..625bf1be6 100644 --- a/gcloud/alpha/container/fleet/config-management/fetch-for-apply +++ b/gcloud/alpha/container/fleet/config-management/fetch-for-apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet config-management fetch-for-apply - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) The output is in the format that is used by the apply subcommand. @@ -16,8 +16,29 @@ EXAMPLES $ gcloud alpha container fleet config-management fetch-for-apply FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/config-management/unmanage b/gcloud/alpha/container/fleet/config-management/unmanage index c4b5bfb18..cbc8a91ae 100644 --- a/gcloud/alpha/container/fleet/config-management/unmanage +++ b/gcloud/alpha/container/fleet/config-management/unmanage @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet config-management unmanage - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Remove the Config Management Feature Spec for the given membership. @@ -18,8 +18,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/config-management/upgrade b/gcloud/alpha/container/fleet/config-management/upgrade index 04f02a648..840918ea9 100644 --- a/gcloud/alpha/container/fleet/config-management/upgrade +++ b/gcloud/alpha/container/fleet/config-management/upgrade @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet config-management upgrade --version=VERSION - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Upgrade a specified membership to any supported version of the @@ -21,8 +21,29 @@ REQUIRED FLAGS The version of ACM to change to. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/features/list b/gcloud/alpha/container/fleet/features/list index ee8750063..a41f4414d 100644 --- a/gcloud/alpha/container/fleet/features/list +++ b/gcloud/alpha/container/fleet/features/list @@ -7,15 +7,15 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List enabled Hub features in a project. + (ALPHA) List enabled fleet features in a project. EXAMPLES - To list all enabled Hub features in a project, run: + To list all enabled fleet features in a project, run: $ gcloud alpha container fleet features list FLAGS - Location resource - The location to list Features under. + Location resource - The location to list features under. 'global' is the only supported value. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be diff --git a/gcloud/alpha/container/fleet/help b/gcloud/alpha/container/fleet/help index 7bfd32948..97511f8e4 100644 --- a/gcloud/alpha/container/fleet/help +++ b/gcloud/alpha/container/fleet/help @@ -61,8 +61,8 @@ GROUPS (ALPHA) Manage Multi-cluster Ingress Feature. memberships - (ALPHA) Manage memberships of all your GKE and other Kubernetes cluster - with fleets. + (ALPHA) Manage memberships of all your GKE and other Kubernetes + clusters with fleets. mesh (ALPHA) Manage Service Mesh Feature. @@ -70,6 +70,9 @@ GROUPS multi-cluster-services (ALPHA) Manage Multi-cluster Services Feature. + policycontroller + (ALPHA) Manage Policy Controller Feature. + service-directory (ALPHA) Manage the Service Directory Feature. diff --git a/gcloud/alpha/container/fleet/identity-service/apply b/gcloud/alpha/container/fleet/identity-service/apply index b15dad2cb..4628cc034 100644 --- a/gcloud/alpha/container/fleet/identity-service/apply +++ b/gcloud/alpha/container/fleet/identity-service/apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet identity-service apply --config=CONFIG - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Applies the authentication configuration to the Identity Service @@ -26,8 +26,29 @@ REQUIRED FLAGS The path to the identity-service.yaml config file. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/identity-service/delete b/gcloud/alpha/container/fleet/identity-service/delete index df15dc1c7..f2283f433 100644 --- a/gcloud/alpha/container/fleet/identity-service/delete +++ b/gcloud/alpha/container/fleet/identity-service/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container fleet identity-service delete - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Removes the Identity Service Feature Spec for the given membership. @@ -16,8 +16,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/ingress/enable b/gcloud/alpha/container/fleet/ingress/enable index 1519a8048..c4bf0a93c 100644 --- a/gcloud/alpha/container/fleet/ingress/enable +++ b/gcloud/alpha/container/fleet/ingress/enable @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container fleet ingress enable - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command enables Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/ingress/update b/gcloud/alpha/container/fleet/ingress/update index 331587c86..231cf90e6 100644 --- a/gcloud/alpha/container/fleet/ingress/update +++ b/gcloud/alpha/container/fleet/ingress/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container fleet ingress update - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command updates Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/memberships/describe b/gcloud/alpha/container/fleet/memberships/describe index 12b0c97ce..049e55444 100644 --- a/gcloud/alpha/container/fleet/memberships/describe +++ b/gcloud/alpha/container/fleet/memberships/describe @@ -6,12 +6,12 @@ SYNOPSIS (MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Describe a membership in Fleet. + (ALPHA) Describe a membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud alpha container fleet memberships list diff --git a/gcloud/alpha/container/fleet/memberships/get-credentials b/gcloud/alpha/container/fleet/memberships/get-credentials index 9c7640286..61b03f18e 100644 --- a/gcloud/alpha/container/fleet/memberships/get-credentials +++ b/gcloud/alpha/container/fleet/memberships/get-credentials @@ -4,31 +4,64 @@ NAME Gateway SYNOPSIS - gcloud alpha container fleet memberships get-credentials MEMBERSHIP - [GCLOUD_WIDE_FLAG ...] + gcloud alpha container fleet memberships get-credentials + (MEMBERSHIP_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha container fleet memberships get-credentials updates the kubeconfig file with the appropriate credentials and endpoint - information to send kubectl commands to a fleet-registered and connected - cluster through Connect Gateway Service. + information to send kubectl commands to a fleet-registered and -connected + cluster through the Connect Gateway service. It takes a project, passed through by set defaults or flags. By default, credentials are written to $HOME/.kube/config. You can provide an alternate path by setting the KUBECONFIG environment variable. If KUBECONFIG contains multiple paths, the first one is used. - Upon success, this command will switch current context to the target - cluster, when working with multiple clusters. + Upon success, this command will switch the current context to the target + cluster if other contexts are already present in the kubeconfig file. EXAMPLES - Get gateway kubeconfig for a registered cluster: + Get the Gateway kubeconfig for a globally registered cluster: $ gcloud alpha container fleet memberships get-credentials my-cluster + $ gcloud alpha container fleet memberships get-credentials \ + my-cluster --location=global + + Get the Gateway kubeconfig for a cluster registered in us-central1: + + $ gcloud alpha container fleet memberships get-credentials \ + my-cluster --location=us-central1 POSITIONAL ARGUMENTS - MEMBERSHIP - The membership name used to locate a cluster in your project. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/memberships/help b/gcloud/alpha/container/fleet/memberships/help index 0731fc37b..436c49f6c 100644 --- a/gcloud/alpha/container/fleet/memberships/help +++ b/gcloud/alpha/container/fleet/memberships/help @@ -1,12 +1,13 @@ NAME gcloud alpha container fleet memberships - manage memberships of all your - GKE and other Kubernetes cluster with fleets + GKE and other Kubernetes clusters with fleets SYNOPSIS - gcloud alpha container fleet memberships COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud alpha container fleet memberships GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Manage memberships of all your GKE and other Kubernetes cluster + (ALPHA) Manage memberships of all your GKE and other Kubernetes clusters with fleets. GCLOUD WIDE FLAGS @@ -37,7 +38,7 @@ COMMANDS (ALPHA) Register a cluster with a fleet. unregister - (ALPHA) Unregister a cluster from Fleet. + (ALPHA) Unregister a cluster from a fleet. update (ALPHA) Update a membership. diff --git a/gcloud/alpha/container/fleet/memberships/register b/gcloud/alpha/container/fleet/memberships/register index 6a496a314..7047b02f8 100644 --- a/gcloud/alpha/container/fleet/memberships/register +++ b/gcloud/alpha/container/fleet/memberships/register @@ -102,7 +102,7 @@ EXAMPLES $ gcloud alpha container fleet memberships register my-cluster \ --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --install-connect-agent --version=20220819-00-00 \ --service-account-key-file=/tmp/keyfile.json Register a GKE cluster and output a manifest that can be used to install the diff --git a/gcloud/alpha/container/fleet/memberships/unregister b/gcloud/alpha/container/fleet/memberships/unregister index 0484381f3..ef3abfa9b 100644 --- a/gcloud/alpha/container/fleet/memberships/unregister +++ b/gcloud/alpha/container/fleet/memberships/unregister @@ -1,6 +1,6 @@ NAME gcloud alpha container fleet memberships unregister - unregister a cluster - from Fleet + from a fleet SYNOPSIS gcloud alpha container fleet memberships unregister diff --git a/gcloud/alpha/container/fleet/memberships/update b/gcloud/alpha/container/fleet/memberships/update index d17b7498e..cf3f515a1 100644 --- a/gcloud/alpha/container/fleet/memberships/update +++ b/gcloud/alpha/container/fleet/memberships/update @@ -8,12 +8,12 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Update an existing membership in Fleet. + (ALPHA) Update an existing membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud alpha container fleet memberships list diff --git a/gcloud/alpha/container/fleet/mesh/update b/gcloud/alpha/container/fleet/mesh/update index a8bf6ba08..a42f62b06 100644 --- a/gcloud/alpha/container/fleet/mesh/update +++ b/gcloud/alpha/container/fleet/mesh/update @@ -5,18 +5,19 @@ NAME SYNOPSIS gcloud alpha container fleet mesh update (--control-plane=CONTROL_PLANE --management=MANAGEMENT) - [--membership=MEMBERSHIP | --memberships=MEMBERSHIPS] + [--membership=MEMBERSHIP + | [--memberships=[MEMBERSHIPS,...] : --location=LOCATION]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Update the Service Mesh Feature Spec of a Membership. + (ALPHA) Update the Service Mesh Feature Spec of a membership. EXAMPLES - To update the control plane management of comma separated Memberships like - membership1,membership2, run: + To update the control plane management of comma separated memberships like + MEMBERSHIP1,MEMBERSHIP2, run: $ gcloud alpha container fleet mesh update \ - --memberships=membership1,membership2 \ + --memberships=MEMBERSHIP1,MEMBERSHIP2 \ --control-plane=CONTROL_PLANE REQUIRED FLAGS @@ -39,9 +40,30 @@ OPTIONAL FLAGS The --membership flag is now deprecated. Please use --memberships instead. - --memberships=MEMBERSHIPS - Membership names to update, separated by commas if multiple are - supplied. + Membership resource - The group of arguments defining one or more + memberships. 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 --memberships on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + + --memberships=[MEMBERSHIPS,...] + IDs of the memberships or fully qualified identifiers for the + memberships. To set the memberships attribute: + ▫ provide the argument --memberships on the command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --location=LOCATION + Location for the memberships. To set the location attribute: + ▫ provide the argument --memberships on the command line with a + fully specified name; + ▫ provide the argument --location on the command line; + ▫ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/fleet/policycontroller/help b/gcloud/alpha/container/fleet/policycontroller/help new file mode 100644 index 000000000..b6c7ff420 --- /dev/null +++ b/gcloud/alpha/container/fleet/policycontroller/help @@ -0,0 +1,22 @@ +NAME + gcloud alpha container fleet policycontroller - manage Policy Controller + Feature + +SYNOPSIS + gcloud alpha container fleet policycontroller GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Policy Controller Feature. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + 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. + diff --git a/gcloud/alpha/container/help b/gcloud/alpha/container/help index 3206eaee8..58ebd10b5 100644 --- a/gcloud/alpha/container/help +++ b/gcloud/alpha/container/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + attached + (ALPHA) Manage Attached clusters for running containers. + aws (ALPHA) Deploy and manage clusters of machines on AWS for running containers. @@ -27,6 +30,10 @@ GROUPS backup-restore (ALPHA) Backup for GKE Services. + bare-metal + (ALPHA) Deploy and manage Anthos clusters on bare metal for running + containers. + binauthz (ALPHA) Manage attestations for Binary Authorization on Google Cloud Platform. @@ -55,6 +62,10 @@ GROUPS subnets (ALPHA) Manage subnets to be used by Google Kubernetes Engine clusters. + vmware + (ALPHA) Deploy and manage Anthos clusters on VMware for running + containers. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/container/hub/config-management/apply b/gcloud/alpha/container/hub/config-management/apply index 680ea78ae..f63ad2df5 100644 --- a/gcloud/alpha/container/hub/config-management/apply +++ b/gcloud/alpha/container/hub/config-management/apply @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container hub config-management apply --config=CONFIG - [--membership=MEMBERSHIP] [--version=VERSION] [GCLOUD_WIDE_FLAG ...] + [--version=VERSION] [--membership=MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update a user-specified config file to a ConfigManagement Custom @@ -26,12 +27,33 @@ REQUIRED FLAGS The path to config-management.yaml. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. - --version=VERSION The version of ACM to install. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/hub/config-management/delete b/gcloud/alpha/container/hub/config-management/delete index d3f16d241..a6ce86e5b 100644 --- a/gcloud/alpha/container/hub/config-management/delete +++ b/gcloud/alpha/container/hub/config-management/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub config-management delete - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) (DEPRECATED) Remove the Config Management Feature Spec for the @@ -22,8 +22,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/config-management/fetch-for-apply b/gcloud/alpha/container/hub/config-management/fetch-for-apply index 7357087e9..28e34f3ac 100644 --- a/gcloud/alpha/container/hub/config-management/fetch-for-apply +++ b/gcloud/alpha/container/hub/config-management/fetch-for-apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub config-management fetch-for-apply - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) The output is in the format that is used by the apply subcommand. @@ -16,8 +16,29 @@ EXAMPLES $ gcloud alpha container hub config-management fetch-for-apply FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/config-management/unmanage b/gcloud/alpha/container/hub/config-management/unmanage index 192b056ee..afb5a7ce9 100644 --- a/gcloud/alpha/container/hub/config-management/unmanage +++ b/gcloud/alpha/container/hub/config-management/unmanage @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub config-management unmanage - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Remove the Config Management Feature Spec for the given membership. @@ -18,8 +18,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/config-management/upgrade b/gcloud/alpha/container/hub/config-management/upgrade index 9fffe0883..6c202e54e 100644 --- a/gcloud/alpha/container/hub/config-management/upgrade +++ b/gcloud/alpha/container/hub/config-management/upgrade @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub config-management upgrade --version=VERSION - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Upgrade a specified membership to any supported version of the @@ -21,8 +21,29 @@ REQUIRED FLAGS The version of ACM to change to. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/features/list b/gcloud/alpha/container/hub/features/list index 028f0e251..911fad03f 100644 --- a/gcloud/alpha/container/hub/features/list +++ b/gcloud/alpha/container/hub/features/list @@ -7,15 +7,15 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List enabled Hub features in a project. + (ALPHA) List enabled fleet features in a project. EXAMPLES - To list all enabled Hub features in a project, run: + To list all enabled fleet features in a project, run: $ gcloud alpha container hub features list FLAGS - Location resource - The location to list Features under. + Location resource - The location to list features under. 'global' is the only supported value. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be diff --git a/gcloud/alpha/container/hub/help b/gcloud/alpha/container/hub/help index f93ed617f..0049441b9 100644 --- a/gcloud/alpha/container/hub/help +++ b/gcloud/alpha/container/hub/help @@ -61,8 +61,8 @@ GROUPS (ALPHA) Manage Multi-cluster Ingress Feature. memberships - (ALPHA) Manage memberships of all your GKE and other Kubernetes cluster - with fleets. + (ALPHA) Manage memberships of all your GKE and other Kubernetes + clusters with fleets. mesh (ALPHA) Manage Service Mesh Feature. @@ -70,6 +70,9 @@ GROUPS multi-cluster-services (ALPHA) Manage Multi-cluster Services Feature. + policycontroller + (ALPHA) Manage Policy Controller Feature. + service-directory (ALPHA) Manage the Service Directory Feature. diff --git a/gcloud/alpha/container/hub/identity-service/apply b/gcloud/alpha/container/hub/identity-service/apply index 4bc0246ef..bc0ff0de3 100644 --- a/gcloud/alpha/container/hub/identity-service/apply +++ b/gcloud/alpha/container/hub/identity-service/apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub identity-service apply --config=CONFIG - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Applies the authentication configuration to the Identity Service @@ -26,8 +26,29 @@ REQUIRED FLAGS The path to the identity-service.yaml config file. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/identity-service/delete b/gcloud/alpha/container/hub/identity-service/delete index b2a771b7b..4d26ea77c 100644 --- a/gcloud/alpha/container/hub/identity-service/delete +++ b/gcloud/alpha/container/hub/identity-service/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha container hub identity-service delete - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Removes the Identity Service Feature Spec for the given membership. @@ -16,8 +16,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/ingress/enable b/gcloud/alpha/container/hub/ingress/enable index 68ff4d7f6..43bd6bab0 100644 --- a/gcloud/alpha/container/hub/ingress/enable +++ b/gcloud/alpha/container/hub/ingress/enable @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container hub ingress enable - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command enables Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/ingress/update b/gcloud/alpha/container/hub/ingress/update index 911fbe290..126eadd76 100644 --- a/gcloud/alpha/container/hub/ingress/update +++ b/gcloud/alpha/container/hub/ingress/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha container hub ingress update - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command updates Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/memberships/describe b/gcloud/alpha/container/hub/memberships/describe index dfce1b0ad..6b72aa3c4 100644 --- a/gcloud/alpha/container/hub/memberships/describe +++ b/gcloud/alpha/container/hub/memberships/describe @@ -6,12 +6,12 @@ SYNOPSIS (MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Describe a membership in Fleet. + (ALPHA) Describe a membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud alpha container hub memberships list diff --git a/gcloud/alpha/container/hub/memberships/get-credentials b/gcloud/alpha/container/hub/memberships/get-credentials index 705a9f089..94c2331ee 100644 --- a/gcloud/alpha/container/hub/memberships/get-credentials +++ b/gcloud/alpha/container/hub/memberships/get-credentials @@ -3,31 +3,64 @@ NAME for a fleet-registered cluster to be used in Connect Gateway SYNOPSIS - gcloud alpha container hub memberships get-credentials MEMBERSHIP - [GCLOUD_WIDE_FLAG ...] + gcloud alpha container hub memberships get-credentials + (MEMBERSHIP_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha container hub memberships get-credentials updates the kubeconfig file with the appropriate credentials and endpoint information - to send kubectl commands to a fleet-registered and connected cluster - through Connect Gateway Service. + to send kubectl commands to a fleet-registered and -connected cluster + through the Connect Gateway service. It takes a project, passed through by set defaults or flags. By default, credentials are written to $HOME/.kube/config. You can provide an alternate path by setting the KUBECONFIG environment variable. If KUBECONFIG contains multiple paths, the first one is used. - Upon success, this command will switch current context to the target - cluster, when working with multiple clusters. + Upon success, this command will switch the current context to the target + cluster if other contexts are already present in the kubeconfig file. EXAMPLES - Get gateway kubeconfig for a registered cluster: + Get the Gateway kubeconfig for a globally registered cluster: $ gcloud alpha container hub memberships get-credentials my-cluster + $ gcloud alpha container hub memberships get-credentials \ + my-cluster --location=global + + Get the Gateway kubeconfig for a cluster registered in us-central1: + + $ gcloud alpha container hub memberships get-credentials \ + my-cluster --location=us-central1 POSITIONAL ARGUMENTS - MEMBERSHIP - The membership name used to locate a cluster in your project. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/container/hub/memberships/help b/gcloud/alpha/container/hub/memberships/help index 59fcb5f3d..1ff6189c7 100644 --- a/gcloud/alpha/container/hub/memberships/help +++ b/gcloud/alpha/container/hub/memberships/help @@ -1,12 +1,13 @@ NAME gcloud alpha container hub memberships - manage memberships of all your GKE - and other Kubernetes cluster with fleets + and other Kubernetes clusters with fleets SYNOPSIS - gcloud alpha container hub memberships COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud alpha container hub memberships GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Manage memberships of all your GKE and other Kubernetes cluster + (ALPHA) Manage memberships of all your GKE and other Kubernetes clusters with fleets. GCLOUD WIDE FLAGS @@ -37,7 +38,7 @@ COMMANDS (ALPHA) Register a cluster with a fleet. unregister - (ALPHA) Unregister a cluster from Fleet. + (ALPHA) Unregister a cluster from a fleet. update (ALPHA) Update a membership. diff --git a/gcloud/alpha/container/hub/memberships/register b/gcloud/alpha/container/hub/memberships/register index 7fb88ba95..cc918243d 100644 --- a/gcloud/alpha/container/hub/memberships/register +++ b/gcloud/alpha/container/hub/memberships/register @@ -102,7 +102,7 @@ EXAMPLES $ gcloud alpha container hub memberships register my-cluster \ --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --install-connect-agent --version=20220819-00-00 \ --service-account-key-file=/tmp/keyfile.json Register a GKE cluster and output a manifest that can be used to install the diff --git a/gcloud/alpha/container/hub/memberships/unregister b/gcloud/alpha/container/hub/memberships/unregister index 6db5fb962..d8f1f59a7 100644 --- a/gcloud/alpha/container/hub/memberships/unregister +++ b/gcloud/alpha/container/hub/memberships/unregister @@ -1,6 +1,6 @@ NAME gcloud alpha container hub memberships unregister - unregister a cluster - from Fleet + from a fleet SYNOPSIS gcloud alpha container hub memberships unregister diff --git a/gcloud/alpha/container/hub/memberships/update b/gcloud/alpha/container/hub/memberships/update index e78cd2778..7e3585fdc 100644 --- a/gcloud/alpha/container/hub/memberships/update +++ b/gcloud/alpha/container/hub/memberships/update @@ -8,12 +8,12 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Update an existing membership in Fleet. + (ALPHA) Update an existing membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud alpha container hub memberships list diff --git a/gcloud/alpha/container/hub/mesh/update b/gcloud/alpha/container/hub/mesh/update index df4c5f7f9..b64e0e75b 100644 --- a/gcloud/alpha/container/hub/mesh/update +++ b/gcloud/alpha/container/hub/mesh/update @@ -5,18 +5,19 @@ NAME SYNOPSIS gcloud alpha container hub mesh update (--control-plane=CONTROL_PLANE --management=MANAGEMENT) - [--membership=MEMBERSHIP | --memberships=MEMBERSHIPS] + [--membership=MEMBERSHIP + | [--memberships=[MEMBERSHIPS,...] : --location=LOCATION]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Update the Service Mesh Feature Spec of a Membership. + (ALPHA) Update the Service Mesh Feature Spec of a membership. EXAMPLES - To update the control plane management of comma separated Memberships like - membership1,membership2, run: + To update the control plane management of comma separated memberships like + MEMBERSHIP1,MEMBERSHIP2, run: $ gcloud alpha container hub mesh update \ - --memberships=membership1,membership2 \ + --memberships=MEMBERSHIP1,MEMBERSHIP2 \ --control-plane=CONTROL_PLANE REQUIRED FLAGS @@ -39,9 +40,30 @@ OPTIONAL FLAGS The --membership flag is now deprecated. Please use --memberships instead. - --memberships=MEMBERSHIPS - Membership names to update, separated by commas if multiple are - supplied. + Membership resource - The group of arguments defining one or more + memberships. 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 --memberships on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + + --memberships=[MEMBERSHIPS,...] + IDs of the memberships or fully qualified identifiers for the + memberships. To set the memberships attribute: + ▫ provide the argument --memberships on the command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --location=LOCATION + Location for the memberships. To set the location attribute: + ▫ provide the argument --memberships on the command line with a + fully specified name; + ▫ provide the argument --location on the command line; + ▫ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/vmware/help b/gcloud/alpha/container/hub/policycontroller/help similarity index 63% rename from gcloud/alpha/vmware/help rename to gcloud/alpha/container/hub/policycontroller/help index 67182da5d..446786e89 100644 --- a/gcloud/alpha/vmware/help +++ b/gcloud/alpha/container/hub/policycontroller/help @@ -1,11 +1,13 @@ NAME - gcloud alpha vmware - manage Google Cloud VMware Engine resources + gcloud alpha container hub policycontroller - manage Policy Controller + Feature SYNOPSIS - gcloud alpha vmware GROUP [GCLOUD_WIDE_FLAG ...] + gcloud alpha container hub policycontroller GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Manage Google Cloud VMware Engine resources. + (ALPHA) Manage Policy Controller Feature. GCLOUD WIDE FLAGS These flags are available to all commands: --help. diff --git a/gcloud/alpha/container/node-pools/config/export b/gcloud/alpha/container/node-pools/config/export index 54f2149d4..5e8b8cda4 100644 --- a/gcloud/alpha/container/node-pools/config/export +++ b/gcloud/alpha/container/node-pools/config/export @@ -85,7 +85,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/container/node-pools/create b/gcloud/alpha/container/node-pools/create index c0fb0e3c9..191c2db29 100644 --- a/gcloud/alpha/container/node-pools/create +++ b/gcloud/alpha/container/node-pools/create @@ -8,13 +8,14 @@ SYNOPSIS gpu-partition-size=GPU_PARTITION_SIZE, gpu-sharing-strategy=GPU_SHARING_STRATEGY, max-shared-clients-per-gpu=MAX_SHARED_CLIENTS_PER_GPU],...]] - [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] + [--async] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] [--disable-pod-cidr-overprovision] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] - [--enable-gvnic] [--enable-image-streaming] [--enable-surge-upgrade] - [--image-type=IMAGE_TYPE] [--linux-sysctls=KEY=VALUE,[KEY=VALUE,...]] + [--enable-gvnic] [--enable-image-streaming] [--enable-private-nodes] + [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] + [--labels=[KEY=VALUE,...]] [--linux-sysctls=KEY=VALUE,[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] @@ -36,12 +37,15 @@ SYNOPSIS batch-soak-duration=BATCH_SOAK_DURATION,...]] [--system-config-from-file=SYSTEM_CONFIG_FROM_FILE] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] + [--windows-os-version=WINDOWS_OS_VERSION] [--workload-metadata=WORKLOAD_METADATA] [--create-pod-ipv4-range=[KEY=VALUE,...] | --pod-ipv4-range=NAME] [--enable-autoscaling --location-policy=LOCATION_POLICY --max-nodes=MAX_NODES --min-nodes=MIN_NODES --total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES] [--ephemeral-storage=[local-ssd-count=LOCAL-SSD-COUNT] + | --ephemeral-storage-local-ssd=[count=COUNT] + | --local-nvme-ssd-block=[count=COUNT] | --local-ssd-count=LOCAL_SSD_COUNT | --local-ssd-volumes=[[count=COUNT], [type=TYPE],[format=FORMAT],...]] @@ -103,6 +107,10 @@ FLAGS (Optional) The max number of containers allowed to share each GPU on the node. This field is used together with gpu-sharing-strategy. + --async + Return immediately, without waiting for the operation in progress to + complete. + --boot-disk-kms-key=BOOT_DISK_KMS_KEY The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form @@ -174,6 +182,13 @@ FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-private-nodes + Enables provisioning nodes with private IP addresses only. + + The control plane still communicates with all nodes through private IP + addresses only, regardless of whether private nodes are enabled or + disabled. + --enable-surge-upgrade Changes node pool upgrade strategy to surge upgrade. @@ -190,6 +205,15 @@ FLAGS $ gcloud container get-server-config + --labels=[KEY=VALUE,...] + Labels to apply to the Google Cloud resources of node pools in the + Kubernetes Engine cluster. These are unrelated to Kubernetes labels. + + Examples: + + $ gcloud alpha container node-pools create node-pool-1 \ + --cluster=example-cluster --labels=label1=value1,label2=value2 + --linux-sysctls=KEY=VALUE,[KEY=VALUE,...] Linux kernel parameters to be applied to all nodes in the new node pool as well as the pods running on the nodes. @@ -419,9 +443,9 @@ FLAGS UNSPECIFIED - No requirements on the placement of nodes. This is the default option. - COMPACT - Google will attempt to place the nodes in a close proximity - to each other. This helps to reduce the communication latency between - the nodes, but imposes additional limitations on the node pool size. + COMPACT - GKE will attempt to place the nodes in a close proximity to + each other. This helps to reduce the communication latency between the + nodes, but imposes additional limitations on the node pool size. $ gcloud alpha container node-pools create node-pool-1 \ --cluster=example-cluster --placement-type=COMPACT @@ -543,6 +567,14 @@ FLAGS The number of visible threads per physical core for each node. To disable simultaneous multithreading (SMT) set this to 1. + --windows-os-version=WINDOWS_OS_VERSION + Specifies the Windows Server Image to use when creating a Windows node + pool. Valid variants can be "ltsc2019", "ltsc2022". It means using + LTSC2019 server image or LTSC2022 server image. If the node pool + doesn't specify a Windows Server Image Os version, then Ltsc2019 will + be the default one to use. WINDOWS_OS_VERSION must be one of: ltsc2019, + ltsc2022. + --workload-metadata=WORKLOAD_METADATA Type of metadata server available to pods running in the node pool. WORKLOAD_METADATA must be one of: @@ -638,7 +670,8 @@ FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the node @@ -692,12 +725,48 @@ FLAGS 'local-ssd-count' specifies the number of local SSDs to use to back ephemeral storage. Local SDDs use NVMe interfaces and each is 375 GB - in size. If 'local-ssd-count=0', it means to disable using local SSDs - as ephemeral storage. + in size. Setting 'local-ssd-count=0' disables using local SSDs as + ephemeral storage. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. + --ephemeral-storage-local-ssd=[count=COUNT] + Parameters for the ephemeral storage filesystem. If unspecified, + ephemeral storage is backed by the boot disk. + + Examples: + + $ gcloud alpha container node-pools create node-pool-1 \ + --cluster=example cluster --ephemeral-storage-local-ssd count=2 + + 'count' specifies the number of local SSDs to use to back ephemeral + storage. Local SDDs use NVMe interfaces and each is 375 GB in size. + Setting 'count=0' disables using local SSDs as ephemeral storage. + + See https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-nvme-ssd-block=[count=COUNT] + Adds the requested local SSDs on all nodes in default node pool(s) in + the new cluster. + + Examples: + + $ gcloud alpha container node-pools create node-pool-1 \ + --cluster=example cluster --local-nvme-ssd-block count=2 + + 'count' must be between 1-8 + + New nodes, including ones created by resize or recreate, will have these + local SSDs. + + Local SSDs have a fixed 375 GB capacity per device. The number of disks + that can be attached to an instance is limited by the maximum number of + disks available on a machine, which differs by compute zone. See + https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + --local-ssd-count=LOCAL_SSD_COUNT --local-ssd-count is the equivalent of using --local-ssd-volumes with type=scsi,format=fs @@ -713,7 +782,7 @@ FLAGS --local-ssd-volumes=[[count=COUNT],[type=TYPE],[format=FORMAT],...] Adds the requested local SSDs on all nodes in default node pool(s) in - new cluster. + the new cluster. Examples: diff --git a/gcloud/alpha/container/node-pools/delete b/gcloud/alpha/container/node-pools/delete index 5e10fd9db..80daed65e 100644 --- a/gcloud/alpha/container/node-pools/delete +++ b/gcloud/alpha/container/node-pools/delete @@ -8,9 +8,12 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha container node-pools delete deletes a node pool from a - Google Kubernetes Engine cluster. This command does not gracefully drain - the nodes prior to deleting them. Use "kubectl drain NODE_NAME" to drain - each node to have containers running on these nodes terminate gracefully. + Google Kubernetes Engine (GKE) cluster. When you delete a node pool, GKE + drains all the nodes in the node pool. The draining process involves GKE + evicting Pods on each node in the node pool. Each node in a node pool is + drained by evicting Pods with an allotted graceful termination period of + MAX_POD. MAX_POD is the maximum terminationGracePeriodSeconds set on the + Pods scheduled to the node with a cap of one hour. EXAMPLES To delete the "node-pool-1" node pool from the cluster "sample-cluster", diff --git a/gcloud/alpha/container/node-pools/update b/gcloud/alpha/container/node-pools/update index 87050962b..220edc63b 100644 --- a/gcloud/alpha/container/node-pools/update +++ b/gcloud/alpha/container/node-pools/update @@ -5,15 +5,16 @@ NAME SYNOPSIS gcloud alpha container node-pools update NAME (--enable-confidential-nodes | --enable-gvnic - | --enable-image-streaming | --logging-variant=LOGGING_VARIANT + | --enable-image-streaming | --enable-private-nodes + | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] | --system-config-from-file=SYSTEM_CONFIG_FROM_FILE - | --tags=[TAG,...] | --workload-metadata=WORKLOAD_METADATA - | --enable-autoprovisioning --enable-autoscaling - --location-policy=LOCATION_POLICY --max-nodes=MAX_NODES - --min-nodes=MIN_NODES + | --tags=[TAG,...] | --windows-os-version=WINDOWS_OS_VERSION + | --workload-metadata=WORKLOAD_METADATA | --enable-autoprovisioning + --enable-autoscaling --location-policy=LOCATION_POLICY + --max-nodes=MAX_NODES --min-nodes=MIN_NODES --total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES | --enable-autorepair --enable-autoupgrade | --enable-blue-green-upgrade --enable-surge-upgrade @@ -22,8 +23,9 @@ SYNOPSIS --node-pool-soak-duration=NODE_POOL_SOAK_DURATION --standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, batch-percent=BATCH_NODE_PERCENTAGE, - batch-soak-duration=BATCH_SOAK_DURATION,...]) [--cluster=CLUSTER] - [--region=REGION | --zone=ZONE, -z ZONE] [GCLOUD_WIDE_FLAG ...] + batch-soak-duration=BATCH_SOAK_DURATION,...]) [--async] + [--cluster=CLUSTER] [--region=REGION | --zone=ZONE, -z ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha container node-pools update updates a node pool in a @@ -54,6 +56,22 @@ REQUIRED FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-private-nodes + Enables provisioning nodes with private IP addresses only. + + The control plane still communicates with all nodes through private + IP addresses only, regardless of whether private nodes are enabled or + disabled. + + --labels=[KEY=VALUE,...] + Labels to apply to the Google Cloud resources of node pools in the + Kubernetes Engine cluster. These are unrelated to Kubernetes labels. + + Examples: + + $ gcloud alpha container node-pools update node-pool-1 \ + --cluster=example-cluster --labels=label1=value1,label2=value2 + --logging-variant=LOGGING_VARIANT Specifies the logging variant that will be deployed on all the nodes in the node pool. If the node pool doesn't specify a logging variant, @@ -188,6 +206,14 @@ REQUIRED FLAGS https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/create for examples. + --windows-os-version=WINDOWS_OS_VERSION + Specifies the Windows Server Image to use when creating a Windows + node pool. Valid variants can be "ltsc2019", "ltsc2022". It means + using LTSC2019 server image or LTSC2022 server image. If the node + pool doesn't specify a Windows Server Image Os version, then Ltsc2019 + will be the default one to use. WINDOWS_OS_VERSION must be one of: + ltsc2019, ltsc2022. + --workload-metadata=WORKLOAD_METADATA Type of metadata server available to pods running in the node pool. WORKLOAD_METADATA must be one of: @@ -234,7 +260,8 @@ REQUIRED FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or - the default node pool if --node-pool is not provided. + the default node pool if --node-pool is not provided. If not + already, --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the @@ -363,6 +390,10 @@ REQUIRED FLAGS batch-soak-duration=60s OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --cluster=CLUSTER The name of the cluster. Overrides the default container/cluster property value for this command invocation. diff --git a/gcloud/alpha/container/vmware/admin-clusters/describe b/gcloud/alpha/container/vmware/admin-clusters/describe new file mode 100644 index 000000000..9360671f2 --- /dev/null +++ b/gcloud/alpha/container/vmware/admin-clusters/describe @@ -0,0 +1,60 @@ +NAME + gcloud alpha container vmware admin-clusters describe - describe an Anthos + on VMware admin cluster + +SYNOPSIS + gcloud alpha container vmware admin-clusters describe + (ADMIN_CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an Anthos on VMware admin cluster. + +EXAMPLES + To describe an admin cluster named my-cluster managed in location us-west1, + run: + + $ gcloud alpha container vmware admin-clusters describe my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Admin cluster resource - admin cluster 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 admin_cluster 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. + + ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ▸ provide the argument admin_cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the admin_cluster. To set the location + attribute: + ▸ provide the argument admin_cluster on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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. + diff --git a/gcloud/alpha/container/vmware/admin-clusters/enroll b/gcloud/alpha/container/vmware/admin-clusters/enroll new file mode 100644 index 000000000..aa9009596 --- /dev/null +++ b/gcloud/alpha/container/vmware/admin-clusters/enroll @@ -0,0 +1,92 @@ +NAME + gcloud alpha container vmware admin-clusters enroll - enroll an Anthos on + VMware admin cluster + +SYNOPSIS + gcloud alpha container vmware admin-clusters enroll + (ADMIN_CLUSTER : --location=LOCATION) + (--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global") + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Enroll an Anthos on VMware admin cluster. + +POSITIONAL ARGUMENTS + Admin cluster resource - admin cluster to enroll 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 admin_cluster 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. + + ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ▸ provide the argument admin_cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the admin_cluster. To set the location + attribute: + ▸ provide the argument admin_cluster on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +REQUIRED FLAGS + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. 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 --admin-cluster-membership 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. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier for + the admin_cluster_membership. To set the admin_cluster_membership + attribute: + ▸ provide the argument --admin-cluster-membership on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global" + Google Cloud location for the admin_cluster_membership. To set the + location attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-location on the + command line. + +OPTIONAL 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. + +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. + diff --git a/gcloud/alpha/container/vmware/admin-clusters/help b/gcloud/alpha/container/vmware/admin-clusters/help new file mode 100644 index 000000000..155695121 --- /dev/null +++ b/gcloud/alpha/container/vmware/admin-clusters/help @@ -0,0 +1,36 @@ +NAME + gcloud alpha container vmware admin-clusters - create and manage admin + clusters in Anthos on VMware + +SYNOPSIS + gcloud alpha container vmware admin-clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage admin clusters in Anthos on VMware. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe an Anthos on VMware admin cluster. + + enroll + (ALPHA) Enroll an Anthos on VMware admin cluster. + + list + (ALPHA) List Anthos on VMware admin clusters. + + update + (ALPHA) Update an Anthos on VMware admin cluster. + +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. + diff --git a/gcloud/alpha/container/vmware/admin-clusters/list b/gcloud/alpha/container/vmware/admin-clusters/list new file mode 100644 index 000000000..2f95618b0 --- /dev/null +++ b/gcloud/alpha/container/vmware/admin-clusters/list @@ -0,0 +1,82 @@ +NAME + gcloud alpha container vmware admin-clusters list - list Anthos on VMware + admin clusters + +SYNOPSIS + gcloud alpha container vmware admin-clusters list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Anthos on VMware admin clusters. + +EXAMPLES + To list all admin clusters managed in location us-west1, run: + + $ gcloud alpha container vmware admin-clusters list \ + --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list Anthos on VMware admin + clusters. 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 --location on the command line with a fully + specified name; + ◆ set the property container_vmware/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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 + 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. + diff --git a/gcloud/alpha/container/vmware/admin-clusters/update b/gcloud/alpha/container/vmware/admin-clusters/update new file mode 100644 index 000000000..e7f535510 --- /dev/null +++ b/gcloud/alpha/container/vmware/admin-clusters/update @@ -0,0 +1,72 @@ +NAME + gcloud alpha container vmware admin-clusters update - update an Anthos on + VMware admin cluster + +SYNOPSIS + gcloud alpha container vmware admin-clusters update + (ADMIN_CLUSTER : --location=LOCATION) [--async] + [--required-platform-version=REQUIRED_PLATFORM_VERSION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an Anthos on VMware admin cluster. + +EXAMPLES + To update a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container vmware admin-clusters update my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Admin cluster resource - admin cluster to update 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 admin_cluster 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. + + ADMIN_CLUSTER + ID of the admin_cluster or fully qualified identifier for the + admin_cluster. To set the admin_cluster attribute: + ▸ provide the argument admin_cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the admin_cluster. To set the location + attribute: + ▸ provide the argument admin_cluster on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --required-platform-version=REQUIRED_PLATFORM_VERSION + Platform version required for upgrading a user cluster. If the current + platform version is lower than the required version, the platform + version will be updated to the required version. If it is not installed + in the platform, download the required version bundle. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/create b/gcloud/alpha/container/vmware/clusters/create new file mode 100644 index 000000000..896b0f698 --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/create @@ -0,0 +1,361 @@ +NAME + gcloud alpha container vmware clusters create - create an Anthos cluster on + VMware + +SYNOPSIS + gcloud alpha container vmware clusters create + (CLUSTER : --location=LOCATION) + (--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT) + ((--control-plane-vip=CONTROL_PLANE_VIP --ingress-vip=INGRESS_VIP) + (--metal-lb-config-from-file=METAL_LB_CONFIG_FROM_FILE + : --control-plane-node-port=CONTROL_PLANE_NODE_PORT + --ingress-http-node-port=INGRESS_HTTP_NODE_PORT + --ingress-https-node-port=INGRESS_HTTPS_NODE_PORT + --konnectivity-server-node-port=KONNECTIVITY_SERVER_NODE_PORT + | [--f5-config-address=F5_CONFIG_ADDRESS + --f5-config-partition=F5_CONFIG_PARTITION + : --f5-config-snat-pool=F5_CONFIG_SNAT_POOL])) + (--pod-address-cidr-blocks=POD_ADDRESS + --service-address-cidr-blocks=SERVICE_ADDRESS + : --dns-search-domains=[DNS_SEARCH_DOMAINS,...] + --dns-servers=[DNS_SERVERS,...] + --ntp-servers=[NTP_SERVERS,...] --enable-dhcp + | --static-ip-config-from-file=STATIC_IP_CONFIG_FROM_FILE) + [--admin-users=ADMIN_USERS] [--annotations=[KEY=VALUE,...]] [--async] + [--description=DESCRIPTION] [--disable-aag-config] + [--disable-vsphere-csi] [--enable-auto-repair] [--enable-vm-tracking] + [--validate-only] [--version=VERSION] + [--cpus=CPUS --enable-auto-resize --memory=MEMORY --replicas=REPLICAS] + [--enable-advanced-networking --enable-dataplane-v2] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create an Anthos cluster on VMware. + +EXAMPLES + To create a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container vmware clusters create my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to create 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +REQUIRED FLAGS + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. The + arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier for + the admin_cluster_membership. To set the admin_cluster_membership + attribute: + ▸ provide the argument --admin-cluster-membership on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION + Google Cloud location for the admin_cluster_membership. To set the + location attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-location on the + command line. + + --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT + Google Cloud project for the admin_cluster_membership. To set the + project attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-project on the + command line. + + Anthos on VMware cluster load balancer configurations + + This must be specified. + + VIPs used by the load balancer + + This must be specified. + + --control-plane-vip=CONTROL_PLANE_VIP + VIP for the Kubernetes API of this cluster. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --ingress-vip=INGRESS_VIP + VIP for ingress traffic into this cluster. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Populate one of the load balancers. + + Exactly one of these must be specified: + + MetalLB Configuration + + --metal-lb-config-from-file=METAL_LB_CONFIG_FROM_FILE + Path of the YAML/JSON file that contains the MetalLB + configurations. + + Examples: + + metalLBConfig: + addressPools: + - pool: lb-test-ip + addresses: + - 10.251.133.79/32 + - 10.251.133.80/32 + avoidBuggyIPs: True + manualAssign: False + - pool: ingress-ip + addresses: + - 10.251.133.70/32 + avoidBuggyIPs: False + manualAssign: True + + List of supported fields in metalLBConfig + + KEY VALUE NOTE + addressPools one or more addressPools required, mutable + + List of supported fields in addressPools + + KEY VALUE NOTE + pool string required, mutable + addresses one or more IP ranges required, mutable + avoidBuggyIPs bool optional, mutable, + defaults to False + manualAssign bool optional, mutable, + defaults to False + + Manual load balancer configuration + + --control-plane-node-port=CONTROL_PLANE_NODE_PORT + NodePort for control plane service. + + --ingress-http-node-port=INGRESS_HTTP_NODE_PORT + NodePort for ingress service's http. + + --ingress-https-node-port=INGRESS_HTTPS_NODE_PORT + NodePort for ingress service's https. + + --konnectivity-server-node-port=KONNECTIVITY_SERVER_NODE_PORT + NodePort for konnectivity service running as a sidecar in each + kube-apiserver pod. + + F5 Big IP Configuration + + --f5-config-address=F5_CONFIG_ADDRESS + F5 Big IP load balancer address. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --f5-config-partition=F5_CONFIG_PARTITION + F5 Big IP load balancer partition. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --f5-config-snat-pool=F5_CONFIG_SNAT_POOL + F5 Big IP load balancer pool name if using SNAT. + + VMware User Cluster network configurations + + This must be specified. + + --pod-address-cidr-blocks=POD_ADDRESS + IPv4 address range for all pods in the cluster. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --service-address-cidr-blocks=SERVICE_ADDRESS + IPv4 address range for all services in the cluster. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Common parameters for all hosts irrespective of their IP address + + --dns-search-domains=[DNS_SEARCH_DOMAINS,...] + DNS search domains. + + --dns-servers=[DNS_SERVERS,...] + DNS server IP address. + + --ntp-servers=[NTP_SERVERS,...] + NTP server IP address. + + IP configuration used by the VMware User Cluster + + At most one of these can be specified: + + DHCP configuration group. + + --enable-dhcp + Enable DHCP IP allocation for VMware user clusters. + + Static IP configuration group + + --static-ip-config-from-file=STATIC_IP_CONFIG_FROM_FILE + Path of the YAML/JSON file that contains the static IP + configurations, used by Anthos on VMware user cluster node pools. + + Examples: + + staticIPConfig: + ipBlocks: + - gateway: 10.251.31.254 + netmask: 255.255.252.0 + ips: + - hostname: hostname-1 + ip: 1.1.1.1 + - hostname: hostname-2 + ip: 2.2.2.2 + - hostname: hostname-3 + ip: 3.3.3.3 + - hostname: hostname-4 + ip: 4.4.4.4 + + List of supported fields in staticIPConfig + + KEY VALUE NOTE + ipBlocks one or more ipBlocks required, mutable + + List of supported fields in ipBlocks + + KEY VALUE NOTE + gateway IP address required, immutable + netmask IP address required, immutable + ips one or more ips required, mutable + + List of supported fields in ips + + KEY VALUE NOTE + hostname string optional, immutable + ip IP address required, immutable + + New ips fields can be added, existing ips fields cannot be + removed or updated. + +OPTIONAL FLAGS + User cluster authorization configurations to bootstrap onto the admin + cluster + + --admin-users=ADMIN_USERS + Users that will be granted the cluster-admin role on the cluster, + providing full access to the cluster. + + --annotations=[KEY=VALUE,...] + Annotations on the VMware user cluster. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Description for the resource. + + Anti-affinity group configurations + + --disable-aag-config + If set, spread nodes across at least three physical hosts (requires + at least three hosts). Enabled by default. + + Storage configurations + + --disable-vsphere-csi + If set, vSphere CSI components are not deployed in the VMware User + Cluster. Enabled by default. + + Auto-repair configurations + + --enable-auto-repair + If set, deploy the cluster-health-controller. + + --enable-vm-tracking + If set, enable VM tracking. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + + --version=VERSION + Anthos Cluster on VMware version for the user cluster resource + + Control plane node configurations + + --cpus=CPUS + Number of CPUs for each admin cluster node that serve as control + planes for this VMware user cluster. (default: 4 CPUs) + + Auto resize configurations + + --enable-auto-resize + Enable controle plane node auto resize. + + --memory=MEMORY + Megabytes of memory for each admin cluster node that serves as a + control plane for this VMware User Cluster (default: 8192 MB memory). + + --replicas=REPLICAS + Number of control plane nodes for this VMware user cluster. (default: + 1 replica). + + Dataplane V2 configurations + + --enable-advanced-networking + If set, enable advanced networking. Requires dataplane_v2_enabled to + be set true. + + --enable-dataplane-v2 + If set, enables Dataplane V2. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/delete b/gcloud/alpha/container/vmware/clusters/delete new file mode 100644 index 000000000..fcb113ab5 --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/delete @@ -0,0 +1,72 @@ +NAME + gcloud alpha container vmware clusters delete - delete an Anthos cluster on + VMware + +SYNOPSIS + gcloud alpha container vmware clusters delete + (CLUSTER : --location=LOCATION) [--allow-missing] [--async] [--force] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an Anthos cluster on VMware. + +EXAMPLES + To delete a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container vmware clusters delete my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +FLAGS + --allow-missing + If set, and the Anthos cluster on VMware is not found, the request will + succeed but no action will be taken. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --force + If set, any node pools from the cluster will also be deleted. This flag + is required if the cluster has any associated node pools. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/describe b/gcloud/alpha/container/vmware/clusters/describe new file mode 100644 index 000000000..baca67f17 --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/describe @@ -0,0 +1,58 @@ +NAME + gcloud alpha container vmware clusters describe - describe an Anthos + cluster on VMware + +SYNOPSIS + gcloud alpha container vmware clusters describe + (CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an Anthos cluster on VMware. + +EXAMPLES + To describe a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container vmware clusters describe my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/enroll b/gcloud/alpha/container/vmware/clusters/enroll new file mode 100644 index 000000000..f93265a1c --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/enroll @@ -0,0 +1,94 @@ +NAME + gcloud alpha container vmware clusters enroll - enroll an Anthos cluster on + VMware + +SYNOPSIS + gcloud alpha container vmware clusters enroll + (CLUSTER : --location=LOCATION) + (--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Enroll an Anthos cluster on VMware. + +POSITIONAL ARGUMENTS + Cluster resource - cluster to enroll 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +REQUIRED FLAGS + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. The + arguments in this group can be used to specify the attributes of this + resource. + + This must be specified. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier for + the admin_cluster_membership. To set the admin_cluster_membership + attribute: + ▸ provide the argument --admin-cluster-membership on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION + Google Cloud location for the admin_cluster_membership. To set the + location attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-location on the + command line. + + --admin-cluster-membership-project=ADMIN_CLUSTER_MEMBERSHIP_PROJECT + Google Cloud project for the admin_cluster_membership. To set the + project attribute: + ▸ provide the argument --admin-cluster-membership on the command + line with a fully specified name; + ▸ provide the argument --admin-cluster-membership-project on the + command line. + +OPTIONAL 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. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/help b/gcloud/alpha/container/vmware/clusters/help new file mode 100644 index 000000000..615d7cb57 --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/help @@ -0,0 +1,48 @@ +NAME + gcloud alpha container vmware clusters - create and manage Anthos clusters + on VMware + +SYNOPSIS + gcloud alpha container vmware clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Anthos clusters on VMware. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an Anthos cluster on VMware. + + delete + (ALPHA) Delete an Anthos cluster on VMware. + + describe + (ALPHA) Describe an Anthos cluster on VMware. + + enroll + (ALPHA) Enroll an Anthos cluster on VMware. + + list + (ALPHA) List Anthos clusters on VMware. + + query-version-config + (ALPHA) Query Anthos on VMware version configuration. + + update + (ALPHA) Update an Anthos cluster on VMware. + + upgrade + (ALPHA) Centrally upgrade an Anthos cluster on VMware. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/list b/gcloud/alpha/container/vmware/clusters/list new file mode 100644 index 000000000..ad93a587f --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/list @@ -0,0 +1,81 @@ +NAME + gcloud alpha container vmware clusters list - list Anthos clusters on + VMware + +SYNOPSIS + gcloud alpha container vmware clusters list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Anthos clusters on VMware. + +EXAMPLES + To lists all clusters managed in location us-west1, run: + + $ gcloud alpha container vmware clusters list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list Anthos on VMware + clusters. 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 --location on the command line with a fully + specified name; + ◆ set the property container_vmware/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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 + 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. + diff --git a/gcloud/alpha/container/vmware/clusters/query-version-config b/gcloud/alpha/container/vmware/clusters/query-version-config new file mode 100644 index 000000000..f8992680f --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/query-version-config @@ -0,0 +1,112 @@ +NAME + gcloud alpha container vmware clusters query-version-config - query Anthos + on VMware version configuration + +SYNOPSIS + gcloud alpha container vmware clusters query-version-config + (--cluster=CLUSTER + : [--admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + : --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global"]) + [--location=LOCATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Query Anthos on VMware version configuration. + +EXAMPLES + To query versions for creating a cluster with an admin cluster membership + named my-admin-cluster-membership, run: + + $ gcloud alpha container vmware clusters query-version-config \ + --admin-cluster-membership=my-admin-cluster-membership + + To query versions for upgrading a user cluster named my-user-cluster, run: + + $ gcloud alpha container vmware clusters query-version-config \ + --cluster=my-user-cluster + +REQUIRED FLAGS + Version configuration type + + Exactly one of these must be specified: + + Upgrade configuration + + Cluster resource - cluster to query version configuration 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 --cluster on the command line with a fully + specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. To set the location attribute: + ▫ provide the argument --cluster on the command line with a fully + specified name; + ▫ set the property container_vmware/location. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line. + + Create configuration + + Admin cluster membership resource - membership of the admin cluster. + Membership can be the membership ID or the full resource name. 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 --admin-cluster-membership on the command + line with a fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --admin-cluster-membership=ADMIN_CLUSTER_MEMBERSHIP + ID of the admin_cluster_membership or fully qualified identifier + for the admin_cluster_membership. To set the + admin_cluster_membership attribute: + ◇ provide the argument --admin-cluster-membership on the + command line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --admin-cluster-membership-location=ADMIN_CLUSTER_MEMBERSHIP_LOCATION; default="global" + Google Cloud location for the admin_cluster_membership. To set + the location attribute: + ◇ provide the argument --admin-cluster-membership on the + command line with a fully specified name; + ◇ provide the argument --admin-cluster-membership-location on + the command line. + +OPTIONAL FLAGS + Location resource - Google Cloud location to query version configuration. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_vmware/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/update b/gcloud/alpha/container/vmware/clusters/update new file mode 100644 index 000000000..1637ded01 --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/update @@ -0,0 +1,225 @@ +NAME + gcloud alpha container vmware clusters update - update an Anthos cluster on + VMware + +SYNOPSIS + gcloud alpha container vmware clusters update + (CLUSTER : --location=LOCATION) [--admin-users=ADMIN_USERS] [--async] + [--description=DESCRIPTION] + [--metal-lb-config-from-file=METAL_LB_CONFIG_FROM_FILE] + [--static-ip-config-from-file=STATIC_IP_CONFIG_FROM_FILE] + [--version=VERSION] + [--cpus=CPUS --memory=MEMORY --disable-auto-resize + | --enable-auto-resize] [--disable-aag-config | --enable-aag-config] + [--disable-auto-repair | --enable-auto-repair] + [--disable-vsphere-csi | --enable-vsphere-csi] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an Anthos cluster on VMware. + +EXAMPLES + To update a cluster named my-cluster managed in location us-west1, run: + + $ gcloud alpha container vmware clusters update my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to update 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +FLAGS + User cluster authorization configurations to bootstrap onto the admin + cluster + + --admin-users=ADMIN_USERS + Users that will be granted the cluster-admin role on the cluster, + providing full access to the cluster. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Description for the resource. + + Anthos on VMware cluster load balancer configurations + + Populate one of the load balancers. + + MetalLB Configuration + + --metal-lb-config-from-file=METAL_LB_CONFIG_FROM_FILE + Path of the YAML/JSON file that contains the MetalLB + configurations. + + Examples: + + metalLBConfig: + addressPools: + - pool: lb-test-ip + addresses: + - 10.251.133.79/32 + - 10.251.133.80/32 + avoidBuggyIPs: True + manualAssign: False + - pool: ingress-ip + addresses: + - 10.251.133.70/32 + avoidBuggyIPs: False + manualAssign: True + + List of supported fields in metalLBConfig + + KEY VALUE NOTE + addressPools one or more addressPools required, mutable + + List of supported fields in addressPools + + KEY VALUE NOTE + pool string required, mutable + addresses one or more IP ranges required, mutable + avoidBuggyIPs bool optional, mutable, + defaults to False + manualAssign bool optional, mutable, + defaults to False + + VMware User Cluster network configurations + + IP configuration used by the VMware User Cluster + + Static IP configuration group + + --static-ip-config-from-file=STATIC_IP_CONFIG_FROM_FILE + Path of the YAML/JSON file that contains the static IP + configurations, used by Anthos on VMware user cluster node pools. + + Examples: + + staticIPConfig: + ipBlocks: + - gateway: 10.251.31.254 + netmask: 255.255.252.0 + ips: + - hostname: hostname-1 + ip: 1.1.1.1 + - hostname: hostname-2 + ip: 2.2.2.2 + - hostname: hostname-3 + ip: 3.3.3.3 + - hostname: hostname-4 + ip: 4.4.4.4 + + List of supported fields in staticIPConfig + + KEY VALUE NOTE + ipBlocks one or more ipBlocks required, mutable + + List of supported fields in ipBlocks + + KEY VALUE NOTE + gateway IP address required, immutable + netmask IP address required, immutable + ips one or more ips required, mutable + + List of supported fields in ips + + KEY VALUE NOTE + hostname string optional, immutable + ip IP address required, immutable + + New ips fields can be added, existing ips fields cannot be + removed or updated. + + --version=VERSION + Anthos Cluster on VMware version for the user cluster resource + + Control plane node configurations + + --cpus=CPUS + Number of CPUs for each admin cluster node that serve as control + planes for this VMware user cluster. (default: 4 CPUs) + + --memory=MEMORY + Megabytes of memory for each admin cluster node that serves as a + control plane for this VMware User Cluster (default: 8192 MB memory). + + Auto resize configurations + + At most one of these can be specified: + + --disable-auto-resize + Disable controle plane node auto resize. + + --enable-auto-resize + Enable controle plane node auto resize. + + Anti-affinity group configurations + + At most one of these can be specified: + + --disable-aag-config + If set, spread nodes across at least three physical hosts (requires + at least three hosts). Enabled by default. + + --enable-aag-config + If set, enable anti-affinity group config. + + Auto-repair configurations + + At most one of these can be specified: + + --disable-auto-repair + If set, disables auto repair. + + --enable-auto-repair + If set, deploy the cluster-health-controller. + + Storage configurations + + At most one of these can be specified: + + --disable-vsphere-csi + If set, vSphere CSI components are not deployed in the VMware User + Cluster. Enabled by default. + + --enable-vsphere-csi + If set, vSphere CSI components are deployed in the VMware User + Cluster. + +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. + diff --git a/gcloud/alpha/container/vmware/clusters/upgrade b/gcloud/alpha/container/vmware/clusters/upgrade new file mode 100644 index 000000000..8248ca196 --- /dev/null +++ b/gcloud/alpha/container/vmware/clusters/upgrade @@ -0,0 +1,64 @@ +NAME + gcloud alpha container vmware clusters upgrade - centrally upgrade an + Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware clusters upgrade + (CLUSTER : --location=LOCATION) --version=VERSION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Centrally upgrade an Anthos cluster on VMware. + +EXAMPLES + To upgrade a cluster named my-cluster managed in location us-west1 to + version 1.13.0-gke.1000, run: + + $ gcloud alpha container vmware clusters upgrade my-cluster \ + --location=us-west1 --version=1.13.0-gke.1000 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to upgrade 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +REQUIRED FLAGS + --version=VERSION + Anthos Cluster on VMware version for the user cluster 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. + diff --git a/gcloud/alpha/container/vmware/help b/gcloud/alpha/container/vmware/help new file mode 100644 index 000000000..db1958dba --- /dev/null +++ b/gcloud/alpha/container/vmware/help @@ -0,0 +1,36 @@ +NAME + gcloud alpha container vmware - deploy and manage Anthos clusters on VMware + for running containers + +SYNOPSIS + gcloud alpha container vmware GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Deploy and manage Anthos clusters on VMware for running containers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + admin-clusters + (ALPHA) Create and manage admin clusters in Anthos on VMware. + + clusters + (ALPHA) Create and manage Anthos clusters on VMware. + + node-pools + (ALPHA) Create and manage node pools in an Anthos cluster on VMware. + + operations + (ALPHA) Manage Anthos on VMware long running operations. + +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. + diff --git a/gcloud/alpha/container/vmware/node-pools/create b/gcloud/alpha/container/vmware/node-pools/create new file mode 100644 index 000000000..75159a824 --- /dev/null +++ b/gcloud/alpha/container/vmware/node-pools/create @@ -0,0 +1,140 @@ +NAME + gcloud alpha container vmware node-pools create - create a node pool in an + Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware node-pools create + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) + (--image-type=IMAGE_TYPE : --boot-disk-size=BOOT_DISK_SIZE --cpus=CPUS + --enable-load-balancer --image=IMAGE --memory=MEMORY + --node-labels=[KEY=VALUE,...] + --node-taints=[KEY=VALUE:EFFECT,...] --replicas=REPLICAS) + [--annotations=[KEY=VALUE,...]] [--async] [--display-name=DISPLAY_NAME] + [--max-replicas=MAX_REPLICAS --min-replicas=MIN_REPLICAS] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a node pool in an Anthos cluster on VMware. + +EXAMPLES + To create a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container vmware node-pools create my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool to create 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +REQUIRED FLAGS + Configuration of the node pool + + This must be specified. + + --image-type=IMAGE_TYPE + OS image type to use on node pool instances. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --boot-disk-size=BOOT_DISK_SIZE + Size of VMware disk to be used during creation in GB. + + --cpus=CPUS + Number of CPUs for each node in the node pool. + + --enable-load-balancer + If set, enable the use of load balancer on the node pool instances. + + --image=IMAGE + OS image name in vCenter. + + --memory=MEMORY + Size of memory for each node in the node pool in MB. + + --node-labels=[KEY=VALUE,...] + Kubernetes labels (key/value pairs) to be applied to each node. + + --node-taints=[KEY=VALUE:EFFECT,...] + Applies the given kubernetes taints on all nodes in the new node + pool, which can be used with tolerations for pod scheduling. + + Examples: + + $ gcloud alpha container vmware node-pools create node-pool-1 \ + --cluster=example-cluster \ + --node-taints=key1=val1:NoSchedule,key2=val2:PreferNoSchedule + + --replicas=REPLICAS + Number of replicas to use on node pool instances. + +OPTIONAL FLAGS + --annotations=[KEY=VALUE,...] + Annotations on the node pool. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + Display name for the resource. + + Node pool autoscaling + + --max-replicas=MAX_REPLICAS + Maximum number of replicas in the node pool. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --min-replicas=MIN_REPLICAS + Minimum number of replicas in the node pool. + + This flag argument must be specified if any of the other arguments in + this group are specified. + +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. + diff --git a/gcloud/alpha/container/vmware/node-pools/delete b/gcloud/alpha/container/vmware/node-pools/delete new file mode 100644 index 000000000..56dbc05f5 --- /dev/null +++ b/gcloud/alpha/container/vmware/node-pools/delete @@ -0,0 +1,76 @@ +NAME + gcloud alpha container vmware node-pools delete - delete a node pool in an + Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware node-pools delete + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a node pool in an Anthos cluster on VMware. + +EXAMPLES + To delete a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container vmware node-pools delete my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +FLAGS + --allow-missing + If set, and the Vmware Node Pool is not found, the request will succeed + but no action will be taken. + + --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. + +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. + diff --git a/gcloud/alpha/container/vmware/node-pools/describe b/gcloud/alpha/container/vmware/node-pools/describe new file mode 100644 index 000000000..e68fb6f37 --- /dev/null +++ b/gcloud/alpha/container/vmware/node-pools/describe @@ -0,0 +1,67 @@ +NAME + gcloud alpha container vmware node-pools describe - describe a node pool in + an Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware node-pools describe + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a node pool in an Anthos cluster on VMware. + +EXAMPLES + To describe a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container vmware node-pools describe my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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. + diff --git a/gcloud/alpha/container/vmware/node-pools/help b/gcloud/alpha/container/vmware/node-pools/help new file mode 100644 index 000000000..4aaf38572 --- /dev/null +++ b/gcloud/alpha/container/vmware/node-pools/help @@ -0,0 +1,39 @@ +NAME + gcloud alpha container vmware node-pools - create and manage node pools in + an Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware node-pools COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage node pools in an Anthos cluster on VMware. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a node pool in an Anthos cluster on VMware. + + delete + (ALPHA) Delete a node pool in an Anthos cluster on VMware. + + describe + (ALPHA) Describe a node pool in an Anthos cluster on VMware. + + list + (ALPHA) List node pools in an Anthos cluster on VMware. + + update + (ALPHA) Update a node pool in an Anthos cluster on VMware. + +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. + diff --git a/gcloud/alpha/container/vmware/node-pools/list b/gcloud/alpha/container/vmware/node-pools/list new file mode 100644 index 000000000..6f44edff6 --- /dev/null +++ b/gcloud/alpha/container/vmware/node-pools/list @@ -0,0 +1,93 @@ +NAME + gcloud alpha container vmware node-pools list - list node pools in an + Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware node-pools list + (--cluster=CLUSTER : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List node pools in an Anthos cluster on VMware. + +EXAMPLES + To list all node pools in a cluster named my-cluster managed in location + us-west1, run: + + $ gcloud alpha container vmware node-pools list \ + --cluster=my-cluster --location=us-west1 + +REQUIRED FLAGS + Cluster resource - cluster to list 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 --cluster 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. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument --cluster on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument --cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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 + 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. + diff --git a/gcloud/alpha/container/vmware/node-pools/update b/gcloud/alpha/container/vmware/node-pools/update new file mode 100644 index 000000000..e3bcbf00a --- /dev/null +++ b/gcloud/alpha/container/vmware/node-pools/update @@ -0,0 +1,135 @@ +NAME + gcloud alpha container vmware node-pools update - update a node pool in an + Anthos cluster on VMware + +SYNOPSIS + gcloud alpha container vmware node-pools update + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async] + [--display-name=DISPLAY_NAME] [--validate-only] + [--boot-disk-size=BOOT_DISK_SIZE --cpus=CPUS --image=IMAGE + --image-type=IMAGE_TYPE --memory=MEMORY --node-labels=[KEY=VALUE,...] + --node-taints=[KEY=VALUE:EFFECT,...] + --replicas=REPLICAS --disable-load-balancer | --enable-load-balancer] + [--max-replicas=MAX_REPLICAS --min-replicas=MIN_REPLICAS] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a node pool in an Anthos cluster on VMware. + +EXAMPLES + To update a node pool named my-node-pool in a cluster named my-cluster + managed in location us-west1, run: + + $ gcloud alpha container vmware node-pools update my-node-pool \ + --cluster=my-cluster --location=us-west1 + +POSITIONAL ARGUMENTS + Node pool resource - node pool to update 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 node_pool 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. + + NODE_POOL + ID of the node_pool or fully qualified identifier for the node_pool. + To set the node_pool attribute: + ▸ provide the argument node_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + cluster of the node_pool. To set the cluster attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --location=LOCATION + Google Cloud location for the node_pool. To set the location + attribute: + ▸ provide the argument node_pool on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + Display name for the resource. + + --validate-only + If set, only validate the request, but do not actually perform the + operation. + + Configuration of the node pool + + --boot-disk-size=BOOT_DISK_SIZE + Size of VMware disk to be used during creation in GB. + + --cpus=CPUS + Number of CPUs for each node in the node pool. + + --image=IMAGE + OS image name in vCenter. + + --image-type=IMAGE_TYPE + OS image type to use on node pool instances. + + --memory=MEMORY + Size of memory for each node in the node pool in MB. + + --node-labels=[KEY=VALUE,...] + Kubernetes labels (key/value pairs) to be applied to each node. + + --node-taints=[KEY=VALUE:EFFECT,...] + Applies the given kubernetes taints on all nodes in the new node + pool, which can be used with tolerations for pod scheduling. + + Examples: + + $ gcloud alpha container vmware node-pools update node-pool-1 \ + --cluster=example-cluster \ + --node-taints=key1=val1:NoSchedule,key2=val2:PreferNoSchedule + + --replicas=REPLICAS + Number of replicas to use on node pool instances. + + At most one of these can be specified: + + --disable-load-balancer + If set, disable the use of load balancer on the node pool + instances. + + --enable-load-balancer + If set, enable the use of load balancer on the node pool instances. + + Node pool autoscaling + + --max-replicas=MAX_REPLICAS + Maximum number of replicas in the node pool. + + --min-replicas=MIN_REPLICAS + Minimum number of replicas in the node pool. + +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. + diff --git a/gcloud/alpha/container/vmware/operations/describe b/gcloud/alpha/container/vmware/operations/describe new file mode 100644 index 000000000..cbd30c6f9 --- /dev/null +++ b/gcloud/alpha/container/vmware/operations/describe @@ -0,0 +1,58 @@ +NAME + gcloud alpha container vmware operations describe - describe an operation + +SYNOPSIS + gcloud alpha container vmware operations describe + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe an operation. + +EXAMPLES + To describe an operation in location us-west1, run: + + $ gcloud alpha container vmware operations describe OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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. + diff --git a/gcloud/alpha/container/vmware/operations/help b/gcloud/alpha/container/vmware/operations/help new file mode 100644 index 000000000..ab2a56aa1 --- /dev/null +++ b/gcloud/alpha/container/vmware/operations/help @@ -0,0 +1,33 @@ +NAME + gcloud alpha container vmware operations - manage Anthos on VMware long + running operations + +SYNOPSIS + gcloud alpha container vmware operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Anthos on VMware long running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe an operation. + + list + (ALPHA) List operations. + + wait + (ALPHA) Poll an operation for completion. + +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. + diff --git a/gcloud/alpha/container/vmware/operations/list b/gcloud/alpha/container/vmware/operations/list new file mode 100644 index 000000000..83808fb17 --- /dev/null +++ b/gcloud/alpha/container/vmware/operations/list @@ -0,0 +1,80 @@ +NAME + gcloud alpha container vmware operations list - list operations + +SYNOPSIS + gcloud alpha container vmware operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List operations. + +EXAMPLES + To list all operations in location us-west1, run: + + $ gcloud alpha container vmware operations list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list operations. 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 --location on the command line with a fully + specified name; + ◆ set the property container_vmware/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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 + 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. + diff --git a/gcloud/alpha/container/vmware/operations/wait b/gcloud/alpha/container/vmware/operations/wait new file mode 100644 index 000000000..b99a3dec4 --- /dev/null +++ b/gcloud/alpha/container/vmware/operations/wait @@ -0,0 +1,59 @@ +NAME + gcloud alpha container vmware operations wait - poll an operation for + completion + +SYNOPSIS + gcloud alpha container vmware operations wait + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Poll an operation for completion. + +EXAMPLES + To wait for an operation in location us-west1 to complete, run: + + $ gcloud alpha container vmware operations wait OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to wait for completion. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_vmware/location. + +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. + diff --git a/gcloud/alpha/dataflow/jobs/config/export b/gcloud/alpha/dataflow/jobs/config/export index c42334b1d..851d5000b 100644 --- a/gcloud/alpha/dataflow/jobs/config/export +++ b/gcloud/alpha/dataflow/jobs/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/dataplex/datascan/create b/gcloud/alpha/dataplex/datascan/create new file mode 100644 index 000000000..d154253b1 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/create @@ -0,0 +1,142 @@ +NAME + gcloud alpha dataplex datascan create - create a Dataplex Datascan + +SYNOPSIS + gcloud alpha dataplex datascan create (DATASCAN : --location=LOCATION) + --data-source-entity=DATA_SOURCE_ENTITY --scan-type=SCAN_TYPE + [--data-quality-spec-file=DATA_QUALITY_SPEC_FILE] + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--labels=[KEY=VALUE,...]] [--async | --validate-only] + [--field=FIELD + --disabled=DISABLED --on-demand=ON_DEMAND --schedule=SCHEDULE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Dataplex Datascan. + +EXAMPLES + Create a Dataplex datascan job. + + Represents a user-visible job which provides the insights for the related + data source. For example: + ▪ Data Quality: generates queries based on the rules and run against + the data to get data quality check results. + ▪ Data Profile: analyzes the data in table(s) and generates insights + about the structure, content and relationships (such as null percent, + cardinality, min/max/mean, etc). + +POSITIONAL ARGUMENTS + Datascan resource - Arguments and flags that define the Dataplex datascan + you want to create a Datascan for. 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 datascan 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. + + DATASCAN + ID of the datascan or fully qualified identifier for the datascan. To + set the dataScans attribute: + ▸ provide the argument datascan on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument datascan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + Data source for the Datascan. + + This must be specified. + + --data-source-entity=DATA_SOURCE_ENTITY + Dataplex entity that contains the data for the Datascan, of the form: + projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. + + --scan-type=SCAN_TYPE + Specify the type of scan. SCAN_TYPE must be one of: PROFILE, QUALITY. + +OPTIONAL FLAGS + Additional configuration arguments for the scan. + + DataQualityScan related setting. + + --data-quality-spec-file=DATA_QUALITY_SPEC_FILE + path to the JSON file containing the Data Quality Spec for the Data + Quality Scan + + --description=DESCRIPTION + Description of the Datascan + + --display-name=DISPLAY_NAME + Display name of the Datascan + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + At most one of --async | --validate-only can be specified. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --validate-only + Validate the create action, but don't actually perform it. + + Datascan execution settings. If not specified, the fields under it will + use their default values. + + --field=FIELD + Field that contains values that monotonically increase over time + (e.g. timestamp). + + Datascan scheduling and trigger settings + + --disabled=DISABLED + Prevent the scan from executing (including both scheduled scans and + scans triggered via RunDataScan API). This does not cancel + currently running scan jobs. If not specified, the default is + false. + + --on-demand=ON_DEMAND + If set, the scan runs one-time shortly after Datascan Creation. + + --schedule=SCHEDULE + Cron schedule (https://en.wikipedia.org/wiki/Cron) for running + scans periodically. To explicitly set a timezone to the cron tab, + apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or + "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid + string from IANA time zone database. For example, + CRON_TZ=America/New_York 1 * * * * or TZ=America/New_York 1 * * * + *. This field is required for RECURRING scans. + +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. + diff --git a/gcloud/alpha/dataplex/datascan/delete b/gcloud/alpha/dataplex/datascan/delete new file mode 100644 index 000000000..4a4b9f1b3 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/delete @@ -0,0 +1,69 @@ +NAME + gcloud alpha dataplex datascan delete - delete a Dataplex Datascan resource + +SYNOPSIS + gcloud alpha dataplex datascan delete (DATASCAN : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Dataplex Datascan resource. + +EXAMPLES + To delete a Dataplex Datascan test-datascan in location us-central1, run: + + $ gcloud alpha dataplex datascan delete test-datascan \ + --location=us-central1 + +POSITIONAL ARGUMENTS + Datascan resource - Arguments and flags that define the Dataplex Datascan + you want 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 datascan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATASCAN + ID of the datascan or fully qualified identifier for the datascan. To + set the datascan attribute: + ▸ provide the argument datascan on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument datascan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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. + diff --git a/gcloud/alpha/dataplex/datascan/describe b/gcloud/alpha/dataplex/datascan/describe new file mode 100644 index 000000000..80bc0c226 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/describe @@ -0,0 +1,66 @@ +NAME + gcloud alpha dataplex datascan describe - describe a Dataplex lake resource + +SYNOPSIS + gcloud alpha dataplex datascan describe (DATASCAN : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Displays all details of a Dataplex Datascan resource given a valid + Datascan ID. + +EXAMPLES + To describe a Dataplex Datascan test-datascan in project test-project + location us-central1 , run: + + $ gcloud alpha dataplex datascan describe test-datascan \ + --project=test-project --location=us-central1 + +POSITIONAL ARGUMENTS + Datascan resource - Arguments and flags that define the Dataplex Datascan + you want to retrieve. 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 datascan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + DATASCAN + ID of the datascan or fully qualified identifier for the datascan. To + set the datascan attribute: + ▸ provide the argument datascan on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument datascan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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. + diff --git a/gcloud/alpha/dataplex/datascan/help b/gcloud/alpha/dataplex/datascan/help new file mode 100644 index 000000000..891241b8f --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/help @@ -0,0 +1,41 @@ +NAME + gcloud alpha dataplex datascan - manage Dataplex Datascan + +SYNOPSIS + gcloud alpha dataplex datascan GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Datascan. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + jobs + (ALPHA) Manage Dataplex Datascan Jobs services. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a Dataplex Datascan. + + delete + (ALPHA) Delete a Dataplex Datascan resource. + + describe + (ALPHA) Describe a Dataplex lake resource. + + list + (ALPHA) List Dataplex Datascan resources under a project. + +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. + diff --git a/gcloud/alpha/dataplex/datascan/jobs/describe b/gcloud/alpha/dataplex/datascan/jobs/describe new file mode 100644 index 000000000..b6c20f863 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/jobs/describe @@ -0,0 +1,76 @@ +NAME + gcloud alpha dataplex datascan jobs describe - describe a Dataplex job + running a particular datascan + +SYNOPSIS + gcloud alpha dataplex datascan jobs describe + (JOB : --datascan=DATASCAN --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Dataplex job running a particular datascan. + + Displays all details of a Dataplex job given a valid job ID. + +EXAMPLES + To describe a Dataplex job test-job running a datascan test-task in + location us-central1, run: + + $ gcloud alpha dataplex datascan jobs describe test-job \ + --location=us-central1 --datascan=test-datascan + +POSITIONAL ARGUMENTS + Job resource - Arguments and flags that define the Dataplex Job running a + particular Datascan you want to retrieve. 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 on the command line with a fully specified + name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + 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. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --datascan=DATASCAN + Datascan ID of the Dataplex datascan resource. + + To set the datascan attribute: + ▸ provide the argument job on the command line with a fully + specified name; + ▸ provide the argument --datascan on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument job on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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. + diff --git a/gcloud/alpha/dataplex/datascan/jobs/help b/gcloud/alpha/dataplex/datascan/jobs/help new file mode 100644 index 000000000..36e871057 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/jobs/help @@ -0,0 +1,30 @@ +NAME + gcloud alpha dataplex datascan jobs - manage Dataplex Datascan Jobs + services + +SYNOPSIS + gcloud alpha dataplex datascan jobs COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Datascan Jobs services. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a Dataplex job running a particular datascan. + + list + (ALPHA) List job runs of a Dataplex datascan resource. + +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. + diff --git a/gcloud/alpha/dataplex/datascan/jobs/list b/gcloud/alpha/dataplex/datascan/jobs/list new file mode 100644 index 000000000..b86b6cad3 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/jobs/list @@ -0,0 +1,100 @@ +NAME + gcloud alpha dataplex datascan jobs list - list job runs of a Dataplex + datascan resource + +SYNOPSIS + gcloud alpha dataplex datascan jobs list + (--datascan=DATASCAN : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Jobs runs of a Datascan under a specific project, location and + task. + +EXAMPLES + To list all the Dataplex job runs for a datascan test-datascan in location + us-central1, run: + + gcloud alpha dataplex datascan jobs list --location=us-central1 --datascan=test-datascan + +REQUIRED FLAGS + Datascan resource - Arguments and flags that define the Dataplex Datascan + to list the Jobs running the Datascan. 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 --datascan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --datascan=DATASCAN + ID of the datascan or fully qualified identifier for the datascan. To + set the datascan attribute: + ▸ provide the argument --datascan on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument --datascan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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. + diff --git a/gcloud/alpha/dataplex/datascan/list b/gcloud/alpha/dataplex/datascan/list new file mode 100644 index 000000000..38c8a8857 --- /dev/null +++ b/gcloud/alpha/dataplex/datascan/list @@ -0,0 +1,92 @@ +NAME + gcloud alpha dataplex datascan list - list Dataplex Datascan resources + under a project + +SYNOPSIS + gcloud alpha dataplex datascan list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all Dataplex Datascan resource under a specific project and + location. + +EXAMPLES + To list all Dataplex Datascan resources in project=test-project in location + us-central, run: + + $ gcloud alpha dataplex datascan list --project=test-project \ + --location=us-central1 + + To list all Dataplex Datascan in all locations, run: + + $ gcloud alpha dataplex datascan list --project=test-project \ + --location=- + +FLAGS + Location resource - Arguments and flags that define the Dataplex Datascan + you want to list. 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 --location on the command line with a fully + specified name; + ◆ set the property dataplex/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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 dataplex/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/dataplex/docs + +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. + diff --git a/gcloud/alpha/dataplex/help b/gcloud/alpha/dataplex/help index f04d22a8a..9b8d30ee1 100644 --- a/gcloud/alpha/dataplex/help +++ b/gcloud/alpha/dataplex/help @@ -21,6 +21,9 @@ GROUPS content (ALPHA) Manage Dataplex Content. + datascan + (ALPHA) Manage Dataplex Datascan. + environments (ALPHA) Manage Dataplex Environments. diff --git a/gcloud/alpha/dataproc/jobs/kill b/gcloud/alpha/dataproc/jobs/kill index c1a436350..27cebe274 100644 --- a/gcloud/alpha/dataproc/jobs/kill +++ b/gcloud/alpha/dataproc/jobs/kill @@ -2,7 +2,7 @@ NAME gcloud alpha dataproc jobs kill - kill an active job SYNOPSIS - gcloud alpha dataproc jobs kill (JOB : --region=REGION) + gcloud alpha dataproc jobs kill (JOB : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -44,6 +44,11 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property dataproc/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, diff --git a/gcloud/alpha/dataproc/jobs/submit/help b/gcloud/alpha/dataproc/jobs/submit/help index 286fd21d8..5d17093db 100644 --- a/gcloud/alpha/dataproc/jobs/submit/help +++ b/gcloud/alpha/dataproc/jobs/submit/help @@ -87,6 +87,9 @@ COMMANDS spark-sql (ALPHA) Submit a Spark SQL job to a cluster. + trino + (ALPHA) Submit a Trino job to a cluster. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/dataproc/jobs/submit/trino b/gcloud/alpha/dataproc/jobs/submit/trino new file mode 100644 index 000000000..25106e787 --- /dev/null +++ b/gcloud/alpha/dataproc/jobs/submit/trino @@ -0,0 +1,137 @@ +NAME + gcloud alpha dataproc jobs submit trino - submit a Trino job to a cluster + +SYNOPSIS + gcloud alpha dataproc jobs submit trino + (--cluster=CLUSTER | --cluster-labels=[KEY=VALUE,...]) + (--execute=QUERY, -e QUERY | --file=FILE, -f FILE) [--async] + [--bucket=BUCKET] [--client-tags=[CLIENT_TAG,...]] + [--continue-on-failure] [--driver-log-levels=[PACKAGE=LEVEL,...]] + [--labels=[KEY=VALUE,...]] + [--max-failures-per-hour=MAX_FAILURES_PER_HOUR] + [--max-failures-total=MAX_FAILURES_TOTAL] + [--properties=[PARAM=VALUE,...]] [--properties-file=PROPERTIES_FILE] + [--query-output-format=QUERY_OUTPUT_FORMAT] [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Submit a Trino job to a cluster + +EXAMPLES + To submit a Trino job with a local script, run: + + $ gcloud alpha dataproc jobs submit trino --cluster=my-cluster \ + --file=my_script.R + + To submit a Trino job with inline queries, run: + + $ gcloud alpha dataproc jobs submit trino --cluster=my-cluster \ + -e="SELECT * FROM foo WHERE bar > 2" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --cluster=CLUSTER + The Dataproc cluster to submit the job to. + + --cluster-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + Labels of Dataproc cluster on which to place the job. + + Exactly one of these must be specified: + + --execute=QUERY, -e QUERY + A Trino query to execute. + + --file=FILE, -f FILE + HCFS URI of file containing the Trino script to execute. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --bucket=BUCKET + The Cloud Storage bucket to stage files in. Defaults to the cluster's + configured bucket. + + --client-tags=[CLIENT_TAG,...] + A list of Trino client tags to attach to this query. + + --continue-on-failure + Whether to continue if a query fails. + + --driver-log-levels=[PACKAGE=LEVEL,...] + A list of package-to-log4j log level pairs to configure driver logging. + For example: root=FATAL,com.example=INFO + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --max-failures-per-hour=MAX_FAILURES_PER_HOUR + Specifies the maximum number of times a job can be restarted per hour + in event of failure. Default is 0 (no retries after job failure). + + --max-failures-total=MAX_FAILURES_TOTAL + Specifies the maximum total number of times a job can be restarted + after the job fails. Default is 0 (no retries after job failure). + + --properties=[PARAM=VALUE,...] + A list of key value pairs to set Trino session properties. + + --properties-file=PROPERTIES_FILE + Path to a local file or a file in a Cloud Storage bucket containing + configuration properties for the job. The client machine running this + command must have read permission to the file. + + Specify properties in the form of property=value in the text file. For + example: + + # Properties to set for the job: + key1=value1 + key2=value2 + # Comment out properties not used. + # key3=value3 + + If a property is set in both --properties and --properties-file, the + value defined in --properties takes precedence. + + --query-output-format=QUERY_OUTPUT_FORMAT + The query output display format. See the Trino documentation for + supported output formats. + + --region=REGION + Dataproc region to use. Each Dataproc region constitutes an independent + resource namespace constrained to deploying instances into Compute + Engine zones inside the region. Overrides the default dataproc/region + property value for this command invocation. + +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 dataproc jobs submit trino + + $ gcloud beta dataproc jobs submit trino + diff --git a/gcloud/alpha/dataproc/workflow-templates/add-job/help b/gcloud/alpha/dataproc/workflow-templates/add-job/help index 602a0b8f5..898fb4ac9 100644 --- a/gcloud/alpha/dataproc/workflow-templates/add-job/help +++ b/gcloud/alpha/dataproc/workflow-templates/add-job/help @@ -69,6 +69,9 @@ COMMANDS spark-sql (ALPHA) Add a SparkSql job to the workflow template. + trino + (ALPHA) Add a Trino job to the workflow template. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/dataproc/workflow-templates/add-job/trino b/gcloud/alpha/dataproc/workflow-templates/add-job/trino new file mode 100644 index 000000000..3a5a34aca --- /dev/null +++ b/gcloud/alpha/dataproc/workflow-templates/add-job/trino @@ -0,0 +1,133 @@ +NAME + gcloud alpha dataproc workflow-templates add-job trino - add a Trino job to + the workflow template + +SYNOPSIS + gcloud alpha dataproc workflow-templates add-job trino --step-id=STEP_ID + (--execute=QUERY, -e QUERY | --file=FILE, -f FILE) + (--workflow-template=WORKFLOW_TEMPLATE : --region=REGION) + [--client-tags=[CLIENT_TAG,...]] [--continue-on-failure] + [--driver-log-levels=[PACKAGE=LEVEL,...]] [--labels=[KEY=VALUE,...]] + [--properties=[PARAM=VALUE,...]] [--properties-file=PROPERTIES_FILE] + [--query-output-format=QUERY_OUTPUT_FORMAT] + [--start-after=STEP_ID,[STEP_ID,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add a Trino job to the workflow template. + +EXAMPLES + To add a Trino job that executes 'QUERY' to the workflow template + 'my-workflow-template' in the 'us-central1' region with 'my-step-id', + + run: + + $ gcloud alpha dataproc workflow-templates add-job trino \ + --step-id=my-step_id -e=QUERY \ + --workflow-template=my-workflow-template --region=us-central1 + +REQUIRED FLAGS + --step-id=STEP_ID + The step ID of the job in the workflow template. + + Exactly one of these must be specified: + + --execute=QUERY, -e QUERY + A Trino query to execute. + + --file=FILE, -f FILE + HCFS URI of file containing the Trino script to execute. + + Template resource - The name of the workflow template to add job to. 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 --workflow-template 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. + + --workflow-template=WORKFLOW_TEMPLATE + ID of the template or fully qualified identifier for the template. To + set the template attribute: + ▸ provide the argument --workflow-template on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --region=REGION + Dataproc region for the template. Each Dataproc region constitutes an + independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument --workflow-template on the command line with + a fully specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +OPTIONAL FLAGS + --client-tags=[CLIENT_TAG,...] + A list of Trino client tags to attach to this query. + + --continue-on-failure + Whether to continue if a query fails. + + --driver-log-levels=[PACKAGE=LEVEL,...] + A list of package-to-log4j log level pairs to configure driver logging. + For example: root=FATAL,com.example=INFO + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --properties=[PARAM=VALUE,...] + A list of key value pairs to set Trino session properties. + + --properties-file=PROPERTIES_FILE + Path to a local file or a file in a Cloud Storage bucket containing + configuration properties for the job. The client machine running this + command must have read permission to the file. + + Specify properties in the form of property=value in the text file. For + example: + + # Properties to set for the job: + key1=value1 + key2=value2 + # Comment out properties not used. + # key3=value3 + + If a property is set in both --properties and --properties-file, the + value defined in --properties takes precedence. + + --query-output-format=QUERY_OUTPUT_FORMAT + The query output display format. See the Trino documentation for + supported output formats. + + --start-after=STEP_ID,[STEP_ID,...] + (Optional) List of step IDs to start this job after. + +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 dataproc workflow-templates add-job trino + + $ gcloud beta dataproc workflow-templates add-job trino + diff --git a/gcloud/alpha/deploy/releases/create b/gcloud/alpha/deploy/releases/create index ad3f97951..486c3405e 100644 --- a/gcloud/alpha/deploy/releases/create +++ b/gcloud/alpha/deploy/releases/create @@ -10,7 +10,9 @@ SYNOPSIS [--ignore-file=IGNORE_FILE] [--labels=[KEY=VALUE,...]] [--skaffold-version=SKAFFOLD_VERSION] [--to-target=TO_TARGET] [--build-artifacts=BUILD_ARTIFACTS | --images=[NAME=TAG,...]] - [--disable-initial-rollout | --enable-initial-rollout] + [--disable-initial-rollout | --enable-initial-rollout + --initial-rollout-annotations=[KEY=VALUE,...] + --initial-rollout-labels=[KEY=VALUE,...]] [--from-k8s-manifest=FROM_K8S_MANIFEST | --from-run-manifest=FROM_RUN_MANIFEST | --skaffold-file=SKAFFOLD_FILE --source=SOURCE; default="."] @@ -160,6 +162,28 @@ FLAGS Creates a rollout in the first target defined in the delivery pipeline. This is the default behavior. + --initial-rollout-annotations=[KEY=VALUE,...] + Annotations to apply to the initial rollout when creating the + release. Annotations take the form of key/value string pairs. + + Examples: + + Add annotations: + + $ gcloud alpha deploy releases create \ + --initial-rollout-annotations="from_target=test,status=stable" + + --initial-rollout-labels=[KEY=VALUE,...] + Labels to apply to the initial rollout when creating the release. + Labels take the form of key/value string pairs. + + Examples: + + Add labels: + + $ gcloud alpha deploy releases create \ + initial-rollout-labels="commit=abc123,author=foo" + At most one of these can be specified: --from-k8s-manifest=FROM_K8S_MANIFEST diff --git a/gcloud/alpha/dns/managed-zones/config/export b/gcloud/alpha/dns/managed-zones/config/export index 70f16723c..4b978d60a 100644 --- a/gcloud/alpha/dns/managed-zones/config/export +++ b/gcloud/alpha/dns/managed-zones/config/export @@ -64,7 +64,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/dns/policies/config/export b/gcloud/alpha/dns/policies/config/export index 6915c1e4f..56fa46457 100644 --- a/gcloud/alpha/dns/policies/config/export +++ b/gcloud/alpha/dns/policies/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/dns/record-sets/create b/gcloud/alpha/dns/record-sets/create index eae980bc9..b122ea4dd 100644 --- a/gcloud/alpha/dns/record-sets/create +++ b/gcloud/alpha/dns/record-sets/create @@ -120,7 +120,7 @@ REQUIRED FLAGS For --routing-policy-type = "WRR" this flag indicates the weighted round robin policy data. The field accepts a semicolon-delimited list of the format - "${weight_percent}:${rrdata},${rrdata}". Specify weight as a + "${weight_percent}=${rrdata},${rrdata}". Specify weight as a non-negative number (0 is allowed). Ratio of traffic routed to the target is calculated from the ratio of individual weight over the total across all weights. @@ -128,7 +128,7 @@ REQUIRED FLAGS For --routing-policy-type = "GEO" this flag indicates the geo-locations policy data. The field accepts a semicolon-delimited list of the format - "${region}:${rrdata},${rrdata}". Each individual rrdata can + "${region}=${rrdata},${rrdata}". Each individual rrdata can either be an ip address or a string of the format forwarding_config_name@region. diff --git a/gcloud/alpha/dns/record-sets/update b/gcloud/alpha/dns/record-sets/update index b274239b2..0d0239376 100644 --- a/gcloud/alpha/dns/record-sets/update +++ b/gcloud/alpha/dns/record-sets/update @@ -87,7 +87,7 @@ REQUIRED FLAGS For --routing-policy-type = "WRR" this flag indicates the weighted round robin policy data. The field accepts a semicolon-delimited list of the format - "${weight_percent}:${rrdata},${rrdata}". Specify weight as a + "${weight_percent}=${rrdata},${rrdata}". Specify weight as a non-negative number (0 is allowed). Ratio of traffic routed to the target is calculated from the ratio of individual weight over the total across all weights. @@ -95,7 +95,7 @@ REQUIRED FLAGS For --routing-policy-type = "GEO" this flag indicates the geo-locations policy data. The field accepts a semicolon-delimited list of the format - "${region}:${rrdata},${rrdata}". Each individual rrdata can + "${region}=${rrdata},${rrdata}". Each individual rrdata can either be an ip address or a string of the format forwarding_config_name@region. diff --git a/gcloud/alpha/edge-cache/help b/gcloud/alpha/edge-cache/help new file mode 100644 index 000000000..14f0accb4 --- /dev/null +++ b/gcloud/alpha/edge-cache/help @@ -0,0 +1,59 @@ +NAME + gcloud alpha edge-cache - manage Media CDN resources + +SYNOPSIS + gcloud alpha edge-cache GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Media CDN resources. + +EXAMPLES + To list EdgeCacheService resources in the active Cloud Platform project, + run: + + $ gcloud alpha edge-cache services list + + To create an EdgeCacheOrigin resource named 'my-origin' that points to a + Cloud Storage bucket, run: + + $ gcloud alpha edge-cache origins create my-origin \ + --origin-address="gs://bucket" + + To import an EdgeCacheService resource configuration from a YAML + definition, run: + + $ gcloud alpha edge-cache services import my-service \ + --source=config.yaml + + To describe an EdgeCacheKeyset resource named 'my-keyset', run: + + $ gcloud alpha edge-cache keysets describe my-keyset + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + keysets + (ALPHA) Interact with and manage EdgeCacheKeyset resources. + + operations + (ALPHA) Manage EdgeCache operations. + + origins + (ALPHA) Interact with and manage EdgeCacheOrigin resources. + + services + (ALPHA) Interact with and manage EdgeCacheService resources. + +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 edge-cache + diff --git a/gcloud/alpha/edge-cache/keysets/create b/gcloud/alpha/edge-cache/keysets/create new file mode 100644 index 000000000..08e721983 --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/create @@ -0,0 +1,125 @@ +NAME + gcloud alpha edge-cache keysets create - create an EdgeCacheKeyset resource + +SYNOPSIS + gcloud alpha edge-cache keysets create (KEYSET : --location=LOCATION) + [--async] [--description=DESCRIPTION] [--labels=KEY=VALUE] + [--public-key=PUBLIC_KEY] + [--validation-shared-key=VALIDATION_SHARED_KEY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new EdgeCacheKeyset resource. + +EXAMPLES + To create an EdgeCacheKeyset resource called 'my-keyset', run: + + $ gcloud alpha edge-cache keysets create my-keyset \ + --public-key='id=KEYID,value=BASE64PUBLICKEY' + +POSITIONAL ARGUMENTS + Keyset resource - The name of the EdgeCacheKeyset resource to create. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --public-key=PUBLIC_KEY + Set of public keys to use for validating signed requests, when + associated with a route. This flag can be repeated to create a Keyset + with multiple public keys. + + If you are providing your own public keys, specify the key in the form + id=ID,value=BASE64ENCODEDPUBLICKEY. + + If you are using Google-managed public keys as part of a dual-token + setup, specify the key in the form id=ID,managed=true. + + id + id (name) name of the key within the keyset. + + value + URL-safe base64 encoded public key. Cannot be specified if + managed=true. + + managed + Boolean indicating this is a Google-managed key. Cannot be + specified if value=true. + + To create a public key with id 'foo', pass + --public-key='id=foo,value=VALUE' to gcloud alpha edge-cache keysets + create. + + To create a Google-managed public key with id 'bar', pass + --public-key='id=foo,managed=true' to gcloud alpha edge-cache keysets + create. + + At least one of public-key or validation-shared-key must be specified. + + --validation-shared-key=VALIDATION_SHARED_KEY + An ordered list of shared keys to use for validating signed requests. + + To create a validation shared key pointing to a Secret Manager secret + version with name projects/PROJECT/secrets/SECRET/versions/VERSION, + pass + --validation-shared-key='secret_version=projects/PROJECT/secrets/SECRET/versions/VERSION' + to gcloud alpha edge-cache keysets create. + + secret_version + The name of the secret in Secret Manager. Must be in the format + projects/PROJECT/secrets/SECRET/versions/VERSION. + + At least one of public-key or validation-shared-key must be specified. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets create + diff --git a/gcloud/alpha/edge-cache/keysets/delete b/gcloud/alpha/edge-cache/keysets/delete new file mode 100644 index 000000000..93166ebf6 --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/delete @@ -0,0 +1,69 @@ +NAME + gcloud alpha edge-cache keysets delete - delete an EdgeCacheKeyset resource + +SYNOPSIS + gcloud alpha edge-cache keysets delete (KEYSET : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an EdgeCacheKeyset resource. + +EXAMPLES + To delete an EdgeCacheKeyset resource called 'my-keyset', run: + + $ gcloud alpha edge-cache keysets delete my-keyset + +POSITIONAL ARGUMENTS + Keyset resource - The name of the EdgeCacheKeyset resource 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets delete + diff --git a/gcloud/alpha/edge-cache/keysets/describe b/gcloud/alpha/edge-cache/keysets/describe new file mode 100644 index 000000000..917c951f9 --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/describe @@ -0,0 +1,65 @@ +NAME + gcloud alpha edge-cache keysets describe - show details about an + EdgeCacheKeyset resource + +SYNOPSIS + gcloud alpha edge-cache keysets describe (KEYSET : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details about an EdgeCacheKeyset resource. + +EXAMPLES + To show details for an EdgeCacheKeyset resource named 'my-keyset', run: + + $ gcloud alpha edge-cache keysets describe my-keyset + +POSITIONAL ARGUMENTS + Keyset resource - The EdgeCacheKeyset resource 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets describe + diff --git a/gcloud/alpha/edge-cache/keysets/export b/gcloud/alpha/edge-cache/keysets/export new file mode 100644 index 000000000..8a6d51699 --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/export @@ -0,0 +1,73 @@ +NAME + gcloud alpha edge-cache keysets export - export an EdgeCacheKeyset resource + +SYNOPSIS + gcloud alpha edge-cache keysets export (KEYSET : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export an EdgeCacheKeyset resource to YAML. + +EXAMPLES + To export an EdgeCacheKeyset resourced named 'my-keyset', run: + + $ gcloud alpha edge-cache keysets export my-keyset \ + --destination=keyset.yaml + +POSITIONAL ARGUMENTS + Keyset resource - The EdgeCacheKeyset resource you want to export. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets export + diff --git a/gcloud/alpha/edge-cache/keysets/help b/gcloud/alpha/edge-cache/keysets/help new file mode 100644 index 000000000..2f232e51c --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/help @@ -0,0 +1,47 @@ +NAME + gcloud alpha edge-cache keysets - interact with and manage EdgeCacheKeyset + resources + +SYNOPSIS + gcloud alpha edge-cache keysets COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Interact with and manage EdgeCacheKeyset resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an EdgeCacheKeyset resource. + + delete + (ALPHA) Delete an EdgeCacheKeyset resource. + + describe + (ALPHA) Show details about an EdgeCacheKeyset resource. + + export + (ALPHA) Export an EdgeCacheKeyset resource. + + import + (ALPHA) Import an EdgeCacheKeyset resource. + + list + (ALPHA) List EdgeCacheKeyset resources. + + update + (ALPHA) Update an EdgeCacheKeyset resource. + +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 edge-cache keysets + diff --git a/gcloud/alpha/edge-cache/keysets/import b/gcloud/alpha/edge-cache/keysets/import new file mode 100644 index 000000000..fa6e26227 --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/import @@ -0,0 +1,90 @@ +NAME + gcloud alpha edge-cache keysets import - import an EdgeCacheKeyset resource + +SYNOPSIS + gcloud alpha edge-cache keysets import (KEYSET : --location=LOCATION) + [--async] [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import an EdgeCacheKeyset resource. If the named EdgeCacheKeyset + resource already exists, the resource will be updated to match the imported + resource configuration. + + Note: If you are updating an existing EdgeCacheKeyset resource, you should + ensure that it includes any public keys still needed to validate incoming + user requests. + + If the named EdgeCacheKeyset resource does not already exist, a new + EdgeCacheKeyset resource will be created with that name. + +EXAMPLES + To import an EdgeCacheKeyset resource named 'my-keyset' from a YAML file, + run: + + $ gcloud alpha edge-cache keysets import my-keyset \ + --source=my-keyset.yaml + +POSITIONAL ARGUMENTS + Keyset resource - The EdgeCacheKeyset resource you want to import. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets import + diff --git a/gcloud/alpha/edge-cache/keysets/list b/gcloud/alpha/edge-cache/keysets/list new file mode 100644 index 000000000..a27030457 --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/list @@ -0,0 +1,68 @@ +NAME + gcloud alpha edge-cache keysets list - list EdgeCacheKeyset resources + +SYNOPSIS + gcloud alpha edge-cache keysets list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List EdgeCacheKeyset resources. + +EXAMPLES + To list existing EdgeCacheKeyset resources, run: + + $ gcloud alpha edge-cache keysets list + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets list + diff --git a/gcloud/alpha/edge-cache/keysets/update b/gcloud/alpha/edge-cache/keysets/update new file mode 100644 index 000000000..f27b0c76b --- /dev/null +++ b/gcloud/alpha/edge-cache/keysets/update @@ -0,0 +1,138 @@ +NAME + gcloud alpha edge-cache keysets update - update an EdgeCacheKeyset resource + +SYNOPSIS + gcloud alpha edge-cache keysets update (KEYSET : --location=LOCATION) + [--async] [--description=DESCRIPTION] [--labels=KEY=VALUE] + [--public-key=PUBLIC_KEY] + [--validation-shared-key=VALIDATION_SHARED_KEY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an existing EdgeCacheKeyset resource. + +EXAMPLES + To update an EdgeCacheKeyset resource called 'my-keyset', run: + + $ gcloud alpha edge-cache keysets update my-keyset \ + --public-key='id=KEYID,value=BASE64PUBLICKEY' + + The update command appends keys to an existing EdgeCacheKeyset resource. To + add more than one key to an EdgeCacheKeyset resource, provide multiple + --public-key values: + + $ gcloud alpha edge-cache keysets update my-keyset \ + --public-key='id=KEYID,value=BASE64PUBLICKEY' \ + --public-key='id=EXISTING,value=EXISTINGPUBLICKEY' + + You can specify, and an EdgeCacheKeyset resource can contain, up to three + (3) public keys. To delete unused public keys within an existing Keyset, + use the import command to specify the EdgeCacheKeyset resource in full, + omitting any unused publicKey items. + +POSITIONAL ARGUMENTS + Keyset resource - The name of the EdgeCacheKeyset resource to update. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --public-key=PUBLIC_KEY + Set of public keys to use for validating signed requests, when + associated with a route. This flag can be repeated to create a Keyset + with multiple public keys. + + If you are providing your own public keys, specify the key in the form + id=ID,value=BASE64ENCODEDPUBLICKEY. + + If you are using Google-managed public keys as part of a dual-token + setup, specify the key in the form id=ID,managed=true. + + id + id (name) name of the key within the keyset. + + value + URL-safe base64 encoded public key. Cannot be specified if + managed=true. + + managed + Boolean indicating this is a Google-managed key. Cannot be + specified if value=true. + + To create a public key with id 'foo', pass + --public-key='id=foo,value=VALUE' to gcloud alpha edge-cache keysets + update. + + To create a Google-managed public key with id 'bar', pass + --public-key='id=foo,managed=true' to gcloud alpha edge-cache keysets + update. + + At least one of public-key or validation-shared-key must be specified. + + --validation-shared-key=VALIDATION_SHARED_KEY + An ordered list of shared keys to use for validating signed requests. + + To create a validation shared key pointing to a Secret Manager secret + version with name projects/PROJECT/secrets/SECRET/versions/VERSION, + pass + --validation-shared-key='secret_version=projects/PROJECT/secrets/SECRET/versions/VERSION' + to gcloud alpha edge-cache keysets update. + + secret_version + The name of the secret in Secret Manager. Must be in the format + projects/PROJECT/secrets/SECRET/versions/VERSION. + + At least one of public-key or validation-shared-key must be specified. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache keysets update + diff --git a/gcloud/alpha/edge-cache/operations/describe b/gcloud/alpha/edge-cache/operations/describe new file mode 100644 index 000000000..3b124e55a --- /dev/null +++ b/gcloud/alpha/edge-cache/operations/describe @@ -0,0 +1,58 @@ +NAME + gcloud alpha edge-cache operations describe - describe a long-running + operation + +SYNOPSIS + gcloud alpha edge-cache operations describe OPERATION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a long-running operation. You can use this to inspect + whether a create or update operation was successful or the operation + returned any errors. + +EXAMPLES + To describe an operation with name simple-operation, run: + + $ gcloud alpha edge-cache operations describe simple-operation + +POSITIONAL ARGUMENTS + Operation resource - operation 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 operation 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 + location attribute: + ◆ provide the argument operation on the command line with a fully + specified name; + ◆ use global location. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation 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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache operations describe + diff --git a/gcloud/alpha/edge-cache/operations/help b/gcloud/alpha/edge-cache/operations/help new file mode 100644 index 000000000..e57adbc6a --- /dev/null +++ b/gcloud/alpha/edge-cache/operations/help @@ -0,0 +1,31 @@ +NAME + gcloud alpha edge-cache operations - manage EdgeCache operations + +SYNOPSIS + gcloud alpha edge-cache operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Commands for managing long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a long-running operation. + + list + (ALPHA) List long-running operations. + +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 edge-cache operations + diff --git a/gcloud/alpha/iap/gateway/get-iam-policy b/gcloud/alpha/edge-cache/operations/list similarity index 69% rename from gcloud/alpha/iap/gateway/get-iam-policy rename to gcloud/alpha/edge-cache/operations/list index 2bd23b860..194cfd059 100644 --- a/gcloud/alpha/iap/gateway/get-iam-policy +++ b/gcloud/alpha/edge-cache/operations/list @@ -1,29 +1,18 @@ NAME - gcloud alpha iap gateway get-iam-policy - get IAM policy for an IAP gateway - resource + gcloud alpha edge-cache operations list - list long-running operations SYNOPSIS - gcloud alpha iap gateway get-iam-policy [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + gcloud alpha edge-cache operations list [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha iap gateway get-iam-policy displays the IAM policy - associated with an IAP gateway resource. 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 iap gateway - set-iam-policy for additional details. + (ALPHA) List long-running operations. EXAMPLES - To get the IAM policy for the gateway resource within the active project, - run: + To list all operations, run: - $ gcloud alpha iap gateway get-iam-policy - - To get the IAM policy for the gateway resource within a project, run: - - $ gcloud alpha iap gateway get-iam-policy --project=PROJECT_ID + $ gcloud alpha edge-cache operations list LIST COMMAND FLAGS --filter=EXPRESSION @@ -51,6 +40,12 @@ LIST COMMAND FLAGS 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, @@ -59,9 +54,15 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +API REFERENCE + This command uses the networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + 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. + access allowlist. This variant is also available: + + $ gcloud edge-cache operations list diff --git a/gcloud/alpha/edge-cache/origins/create b/gcloud/alpha/edge-cache/origins/create new file mode 100644 index 000000000..1252976fa --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/create @@ -0,0 +1,199 @@ +NAME + gcloud alpha edge-cache origins create - create an EdgeCacheOrigin resource + +SYNOPSIS + gcloud alpha edge-cache origins create (ORIGIN : --location=LOCATION) + --origin-address=ORIGIN_ADDRESS [--async] [--description=DESCRIPTION] + [--failover-origin=FAILOVER_ORIGIN] [--labels=KEY=VALUE] + [--max-attempts=MAX_ATTEMPTS] [--port=PORT] [--protocol=PROTOCOL] + [--response-timeout=RESPONSE_TIMEOUT] + [--retry-conditions=[RETRY_CONDITIONS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new EdgeCacheOrigin resource. + +EXAMPLES + To create a EdgeCacheOrigin resource called 'my-origin', run: + + $ gcloud alpha edge-cache origins create my-origin \ + --origin-address="origin.example.com" + +POSITIONAL ARGUMENTS + Origin resource - The name of the EdgeCacheOrigin resource to create. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +REQUIRED FLAGS + --origin-address=ORIGIN_ADDRESS + A fully qualified domain name (FQDN) or IP address reachable over the + public Internet, or the address of a Google Cloud Storage bucket. + + This address will be used as the origin for cache requests - e.g. + ◆ FQDN: media-backend.example.com + ◆ IPv4: 35.218.1.1 + ◆ IPv6: [2607:f8b0:4012:809::200e] + ◆ Cloud Storage: gs://bucketname + + When providing an FQDN (hostname), it must be publicly resolvable (e.g. + via Google public DNS) and IP addresses must be publicly routable. If a + Cloud Storage bucket is provided, it must be in the canonical + "gs://bucketname" format. Other forms, such as + "storage.googleapis.com", will be rejected. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --failover-origin=FAILOVER_ORIGIN + Origin resource to try when the current origin cannot be reached. After + maxAttempts is reached, the configured failoverOrigin will be used to + fulfil the request. + + For example, the following are both valid URLs to an EdgeCacheOrigin + resource: + + ◆ /projects/PROJECT/locations/global/edgeCacheOrigins/yourOrigin + ◆ yourOrigin + + The value of timeout.maxAttemptsTimeout dictates the timeout across all + origins. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --max-attempts=MAX_ATTEMPTS + Maximum number of attempts to cache fill from this origin. Another + attempt is made when a cache fill fails with one of the + retry_conditions. + + Once max_attempts to this origin have failed the failover_origin will + be used, if one is specified. That failover_origin may specify its own + max_attempts, retry_conditions and failover_origin to control its own + cache fill failures. + + The total number of allowed attempts to cache fill across this and + failover origins is limited to four. The total time allowed for cache + fill attempts across this and failover origins can be controlled with + max_attempts_timeout. + + The last valid response from an origin will be returned to the client. + If no origin returns a valid response, an HTTP 503 will be returned to + the client. + + Defaults to 1. Must be a value greater than 0 and less than 4. + + --port=PORT + Port to connect to the origin on. Defaults to port 443 for HTTP2 and + HTTPS protocols, and port 80 for HTTP. + + --protocol=PROTOCOL + Protocol to use to connect to the configured origin. Defaults to HTTP2, + and it is strongly recommended that users use HTTP2 for both security & + performance. + + When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed, + unexpired TLS (SSL) certificate must be presented by the origin server. + + PROTOCOL must be one of: + + http + HTTP without TLS (SSL). This is not recommended, as communication + outside of Google's network will be unencrypted to the public + endpoint (origin). + + http2 + HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS). + Requires a valid (public, unexpired) TLS certificate to be present + on the origin. + + https + HTTP/1.1 with TLS (SSL). Requires a valid (public, unexpired) TLS + certificate to be present on the origin. + + --response-timeout=RESPONSE_TIMEOUT + Maximum duration to wait for data to arrive when reading from the HTTP + connection/stream. + + Defaults to 5 seconds. The timeout must be a value between 1s and 30s. + + --retry-conditions=[RETRY_CONDITIONS,...] + Specifies one or more retry conditions for the configured origin. + + If the failure mode during a connection attempt to the origin matches + the configured retryCondition(s), the origin request will be retried up + to maxAttempts times. The failoverOrigin, if configured, will then be + used to satisfy the request. + + The default retryCondition is "connect-failure". + + retryConditions apply to this origin, and not subsequent + failoverOrigin(s), which may specify their own retryConditions and + maxAttempts. + + Valid values are: + + ◆ connect-failure: Retry on failures connecting to origins, for + example due to connection timeouts. + ◆ http-5xx: Retry if the origin responds with any 5xx response code, + or if the origin does not respond at all, example: disconnects, + reset, read timeout, connection failure, and refused streams. + ◆ gateway-error: Similar to 5xx, but only applies to response codes + 502, 503 or 504. + ◆ retriable-4xx: Retry for retriable 4xx response codes, which + include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests) + ◆ not-found: Retry if the origin returns a HTTP 404 (Not Found). This + can be useful when generating video content, and the segment is not + available yet. + + RETRY_CONDITIONS must be one of: connect-failure, forbidden, + gateway-error, http-5xx, not-found, retriable-4xx, + retry-conditions-unspecified. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins create + diff --git a/gcloud/alpha/edge-cache/origins/delete b/gcloud/alpha/edge-cache/origins/delete new file mode 100644 index 000000000..ba8f2082d --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/delete @@ -0,0 +1,69 @@ +NAME + gcloud alpha edge-cache origins delete - delete an EdgeCacheOrigin resource + +SYNOPSIS + gcloud alpha edge-cache origins delete (ORIGIN : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a EdgeCacheOrigin resource. + +EXAMPLES + To delete a EdgeCacheOrigin resource called 'my-origin', run: + + $ gcloud alpha edge-cache origins delete my-origin + +POSITIONAL ARGUMENTS + Origin resource - The name of the EdgeCacheOrigin resource 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins delete + diff --git a/gcloud/alpha/edge-cache/origins/describe b/gcloud/alpha/edge-cache/origins/describe new file mode 100644 index 000000000..d8862a1ad --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/describe @@ -0,0 +1,65 @@ +NAME + gcloud alpha edge-cache origins describe - show details about an + EdgeCacheOrigin resource + +SYNOPSIS + gcloud alpha edge-cache origins describe (ORIGIN : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details about an EdgeCacheOrigin resource. + +EXAMPLES + To show details about an EdgeCacheOrigin resource named 'my-origin', run: + + $ gcloud alpha edge-cache origins describe my-origin + +POSITIONAL ARGUMENTS + Origin resource - The EdgeCacheOrigin resource 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins describe + diff --git a/gcloud/alpha/edge-cache/origins/export b/gcloud/alpha/edge-cache/origins/export new file mode 100644 index 000000000..54a6ecb4a --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/export @@ -0,0 +1,73 @@ +NAME + gcloud alpha edge-cache origins export - export an EdgeCacheOrigin resource + +SYNOPSIS + gcloud alpha edge-cache origins export (ORIGIN : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export an EdgeCacheOrigin resource to YAML. + +EXAMPLES + To export an EdgeCacheOrigin resource named 'my-origin', run: + + $ gcloud alpha edge-cache origins export my-origin \ + --destination=my-origin.yaml + +POSITIONAL ARGUMENTS + Origin resource - The EdgeCacheOrigin resource you want to export. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins export + diff --git a/gcloud/alpha/edge-cache/origins/help b/gcloud/alpha/edge-cache/origins/help new file mode 100644 index 000000000..5dd8aeeef --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/help @@ -0,0 +1,47 @@ +NAME + gcloud alpha edge-cache origins - interact with and manage EdgeCacheOrigin + resources + +SYNOPSIS + gcloud alpha edge-cache origins COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Interact with and manage EdgeCacheOrigin resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an EdgeCacheOrigin resource. + + delete + (ALPHA) Delete an EdgeCacheOrigin resource. + + describe + (ALPHA) Show details about an EdgeCacheOrigin resource. + + export + (ALPHA) Export an EdgeCacheOrigin resource. + + import + (ALPHA) Import an EdgeCacheOrigin resource. + + list + (ALPHA) List all EdgeCacheOrigin resources in a project. + + update + (ALPHA) Update an EdgeCacheOrigin resource. + +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 edge-cache origins + diff --git a/gcloud/alpha/edge-cache/origins/import b/gcloud/alpha/edge-cache/origins/import new file mode 100644 index 000000000..7a4de7701 --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/import @@ -0,0 +1,86 @@ +NAME + gcloud alpha edge-cache origins import - import an EdgeCacheOrigin resource + +SYNOPSIS + gcloud alpha edge-cache origins import (ORIGIN : --location=LOCATION) + [--async] [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import an EdgeCacheOrigin resource. If the named EdgeCacheOrigin + resource already exists, the resource will be updated to match the imported + resource configuration. + + If the named EdgeCacheOrigin resource does not already exist, a new + EdgeCacheOrigin resource will be created with that name. + +EXAMPLES + To import an EdgeCacheOrigin resource named 'my-origin' from a YAML file, + run: + + $ gcloud alpha edge-cache origins import my-origin \ + --source=my-origin.yaml + +POSITIONAL ARGUMENTS + Origin resource - The EdgeCacheOrigin resource you want to import. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins import + diff --git a/gcloud/alpha/edge-cache/origins/list b/gcloud/alpha/edge-cache/origins/list new file mode 100644 index 000000000..66cb09705 --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/list @@ -0,0 +1,69 @@ +NAME + gcloud alpha edge-cache origins list - list all EdgeCacheOrigin resources + in a project + +SYNOPSIS + gcloud alpha edge-cache origins list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List EdgeCacheOrigin resources. + +EXAMPLES + To list existing EdgeCacheOrigin resources, run: + + $ gcloud alpha edge-cache origins list + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins list + diff --git a/gcloud/alpha/edge-cache/origins/update b/gcloud/alpha/edge-cache/origins/update new file mode 100644 index 000000000..98d001f3b --- /dev/null +++ b/gcloud/alpha/edge-cache/origins/update @@ -0,0 +1,199 @@ +NAME + gcloud alpha edge-cache origins update - update an EdgeCacheOrigin resource + +SYNOPSIS + gcloud alpha edge-cache origins update (ORIGIN : --location=LOCATION) + [--async] [--description=DESCRIPTION] + [--failover-origin=FAILOVER_ORIGIN] [--labels=KEY=VALUE] + [--max-attempts=MAX_ATTEMPTS] [--origin-address=ORIGIN_ADDRESS] + [--port=PORT] [--protocol=PROTOCOL] + [--response-timeout=RESPONSE_TIMEOUT] + [--retry-conditions=[RETRY_CONDITIONS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an existing EdgeCacheOrigin resource. + +EXAMPLES + To update an EdgeCacheOrigin resource named 'my-origin', run: + + $ gcloud alpha edge-cache origins update my-origin \ + --origin-address=new-origin.example.com + +POSITIONAL ARGUMENTS + Origin resource - The name of the EdgeCacheOrigin resource to create. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --failover-origin=FAILOVER_ORIGIN + Origin resource to try when the current origin cannot be reached. After + maxAttempts is reached, the configured failoverOrigin will be used to + fulfil the request. + + For example, the following are both valid URLs to an EdgeCacheOrigin + resource: + + ◆ /projects/PROJECT/locations/global/edgeCacheOrigins/yourOrigin + ◆ yourOrigin + + The value of timeout.maxAttemptsTimeout dictates the timeout across all + origins. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --max-attempts=MAX_ATTEMPTS + Maximum number of attempts to cache fill from this origin. Another + attempt is made when a cache fill fails with one of the + retry_conditions. + + Once max_attempts to this origin have failed the failover_origin will + be used, if one is specified. That failover_origin may specify its own + max_attempts, retry_conditions and failover_origin to control its own + cache fill failures. + + The total number of allowed attempts to cache fill across this and + failover origins is limited to four. The total time allowed for cache + fill attempts across this and failover origins can be controlled with + max_attempts_timeout. + + The last valid response from an origin will be returned to the client. + If no origin returns a valid response, an HTTP 503 will be returned to + the client. + + Defaults to 1. Must be a value greater than 0 and less than 4. + + --origin-address=ORIGIN_ADDRESS + A fully qualified domain name (FQDN) or IP address reachable over the + public Internet, or the address of a Google Cloud Storage bucket. + + This address will be used as the origin for cache requests - e.g. + ◆ FQDN: media-backend.example.com + ◆ IPv4: 35.218.1.1 + ◆ IPv6: [2607:f8b0:4012:809::200e] + ◆ Cloud Storage: gs://bucketname + + When providing an FQDN (hostname), it must be publicly resolvable (e.g. + via Google public DNS) and IP addresses must be publicly routable. If a + Cloud Storage bucket is provided, it must be in the canonical + "gs://bucketname" format. Other forms, such as + "storage.googleapis.com", will be rejected. + + --port=PORT + Port to connect to the origin on. Defaults to port 443 for HTTP2 and + HTTPS protocols, and port 80 for HTTP. + + --protocol=PROTOCOL + Protocol to use to connect to the configured origin. Defaults to HTTP2, + and it is strongly recommended that users use HTTP2 for both security & + performance. + + When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed, + unexpired TLS (SSL) certificate must be presented by the origin server. + + PROTOCOL must be one of: + + http + HTTP without TLS (SSL). This is not recommended, as communication + outside of Google's network will be unencrypted to the public + endpoint (origin). + + http2 + HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS). + Requires a valid (public, unexpired) TLS certificate to be present + on the origin. + + https + HTTP/1.1 with TLS (SSL). Requires a valid (public, unexpired) TLS + certificate to be present on the origin. + + --response-timeout=RESPONSE_TIMEOUT + Maximum duration to wait for data to arrive when reading from the HTTP + connection/stream. + + Defaults to 5 seconds. The timeout must be a value between 1s and 30s. + + --retry-conditions=[RETRY_CONDITIONS,...] + Specifies one or more retry conditions for the configured origin. + + If the failure mode during a connection attempt to the origin matches + the configured retryCondition(s), the origin request will be retried up + to maxAttempts times. The failoverOrigin, if configured, will then be + used to satisfy the request. + + The default retryCondition is "connect-failure". + + retryConditions apply to this origin, and not subsequent + failoverOrigin(s), which may specify their own retryConditions and + maxAttempts. + + Valid values are: + + ◆ connect-failure: Retry on failures connecting to origins, for + example due to connection timeouts. + ◆ http-5xx: Retry if the origin responds with any 5xx response code, + or if the origin does not respond at all, example: disconnects, + reset, read timeout, connection failure, and refused streams. + ◆ gateway-error: Similar to 5xx, but only applies to response codes + 502, 503 or 504. + ◆ retriable-4xx: Retry for retriable 4xx response codes, which + include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests) + ◆ not-found: Retry if the origin returns a HTTP 404 (Not Found). This + can be useful when generating video content, and the segment is not + available yet. + + RETRY_CONDITIONS must be one of: connect-failure, forbidden, + gateway-error, http-5xx, not-found, retriable-4xx, + retry-conditions-unspecified. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache origins update + diff --git a/gcloud/alpha/edge-cache/services/delete b/gcloud/alpha/edge-cache/services/delete new file mode 100644 index 000000000..bf33ad2cb --- /dev/null +++ b/gcloud/alpha/edge-cache/services/delete @@ -0,0 +1,70 @@ +NAME + gcloud alpha edge-cache services delete - delete an EdgeCacheService + resource + +SYNOPSIS + gcloud alpha edge-cache services delete (SERVICE : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete an EdgeCacheService resource. + +EXAMPLES + To delete an EdgeCacheService resource named 'my-service', run: + + $ gcloud alpha edge-cache services delete my-service + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services delete + diff --git a/gcloud/alpha/edge-cache/services/describe b/gcloud/alpha/edge-cache/services/describe new file mode 100644 index 000000000..63963f6d8 --- /dev/null +++ b/gcloud/alpha/edge-cache/services/describe @@ -0,0 +1,65 @@ +NAME + gcloud alpha edge-cache services describe - show details about an + EdgeCacheService resource + +SYNOPSIS + gcloud alpha edge-cache services describe (SERVICE : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show details about an EdgeCacheService resource. + +EXAMPLES + To show details about an EdgeCacheService resource named 'my-service', run: + + $ gcloud alpha edge-cache services describe my-service + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services describe + diff --git a/gcloud/alpha/edge-cache/services/export b/gcloud/alpha/edge-cache/services/export new file mode 100644 index 000000000..414511695 --- /dev/null +++ b/gcloud/alpha/edge-cache/services/export @@ -0,0 +1,74 @@ +NAME + gcloud alpha edge-cache services export - export an EdgeCacheService + resource + +SYNOPSIS + gcloud alpha edge-cache services export (SERVICE : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export an EdgeCacheService resource to YAML. + +EXAMPLES + To export an existing EdgeCacheService resource named 'my-service', run: + + $ gcloud alpha edge-cache services export my-service \ + --destination=my-service.yaml + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource you want to export. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services export + diff --git a/gcloud/alpha/edge-cache/services/help b/gcloud/alpha/edge-cache/services/help new file mode 100644 index 000000000..2a09abdb9 --- /dev/null +++ b/gcloud/alpha/edge-cache/services/help @@ -0,0 +1,47 @@ +NAME + gcloud alpha edge-cache services - interact with and manage + EdgeCacheService resources + +SYNOPSIS + gcloud alpha edge-cache services COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Interact with and manage EdgeCacheService resources. + +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 an EdgeCacheService resource. + + describe + (ALPHA) Show details about an EdgeCacheService resource. + + export + (ALPHA) Export an EdgeCacheService resource. + + import + (ALPHA) Import an EdgeCacheService resource. + + invalidate-cache + (ALPHA) Invalidate the cache for an EdgeCacheService resource. + + list + (ALPHA) List all EdgeCacheService resources in a project. + + update + (ALPHA) Update an EdgeCacheService resource. + +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 edge-cache services + diff --git a/gcloud/alpha/edge-cache/services/import b/gcloud/alpha/edge-cache/services/import new file mode 100644 index 000000000..e4dc3af75 --- /dev/null +++ b/gcloud/alpha/edge-cache/services/import @@ -0,0 +1,87 @@ +NAME + gcloud alpha edge-cache services import - import an EdgeCacheService + resource + +SYNOPSIS + gcloud alpha edge-cache services import (SERVICE : --location=LOCATION) + [--async] [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import an EdgeCacheService resource. If the named EdgeCacheService + resource already exists, the resource will be updated to match the imported + resource configuration. + + If the named EdgeCacheService resource does not already exist, a new + EdgeCacheService resource will be created with that name. + +EXAMPLES + To import an EdgeCacheService resource named 'my-service' from a YAML file, + run: + + $ gcloud alpha edge-cache services import my-service \ + --source=my-service.yaml + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource you want to import. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services import + diff --git a/gcloud/alpha/edge-cache/services/invalidate-cache b/gcloud/alpha/edge-cache/services/invalidate-cache new file mode 100644 index 000000000..27259597c --- /dev/null +++ b/gcloud/alpha/edge-cache/services/invalidate-cache @@ -0,0 +1,109 @@ +NAME + gcloud alpha edge-cache services invalidate-cache - invalidate the cache + for an EdgeCacheService resource + +SYNOPSIS + gcloud alpha edge-cache services invalidate-cache + (SERVICE : --location=LOCATION) + (--host=HOST --path=PATH --tags=[TAGS,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Invalidate the cache entries associated with an EdgeCacheService + resource. + +EXAMPLES + To invalidate content via a tag, or tags for a given host for an + EdgeCacheService named 'my-service': + + $ gcloud alpha edge-cache services invalidate-cache my-service \ + --tags="status=404" --host="media.example.com" + + To invalidate all content under a specific path, specify an exact path, or + a prefix. Prefixes are denoted with a trailing * character. + + $ gcloud alpha edge-cache services invalidate-cache my-service \ + --path="/static/*" + + You can optionally combine this with a status code. For example, to + invalidate all cached HTTP 404s: + + $ gcloud alpha edge-cache services invalidate-cache my-service \ + --tags="status=404" --path="/static/*" + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource you want to invalidate + the cache for. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +REQUIRED FLAGS + At least one of these must be specified: + + --host=HOST + The hostname to invalidate against. You can specify an exact or + wildcard host - e.g. "video.example.com" or ".example.com" - based on + host component. + + --path=PATH + The path to invalidate against. You can specify an exact or wildcard + host - e.g. "/videos/hls/139123.mp4" or "/manifests/" - based on path + component. + + --tags=[TAGS,...] + A list of cache tags used to identify cached objects. + + ▸ Cache tags are specified when the response is first cached, by + setting the "Cache-Tag" response header at the origin. + ▸ By default, all objects have a cache tag representing the HTTP + status code of the response, the MIME content-type, and the origin. + ▸ Multiple cache tags in the same revalidation request are treated + as boolean OR - e.g. tag1 OR tag2 OR tag3. + ▸ If a host and/or path are also specified, these are treated as + boolean AND with any tags. + + Up to 10 tags may be specified in a single invalidation request. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services invalidate-cache + diff --git a/gcloud/alpha/edge-cache/services/list b/gcloud/alpha/edge-cache/services/list new file mode 100644 index 000000000..a08989ced --- /dev/null +++ b/gcloud/alpha/edge-cache/services/list @@ -0,0 +1,69 @@ +NAME + gcloud alpha edge-cache services list - list all EdgeCacheService resources + in a project + +SYNOPSIS + gcloud alpha edge-cache services list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List EdgeCacheService resources. + +EXAMPLES + To list existing EdgeCacheService resources, run: + + $ gcloud alpha edge-cache services list + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services list + diff --git a/gcloud/alpha/edge-cache/services/update b/gcloud/alpha/edge-cache/services/update new file mode 100644 index 000000000..66c0c61a9 --- /dev/null +++ b/gcloud/alpha/edge-cache/services/update @@ -0,0 +1,123 @@ +NAME + gcloud alpha edge-cache services update - update an EdgeCacheService + resource + +SYNOPSIS + gcloud alpha edge-cache services update (SERVICE : --location=LOCATION) + [--async] [--description=DESCRIPTION] + [--edge-security-policy=EDGE_SECURITY_POLICY] + [--edge-ssl-certificate=[EDGE_SSL_CERTIFICATE,...]] [--enable-logging] + [--labels=KEY=VALUE] [--logging-sample-rate=LOGGING_SAMPLE_RATE] + [--require-tls] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an existing EdgeCacheService resource. + +EXAMPLES + To update an EdgeCacheService resource called 'my-service' run: + + $ gcloud alpha edge-cache services update my-service \ + --description="new description" + +POSITIONAL ARGUMENTS + Service resource - The name of the EdgeCacheService resource to create. + 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --edge-security-policy=EDGE_SECURITY_POLICY + Resource URL that points at the Cloud Armor edge security policy that + is applied on each request against the EdgeCacheService. + + Security Policies should be specified as relative resource URLs - for + example projects/my-project/locations/global/securityPolicies/my-policy + + Note that only security policies with a type of EDGE can be attached to + an EdgeCacheService. + + --edge-ssl-certificate=[EDGE_SSL_CERTIFICATE,...] + URLs to sslCertificate resources that are used to authenticate + connections between users and the EdgeCacheService. + + Certificates should be specified as relative resource URLs - for + example projects/my-project/locations/global/certificates/my-cert + + Note that only "global" certificates with a "scope" of EDGE_CACHE can + be attached to an EdgeCacheService. + + You may specify up to 5 SSL certificates per Service. + + --enable-logging + Specifies whether to enable logging for traffic served by this service. + + Defaults to false. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --logging-sample-rate=LOGGING_SAMPLE_RATE + Configures the sampling rate of requests, where 1.0 means all logged + requests are reported and 0.0 means no logged requests are reported. + The default value is 1.0, and the value of the field must be in [0, 1]. + + This field can only be specified if logging is enabled for this + service. + + --require-tls + Require TLS (HTTPS) for all clients connecting to this service. + + Clients who connect over HTTP (port 80) will receive a HTTP 301 to the + same URL over HTTPS (port 443). You must have at least one (1) + edgeSslCertificate specified to enable this. + +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 networkservices/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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 edge-cache services update + diff --git a/gcloud/alpha/firebase/test/android/list-device-capacities b/gcloud/alpha/firebase/test/android/list-device-capacities index 301269492..ed09186b1 100644 --- a/gcloud/alpha/firebase/test/android/list-device-capacities +++ b/gcloud/alpha/firebase/test/android/list-device-capacities @@ -11,13 +11,14 @@ DESCRIPTION (ALPHA) List device capacity (high/medium/low/none) for all Android models & versions. - Device capacity is static information solely based on the number of devices - in Firebase Test Lab. It's important to note that device capacity does not - directly reflect any real-time data, like the length of the test queue, - traffic, or the available/busy/broken state of the devices. + Device capacity is the number of online devices in Firebase Test Lab. For + physical devices, the number is the average of online devices in the last + 30 days. It's important to note that device capacity does not directly + reflect any real-time data, like the length of the test queue, traffic, or + the available/busy state of the devices. EXAMPLES - To list capacity information for all devices which are available for + To list capacity information for all online devices which are available for testing, run: $ gcloud alpha firebase test android list-device-capacities diff --git a/gcloud/alpha/firebase/test/android/run b/gcloud/alpha/firebase/test/android/run index 5f52e7537..a24fce4a4 100644 --- a/gcloud/alpha/firebase/test/android/run +++ b/gcloud/alpha/firebase/test/android/run @@ -367,7 +367,7 @@ FLAGS is no greater than the total number of test cases. When you select one or more physical devices, the number of shards specified must be <= 50. When you select one or more ARM virtual devices, the number of - shards specified must be <= 50. When you select only x86 virtual + shards specified must be <= 100. When you select only x86 virtual devices, the number of shards specified must be <= 500. --test-targets-for-shard=TEST_TARGETS_FOR_SHARD @@ -375,7 +375,7 @@ FLAGS each shard (a group of test cases). Each time this flag is repeated, it creates a new shard. The shards are run in parallel on separate devices. You can repeat this flag up to 50 times when you select one - or more physical devices, up to 50 times when you select one or more + or more physical devices, up to 100 times when you select one or more ARM virtual devices, and up to 500 times when you select only x86 virtual devices. diff --git a/gcloud/alpha/firebase/test/ios/list-device-capacities b/gcloud/alpha/firebase/test/ios/list-device-capacities index 7cc694b50..264fee575 100644 --- a/gcloud/alpha/firebase/test/ios/list-device-capacities +++ b/gcloud/alpha/firebase/test/ios/list-device-capacities @@ -11,13 +11,14 @@ DESCRIPTION (ALPHA) List device capacity (high/medium/low/none) for all iOS models & versions. - Device capacity is static information solely based on the number of devices - in Firebase Test Lab. It's important to note that device capacity does not - directly reflect any real-time data, like the length of the test queue, - traffic, or the available/busy/broken state of the devices. + Device capacity is the number of online devices in Firebase Test Lab. For + physical devices, the number is the average of online devices in the last + 30 days. It's important to note that device capacity does not directly + reflect any real-time data, like the length of the test queue, traffic, or + the available/busy state of the devices. EXAMPLES - To list capacity information for all devices which are available for + To list capacity information for all online devices which are available for testing, run: $ gcloud alpha firebase test ios list-device-capacities diff --git a/gcloud/alpha/firebase/test/ios/run b/gcloud/alpha/firebase/test/ios/run index 92d6d2dd7..be1d865ec 100644 --- a/gcloud/alpha/firebase/test/ios/run +++ b/gcloud/alpha/firebase/test/ios/run @@ -13,9 +13,9 @@ SYNOPSIS [--other-files=DEVICE_PATH=FILE_PATH,[...]] [--record-video] [--results-bucket=RESULTS_BUCKET] [--results-dir=RESULTS_DIR] [--results-history-name=RESULTS_HISTORY_NAME] - [--scenario-numbers=int,[int,...]] [--test-special-entitlements] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + [--robo-script=ROBO_SCRIPT] [--scenario-numbers=int,[int,...]] + [--test-special-entitlements] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha firebase test ios run invokes and monitors tests in @@ -138,7 +138,8 @@ COMMONLY USED FLAGS ◆ --timeout 100 is 100 seconds --type=TYPE - The type of iOS test to run. TYPE must be one of: xctest, game-loop. + The type of iOS test to run. TYPE must be one of: xctest, game-loop, + robo. --xcode-version=XCODE_VERSION The version of Xcode that should be used to run an XCTest. Defaults to @@ -164,8 +165,8 @@ FLAGS --app=APP The path to the application archive (.ipa file) for game-loop testing. The path may be in the local filesystem or in Google Cloud Storage - using gs:// notation. This flag is only valid when --type=game-loop is - also set. + using gs:// notation. This flag is only valid when --type is game-loop + or robo. --async Invoke a test asynchronously without waiting for test results. @@ -240,6 +241,14 @@ FLAGS the same history name will have their results grouped together in the Firebase console in a time-ordered test history list. + --robo-script=ROBO_SCRIPT + The path to a Robo Script JSON file. The path may be in the local + filesystem or in Google Cloud Storage using gs:// notation. You can + guide the Robo test to perform specific actions by specifying a Robo + Script with this argument. Learn more at + https://firebase.google.com/docs/test-lab/robo-ux-test#scripting. This + flag is only valid when --type=robo is also set. + --scenario-numbers=int,[int,...] A list of game-loop scenario numbers which will be run as part of the test (default: scenario 1). A maximum of 1024 scenarios may be diff --git a/gcloud/alpha/firestore/databases/create b/gcloud/alpha/firestore/databases/create index be1c55cd8..f24dad352 100644 --- a/gcloud/alpha/firestore/databases/create +++ b/gcloud/alpha/firestore/databases/create @@ -3,7 +3,8 @@ NAME Native database via Firestore API SYNOPSIS - gcloud alpha firestore databases create [DATABASE] --location=LOCATION + gcloud alpha firestore databases create --location=LOCATION + [--database=DATABASE; default="(default)"] [--type=TYPE; default="firestore-native"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -21,8 +22,14 @@ DESCRIPTION $ gcloud alpha firestore databases create foo --location=us-east1 \ --type=datastore-mode -POSITIONAL ARGUMENTS - [DATABASE] +REQUIRED FLAGS + --location=LOCATION + The location to create the Google Cloud Firestore Native database + within. Available locations are listed at + https://cloud.google.com/firestore/docs/locations. + +OPTIONAL FLAGS + --database=DATABASE; default="(default)" The ID to use for the database, which will become the final component of the database's resource name. If database ID is not provided, (default) will be used as database ID. @@ -33,13 +40,6 @@ POSITIONAL ARGUMENTS Using "(default)" database ID is also allowed. -REQUIRED FLAGS - --location=LOCATION - The location to create the Google Cloud Firestore Native database - within. Available locations are listed at - https://cloud.google.com/firestore/docs/locations. - -OPTIONAL FLAGS --type=TYPE; default="firestore-native" The type of the database. TYPE must be one of: firestore-native, datastore-mode. diff --git a/gcloud/alpha/firestore/databases/describe b/gcloud/alpha/firestore/databases/describe index 159f74582..647d1f510 100644 --- a/gcloud/alpha/firestore/databases/describe +++ b/gcloud/alpha/firestore/databases/describe @@ -3,7 +3,8 @@ NAME Firestore database SYNOPSIS - gcloud alpha firestore databases describe [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore databases describe [--database=DATABASE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Describe a Google Cloud Firestore database. @@ -13,6 +14,24 @@ EXAMPLES $ gcloud alpha firestore databases describe +FLAGS + Database resource - The Google Cloud Firestore database 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 --database on the command line with a fully + specified name; + ◆ the default value of argument [--database] is (default) with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --database=DATABASE + ID of the database or fully qualified identifier for the database. To + set the database attribute: + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/databases/help b/gcloud/alpha/firestore/databases/help index c61d31015..66cdfe79e 100644 --- a/gcloud/alpha/firestore/databases/help +++ b/gcloud/alpha/firestore/databases/help @@ -23,6 +23,9 @@ COMMANDS describe (ALPHA) Describe a Google Cloud Firestore database. + list + (ALPHA) Lists all Firestore databases under the project. + update (ALPHA) Update the database configuration of a Cloud Firestore database. diff --git a/gcloud/alpha/firestore/databases/list b/gcloud/alpha/firestore/databases/list new file mode 100644 index 000000000..4878737ce --- /dev/null +++ b/gcloud/alpha/firestore/databases/list @@ -0,0 +1,58 @@ +NAME + gcloud alpha firestore databases list - lists all Firestore databases under + the project + +SYNOPSIS + gcloud alpha firestore databases list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Lists all Firestore databases under the project. + +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 + 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. + diff --git a/gcloud/alpha/firestore/databases/update b/gcloud/alpha/firestore/databases/update index d285a3739..0180c3b7d 100644 --- a/gcloud/alpha/firestore/databases/update +++ b/gcloud/alpha/firestore/databases/update @@ -3,8 +3,8 @@ NAME of a Cloud Firestore database SYNOPSIS - gcloud alpha firestore databases update [--async] [--type=TYPE] - [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore databases update [--async] [--database=DATABASE] + [--type=TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update the database configuration of a Cloud Firestore database. @@ -20,6 +20,22 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + Database resource - Cloud Firestore database 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 --database on the command line with a fully + specified name; + ◆ the default value of argument [--database] is (default) with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --database=DATABASE + ID of the database or fully qualified identifier for the database. To + set the database attribute: + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + --type=TYPE The database type. TYPE must be one of: datastore-mode, firestore-native. diff --git a/gcloud/alpha/firestore/export b/gcloud/alpha/firestore/export index 70dc24551..a8b83d5ec 100644 --- a/gcloud/alpha/firestore/export +++ b/gcloud/alpha/firestore/export @@ -4,10 +4,12 @@ NAME SYNOPSIS gcloud alpha firestore export OUTPUT_URI_PREFIX [--async] - [--collection-ids=[COLLECTION_IDS,...]] [GCLOUD_WIDE_FLAG ...] + [--collection-ids=[COLLECTION_IDS,...]] + [--database=DATABASE; default="(default)"] + [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) export Cloud Firestore documents to Google Cloud Storage + (ALPHA) export Cloud Firestore documents to Google Cloud Storage. EXAMPLES To export all collection groups to mybucket in objects prefixed with @@ -21,6 +23,11 @@ EXAMPLES --collection-ids='specific collection group1','specific collection group2' --async + To export all collection groups from certain namespace, run: + + $ gcloud alpha firestore export gs://mybucket/my/path \ + --namespace-ids='specific namespace id' + POSITIONAL ARGUMENTS OUTPUT_URI_PREFIX Location where the export files will be stored. Must be a valid Google @@ -47,6 +54,24 @@ FLAGS $ gcloud alpha firestore export --collection-ids='customers','orders' + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud alpha firestore export --database='foo' + + --namespace-ids=[NAMESPACE_IDS,...] + A list specifying which namespaces will be included in the operation. + When omitted, all namespaces are included. + + This is only supported for Datastore Mode databases. + + For example, to operate on only the 'customers' and 'orders' + namespaces: + + $ gcloud alpha firestore export --namespaces-ids='customers','orders' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/fields/ttls/list b/gcloud/alpha/firestore/fields/ttls/list index f192982b1..fae9e5e38 100644 --- a/gcloud/alpha/firestore/fields/ttls/list +++ b/gcloud/alpha/firestore/fields/ttls/list @@ -4,9 +4,9 @@ NAME SYNOPSIS gcloud alpha firestore fields ttls list - [--collection-group=COLLECTION_GROUP] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--collection-group=COLLECTION_GROUP --database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) List fields that give an expiration timestamp for documents in a @@ -21,22 +21,15 @@ FLAGS Collection group resource - Collection group of the ttl. This can be omitted to include fields across all collection groups - (kinds). 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: + (kinds). 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 --collection-group on the command line with a fully specified name; ◆ provide the argument [--collection-group] 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--collection-group] on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. --collection-group=COLLECTION_GROUP ID of the collection group or fully qualified identifier for the @@ -44,6 +37,17 @@ FLAGS ▸ provide the argument --collection-group on the command line; ▸ provide the argument [--collection-group] on the command line. + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/firestore/fields/ttls/update b/gcloud/alpha/firestore/fields/ttls/update index a32f8d69f..53677a4ed 100644 --- a/gcloud/alpha/firestore/fields/ttls/update +++ b/gcloud/alpha/firestore/fields/ttls/update @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha firestore fields ttls update - (FIELD : --collection-group=COLLECTION_GROUP) + (FIELD : --collection-group=COLLECTION_GROUP --database=DATABASE) (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -35,12 +35,7 @@ POSITIONAL ARGUMENTS ◆ provide the argument field 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 - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. This must be specified. @@ -60,6 +55,15 @@ POSITIONAL ARGUMENTS specified name; ▸ provide the argument --collection-group on the command line. + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/alpha/firestore/help b/gcloud/alpha/firestore/help index 0196bb617..b5b9042d6 100644 --- a/gcloud/alpha/firestore/help +++ b/gcloud/alpha/firestore/help @@ -30,6 +30,9 @@ GROUPS indexes (ALPHA) Manage indexes for Cloud Firestore. + locations + (ALPHA) The set of commands to manage Locations for Cloud Firestore. + operations (ALPHA) Manage Long Running Operations for Cloud Firestore. diff --git a/gcloud/alpha/firestore/import b/gcloud/alpha/firestore/import index 78dccde6a..8aa5b69dc 100644 --- a/gcloud/alpha/firestore/import +++ b/gcloud/alpha/firestore/import @@ -4,10 +4,12 @@ NAME SYNOPSIS gcloud alpha firestore import INPUT_URI_PREFIX [--async] - [--collection-ids=[COLLECTION_IDS,...]] [GCLOUD_WIDE_FLAG ...] + [--collection-ids=[COLLECTION_IDS,...]] + [--database=DATABASE; default="(default)"] + [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) import Cloud Firestore documents from Google Cloud Storage + (ALPHA) import Cloud Firestore documents from Google Cloud Storage. EXAMPLES To import all collection groups from mybucket/my/path, run: @@ -20,6 +22,11 @@ EXAMPLES --collection-ids='specific collection group1','specific collection group2' --async + To import all collection groups from certain namespace, run: + + $ gcloud alpha firestore import gs://mybucket/my/path \ + --namespace-ids='specific namespace id' + POSITIONAL ARGUMENTS INPUT_URI_PREFIX Location of the import files. @@ -42,6 +49,24 @@ FLAGS $ gcloud alpha firestore import --collection-ids='customers','orders' + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud alpha firestore import --database='foo' + + --namespace-ids=[NAMESPACE_IDS,...] + A list specifying which namespaces will be included in the operation. + When omitted, all namespaces are included. + + This is only supported for Datastore Mode databases. + + For example, to operate on only the 'customers' and 'orders' + namespaces: + + $ gcloud alpha firestore import --namespaces-ids='customers','orders' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/indexes/composite/create b/gcloud/alpha/firestore/indexes/composite/create index a65ce0f71..b50191441 100644 --- a/gcloud/alpha/firestore/indexes/composite/create +++ b/gcloud/alpha/firestore/indexes/composite/create @@ -3,9 +3,9 @@ NAME index SYNOPSIS - gcloud alpha firestore indexes composite create - --collection-group=COLLECTION_GROUP --field-config=FIELD_CONFIG - [--async] [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore indexes composite create --field-config=FIELD_CONFIG + (--collection-group=COLLECTION_GROUP : --database=DATABASE) [--async] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a new composite index. @@ -20,27 +20,12 @@ EXAMPLES --field-config=field-path=user-id,order=descending \ --field-config=field-path=timestamp,order=descending + $ gcloud alpha firestore indexes composite create \ + --database=(default) --collection-group=Events \ + --field-config=field-path=user-id,order=descending \ + --field-config=field-path=timestamp,order=descending + REQUIRED FLAGS - Collection group resource - Collection group of the index. 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 --collection-group 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). - - This must be specified. - - --collection-group=COLLECTION_GROUP - ID of the collection group or fully qualified identifier for the - collection group. To set the collection-group attribute: - ▸ provide the argument --collection-group on the command line. - --field-config=FIELD_CONFIG Configuration for a field. @@ -67,6 +52,34 @@ REQUIRED FLAGS option is 'contains'. Exactly one of 'order' or 'array-config' must be specified. + Collection group resource - Collection group of the index. 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 --collection-group on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --collection-group=COLLECTION_GROUP + ID of the collection group or fully qualified identifier for the + collection group. To set the collection-group attribute: + ▸ provide the argument --collection-group on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/alpha/firestore/indexes/composite/delete b/gcloud/alpha/firestore/indexes/composite/delete index d3ef1a1de..3e1161913 100644 --- a/gcloud/alpha/firestore/indexes/composite/delete +++ b/gcloud/alpha/firestore/indexes/composite/delete @@ -3,8 +3,8 @@ NAME composite index SYNOPSIS - gcloud alpha firestore indexes composite delete INDEX - [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore indexes composite delete + (INDEX : --database=DATABASE) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete the given composite index. @@ -14,20 +14,19 @@ EXAMPLES $ gcloud alpha firestore indexes composite delete 3421ef + $ gcloud alpha firestore indexes composite delete 3421ef \ + --database=(default) + POSITIONAL ARGUMENTS - Composite index resource - Index 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: + Composite index resource - Index 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 index 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 - database attribute: - ◆ provide the argument index on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). To set the collection-group - attribute: + collection-group attribute: ◆ provide the argument index on the command line with a fully specified name; ◆ provide the argument [--collection-group] on the command line. @@ -39,6 +38,18 @@ POSITIONAL ARGUMENTS composite index. To set the index attribute: ▸ provide the argument index on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + Database of the composite index. + + To set the database attribute: + ▸ provide the argument index on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/indexes/composite/describe b/gcloud/alpha/firestore/indexes/composite/describe index 9ce635bc3..fce94488b 100644 --- a/gcloud/alpha/firestore/indexes/composite/describe +++ b/gcloud/alpha/firestore/indexes/composite/describe @@ -3,8 +3,8 @@ NAME composite index SYNOPSIS - gcloud alpha firestore indexes composite describe INDEX - [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore indexes composite describe + (INDEX : --database=DATABASE) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Describe the given composite index. @@ -14,20 +14,19 @@ EXAMPLES $ gcloud alpha firestore indexes composite describe 3421ef + $ gcloud alpha firestore indexes composite describe 3421ef \ + --database=(default) + POSITIONAL ARGUMENTS - Composite index resource - Index 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: + Composite index resource - Index 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 index 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 - database attribute: - ◆ provide the argument index on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). To set the collection-group - attribute: + collection-group attribute: ◆ provide the argument index on the command line with a fully specified name; ◆ provide the argument [--collection-group] on the command line. @@ -39,6 +38,18 @@ POSITIONAL ARGUMENTS composite index. To set the index attribute: ▸ provide the argument index on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + Database of the composite index. + + To set the database attribute: + ▸ provide the argument index on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/indexes/composite/list b/gcloud/alpha/firestore/indexes/composite/list index 2ed9a0417..4b8690b19 100644 --- a/gcloud/alpha/firestore/indexes/composite/list +++ b/gcloud/alpha/firestore/indexes/composite/list @@ -2,9 +2,9 @@ NAME gcloud alpha firestore indexes composite list - list composite indexes SYNOPSIS - gcloud alpha firestore indexes composite list [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud alpha firestore indexes composite list [--database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) List composite indexes. @@ -14,12 +14,34 @@ EXAMPLES $ gcloud alpha firestore indexes composite list + $ gcloud alpha firestore indexes composite list --database=(default) + The following command lists composite indexes in the Events collection group: $ gcloud alpha firestore indexes composite list \ --filter=COLLECTION_GROUP:Events +FLAGS + Collection group resource - Collection group of the index. 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 [--collection-group] 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 + collection-group attribute: + ◆ provide the argument [--collection-group] on the command line. + + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/firestore/indexes/fields/describe b/gcloud/alpha/firestore/indexes/fields/describe index 6f109bdd5..b27b36b13 100644 --- a/gcloud/alpha/firestore/indexes/fields/describe +++ b/gcloud/alpha/firestore/indexes/fields/describe @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha firestore indexes fields describe - [[FIELD] --collection-group=COLLECTION_GROUP] [GCLOUD_WIDE_FLAG ...] + [[FIELD] --collection-group=COLLECTION_GROUP --database=DATABASE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Describe the index configuration of the given field. @@ -14,6 +15,8 @@ EXAMPLES $ gcloud alpha firestore indexes fields describe + $ gcloud alpha firestore indexes fields describe --database=(default) + The following command describes the index configuration of the timestamp field in the Events collection group. @@ -31,13 +34,7 @@ POSITIONAL ARGUMENTS name; ◆ with a fully specified name; ◆ set the property core/project; - ◆ provide the argument --project on the command line. To set the - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ with a fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. [FIELD] ID of the field or fully qualified identifier for the field. To set @@ -55,6 +52,16 @@ POSITIONAL ARGUMENTS ▸ provide the argument --collection-group on the command line; ▸ . + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/firestore/indexes/fields/list b/gcloud/alpha/firestore/indexes/fields/list index 712f13cca..59d4a5110 100644 --- a/gcloud/alpha/firestore/indexes/fields/list +++ b/gcloud/alpha/firestore/indexes/fields/list @@ -4,9 +4,9 @@ NAME SYNOPSIS gcloud alpha firestore indexes fields list - [--collection-group=COLLECTION_GROUP] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--collection-group=COLLECTION_GROUP --database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) List fields that have had their index configurations exempted from @@ -18,6 +18,8 @@ EXAMPLES $ gcloud alpha firestore indexes fields list + $ gcloud alpha firestore indexes fields list --database=(default) + The following command lists fields with custom index settings in the Events collection group: @@ -35,23 +37,16 @@ EXAMPLES FLAGS Collection group resource - Collection group of the index. - This can be omitted to include fields across all collection groups. 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: + This can be omitted to include fields across all collection groups. 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 --collection-group on the command line with a fully specified name; ◆ provide the argument [--collection-group] 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--collection-group] on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. --collection-group=COLLECTION_GROUP ID of the collection group or fully qualified identifier for the @@ -59,6 +54,17 @@ FLAGS ▸ provide the argument --collection-group on the command line; ▸ provide the argument [--collection-group] on the command line. + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/firestore/indexes/fields/update b/gcloud/alpha/firestore/indexes/fields/update index 760b723d0..68cb93df2 100644 --- a/gcloud/alpha/firestore/indexes/fields/update +++ b/gcloud/alpha/firestore/indexes/fields/update @@ -4,9 +4,8 @@ NAME SYNOPSIS gcloud alpha firestore indexes fields update - (FIELD : --collection-group=COLLECTION_GROUP) - (--clear-exemption | --disable-indexes - | --index=[array-config=ARRAY-CONFIG],[order=ORDER]) [--async] + (FIELD : --collection-group=COLLECTION_GROUP --database=DATABASE) + (--clear-exemption | --disable-indexes | --index=KEY=VALUE) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -22,6 +21,9 @@ EXAMPLES $ gcloud alpha firestore indexes fields update timestamp \ --collection-group=Events --disable-indexes + $ gcloud alpha firestore indexes fields update timestamp \ + --database=(default) --collection-group=Events --disable-indexes + The following command creates an exemption for the timestamp field in the Events collection group, in which the list of indexes is explicitly set to [ASCENDING, DESCENDING]: @@ -45,12 +47,7 @@ POSITIONAL ARGUMENTS ◆ provide the argument field 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 - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. This must be specified. @@ -70,6 +67,15 @@ POSITIONAL ARGUMENTS specified name; ▸ provide the argument --collection-group on the command line. + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + REQUIRED FLAGS Exactly one of these must be specified: @@ -80,7 +86,7 @@ REQUIRED FLAGS --disable-indexes If provided, the field will no longer be indexed at all. - --index=[array-config=ARRAY-CONFIG],[order=ORDER] + --index=KEY=VALUE An index for the field. This flag can be repeated to provide multiple indexes. Any existing diff --git a/gcloud/alpha/firestore/locations/help b/gcloud/alpha/firestore/locations/help new file mode 100644 index 000000000..dd25f2a6d --- /dev/null +++ b/gcloud/alpha/firestore/locations/help @@ -0,0 +1,27 @@ +NAME + gcloud alpha firestore locations - the set of commands to manage Locations + for Cloud Firestore + +SYNOPSIS + gcloud alpha firestore locations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The set of commands to manage Locations for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + (ALPHA) List locations available to Google Cloud Firestore. + +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. + diff --git a/gcloud/alpha/firestore/locations/list b/gcloud/alpha/firestore/locations/list new file mode 100644 index 000000000..da87368eb --- /dev/null +++ b/gcloud/alpha/firestore/locations/list @@ -0,0 +1,24 @@ +NAME + gcloud alpha firestore locations list - list locations available to Google + Cloud Firestore + +SYNOPSIS + gcloud alpha firestore locations list [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List locations available to Google Cloud Firestore. + +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. + diff --git a/gcloud/alpha/functions/add-invoker-policy-binding b/gcloud/alpha/functions/add-invoker-policy-binding index 14db4c9f2..29565bb2f 100644 --- a/gcloud/alpha/functions/add-invoker-policy-binding +++ b/gcloud/alpha/functions/add-invoker-policy-binding @@ -7,7 +7,7 @@ SYNOPSIS --member=PRINCIPAL [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) This command applies to Cloud Functions V2 only. + (ALPHA) This command applies to Cloud Functions 2nd Gen only. EXAMPLES To add the invoker policy binding for FUNCTION-1 from role ROLE-1 for diff --git a/gcloud/alpha/functions/deploy b/gcloud/alpha/functions/deploy index 28ff30886..57e8f90f3 100644 --- a/gcloud/alpha/functions/deploy +++ b/gcloud/alpha/functions/deploy @@ -4,9 +4,10 @@ NAME SYNOPSIS gcloud alpha functions deploy (NAME : --region=REGION) [--allow-unauthenticated] [--buildpack-stack=BUILDPACK_STACK] - [--docker-registry=DOCKER_REGISTRY] [--egress-settings=EGRESS_SETTINGS] - [--entry-point=ENTRY_POINT] [--gen2] [--ignore-file=IGNORE_FILE] - [--ingress-settings=INGRESS_SETTINGS] [--memory=MEMORY] [--retry] + [--concurrency=CONCURRENCY] [--docker-registry=DOCKER_REGISTRY] + [--egress-settings=EGRESS_SETTINGS] [--entry-point=ENTRY_POINT] + [--gen2] [--ignore-file=IGNORE_FILE] + [--ingress-settings=INGRESS_SETTINGS] [--retry] [--run-service-account=RUN_SERVICE_ACCOUNT] [--runtime=RUNTIME] [--security-level=SECURITY_LEVEL; default="secure-always"] [--serve-all-traffic-latest-revision] @@ -38,6 +39,7 @@ SYNOPSIS /secret_path=SECRET_VALUE_REF, /mount_path:/secret_file_path=SECRET_VALUE_REF,...]] [--clear-vpc-connector | --vpc-connector=VPC_CONNECTOR] + [--memory=MEMORY : --cpu=CPU] [--trigger-bucket=TRIGGER_BUCKET | --trigger-http | --trigger-topic=TRIGGER_TOPIC | --trigger-event=EVENT_TYPE --trigger-resource=RESOURCE @@ -98,6 +100,11 @@ FLAGS --buildpack-stack=BUILDPACK_STACK Specifies one of the Google provided buildpack stacks. + --concurrency=CONCURRENCY + Set the maximum number of concurrent requests allowed per container + instance. Leave concurrency unspecified to receive the server default + value. Only applicable when the --gen2 flag is provided. + --docker-registry=DOCKER_REGISTRY Docker Registry to use for storing the function's Docker images. The option container-registry is used by default. @@ -135,22 +142,6 @@ FLAGS default all will be used. INGRESS_SETTINGS must be one of: all, internal-only, internal-and-gclb. - --memory=MEMORY - Limit on the amount of memory the function can use. - - Allowed values for v1 are: 128MB, 256MB, 512MB, 1024MB, 2048MB, 4096MB, - and 8192MB. - - Allowed values for GCF 2nd gen are in the format: with - allowed units of "k", "M", "G", "Ki", "Mi", "Gi". Ending 'b' or 'B' is - allowed. - - Examples: 100000k, 128M, 10Mb, 1024Mi, 750K, 4Gi. - - By default, a new function is limited to 256MB of memory. When - deploying an update to an existing function, the function keeps its old - memory limit unless you specify this flag. - --retry If specified, then the function will be retried in case of a failure. @@ -531,6 +522,38 @@ FLAGS ${CONNECTOR}, where ${CONNECTOR} is the short name of the VPC Access connector. + --memory=MEMORY + Limit on the amount of memory the function can use. + + Allowed values for v1 are: 128MB, 256MB, 512MB, 1024MB, 2048MB, 4096MB, + and 8192MB. + + Allowed values for GCF 2nd gen are in the format: with + allowed units of "k", "M", "G", "Ki", "Mi", "Gi". Ending 'b' or 'B' is + allowed. + + Examples: 100000k, 128M, 10Mb, 1024Mi, 750K, 4Gi. + + By default, a new function is limited to 256MB of memory. When + deploying an update to an existing function, the function keeps its old + memory limit unless you specify this flag. + + --cpu=CPU + The number of available CPUs to set. Only valid when --gen2 and + --memory=MEMORY are specified. + + Examples: .5, 2, 2.0, 2000m. + + By default, a new function's available CPUs is determined based on its + memory value. + + When deploying an update that includes memory changes to an existing + function, the function's available CPUs will be recalculated based on + the new memory unless this flag is specified. When deploying an update + that does not include memory changes to an existing function, the + function's "available CPUs" setting will keep its old value unless you + use this flag to change the setting. + If you don't specify a trigger when deploying an update to an existing function it will keep its current trigger. You must specify --trigger-topic, --trigger-bucket, --trigger-http, --trigger-event-filters diff --git a/gcloud/alpha/functions/remove-invoker-policy-binding b/gcloud/alpha/functions/remove-invoker-policy-binding index b8a32fdce..8e0b294b2 100644 --- a/gcloud/alpha/functions/remove-invoker-policy-binding +++ b/gcloud/alpha/functions/remove-invoker-policy-binding @@ -7,7 +7,7 @@ SYNOPSIS (NAME : --region=REGION) --member=PRINCIPAL [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) This command applies to Cloud Functions V2 only. + (ALPHA) This command applies to Cloud Functions 2nd gen only. EXAMPLES To remove the invoker policy binding for FUNCTION-1 from role ROLE-1 for diff --git a/gcloud/alpha/healthcare/fhir-stores/import/gcs b/gcloud/alpha/healthcare/fhir-stores/import/gcs index db29516a0..8d56b8e02 100644 --- a/gcloud/alpha/healthcare/fhir-stores/import/gcs +++ b/gcloud/alpha/healthcare/fhir-stores/import/gcs @@ -17,14 +17,14 @@ EXAMPLES the folder 'someFolder' into the FHIR store 'test-fhir-store', run: $ gcloud alpha healthcare fhir-stores import gcs test-fhir-store \ - --gcs-uri=gs://testGcsBucket/someFolder --dataset=test-dataset + --gcs-uri=gs://testGcsBucket/someFolder/* --dataset=test-dataset To perform the same import, but importing resources with the content structure of 'RESOURCE', run: $ gcloud alpha healthcare fhir-stores import gcs test-fhir-store \ - --gcs-uri=gs://testGcsBucket/someFolder --dataset=test-dataset \ - --content-structure=RESOURCE + --gcs-uri=gs://testGcsBucket/someFolder/* \ + --dataset=test-dataset --content-structure=RESOURCE POSITIONAL ARGUMENTS FhirStore resource - Cloud Healthcare API FHIR store into which the data @@ -64,7 +64,21 @@ REQUIRED FLAGS --gcs-uri=GCS_URI Cloud Storage source data locations. Each Cloud Storage object should be a text file that contains newline-delimited JSON structures - conforming to the FHIR standard. + conforming to the FHIR standard. You can use wildcards to import + multiple files from one or more directories. + ◆ Use * to match 0 or more non-separator characters. For example, + gs://BUCKET/DIRECTORY/Example*.ndjson matches Example.ndjson and + Example22.ndjson in DIRECTORY. + ◆ Use ** to match 0 or more characters (including separators). Must + be used at the end of a path and with no other wildcards in the path. + Can also be used with a filename extension (such as .ndjson), which + imports all files with the filename extension in the specified + directory and its subdirectories. For example, + gs://BUCKET/DIRECTORY/**.ndjson imports all files with the .ndjson + filename extension in DIRECTORY and its subdirectories. + ◆ Use ? to match 1 character. For example, + gs://BUCKET/DIRECTORY/Example?.ndjson matches Example1.ndjson but + does not match Example.ndjson or Example01.ndjson. OPTIONAL FLAGS --async diff --git a/gcloud/alpha/iam/service-accounts/config/export b/gcloud/alpha/iam/service-accounts/config/export index 57e9e2616..c5917c3b0 100644 --- a/gcloud/alpha/iam/service-accounts/config/export +++ b/gcloud/alpha/iam/service-accounts/config/export @@ -65,7 +65,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/iam/service-accounts/keys/config/export b/gcloud/alpha/iam/service-accounts/keys/config/export index 381780c8a..743b46576 100644 --- a/gcloud/alpha/iam/service-accounts/keys/config/export +++ b/gcloud/alpha/iam/service-accounts/keys/config/export @@ -81,7 +81,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/iap/gateway/help b/gcloud/alpha/iap/gateway/help deleted file mode 100644 index e8fd11f2d..000000000 --- a/gcloud/alpha/iap/gateway/help +++ /dev/null @@ -1,42 +0,0 @@ -NAME - gcloud alpha iap gateway - manage IAP gateway policies - -SYNOPSIS - gcloud alpha iap gateway COMMAND [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) Cloud Identity-Aware Proxy (Cloud IAP) controls access to your - cloud applications running on Google Cloud Platform. Cloud IAP works by - verifying user identity and context of the request to determine if a user - should be allowed to access the application. - - More information on Cloud IAP can be found here: - https://cloud.google.com/iap and detailed documentation can be found here: - https://cloud.google.com/iap/docs/ - -GCLOUD WIDE FLAGS - These flags are available to all commands: --help. - - Run $ gcloud help for details. - -COMMANDS - COMMAND is one of the following: - - add-iam-policy-binding - (ALPHA) Add IAM policy binding to an IAP gateway resource. - - get-iam-policy - (ALPHA) Get IAM policy for an IAP gateway resource. - - remove-iam-policy-binding - (ALPHA) Remove IAM policy binding from an IAP gateway resource. - - set-iam-policy - (ALPHA) Set the IAM policy for an IAP gateway resource. - -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. - diff --git a/gcloud/alpha/iap/gateway/set-iam-policy b/gcloud/alpha/iap/gateway/set-iam-policy deleted file mode 100644 index 7370fdae5..000000000 --- a/gcloud/alpha/iap/gateway/set-iam-policy +++ /dev/null @@ -1,46 +0,0 @@ -NAME - gcloud alpha iap gateway set-iam-policy - set the IAM policy for an IAP - gateway resource - -SYNOPSIS - gcloud alpha iap gateway set-iam-policy POLICY_FILE [GCLOUD_WIDE_FLAG ...] - -DESCRIPTION - (ALPHA) This command replaces the existing IAM policy for an IAP gateway - resource, given 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 obtained via $ gcloud alpha iap gateway get-iam-policy will - prevent the \ replacement if the policy for the resource has been - subsequently updated.) A policy file that does not contain an etag value - will replace any existing policy for the resource. - -EXAMPLES - To set the IAM policy for the gateway resource within the active project, - run: - - $ gcloud alpha iap gateway set-iam-policy POLICY_FILE - - To set the IAM policy for the gateway resource within a project, run: - - $ gcloud alpha iap gateway set-iam-policy POLICY_FILE \ - --project=PROJECT_ID - -POSITIONAL ARGUMENTS - POLICY_FILE - JSON or YAML file containing the IAM policy. - -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. - diff --git a/gcloud/alpha/iap/help b/gcloud/alpha/iap/help index 428625f76..7b211d823 100644 --- a/gcloud/alpha/iap/help +++ b/gcloud/alpha/iap/help @@ -22,9 +22,6 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: - gateway - (ALPHA) Manage IAP gateway policies. - oauth-brands (ALPHA) Manage IAP OAuth brands. diff --git a/gcloud/alpha/iap/oauth-clients/create b/gcloud/alpha/iap/oauth-clients/create index 0b53354d6..df9f8df71 100644 --- a/gcloud/alpha/iap/oauth-clients/create +++ b/gcloud/alpha/iap/oauth-clients/create @@ -1,5 +1,5 @@ NAME - gcloud alpha iap oauth-clients create - create a Cloud IAP OAuth client for + gcloud alpha iap oauth-clients create - create a Cloud IAP OAuth client in the project SYNOPSIS @@ -7,18 +7,18 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) gcloud alpha iap oauth-clients create is used to create a Cloud IAP - OAuth client for the project. To call this command, the Cloud OAuth brand - for the project must exist and be set for 'internal only'. The client is - owned by Cloud IAP. + (ALPHA) gcloud alpha iap oauth-clients create is used to create an OAuth + client in the project to be used by Cloud IAP. To call this command, the + Cloud OAuth brand for the project must exist and be set for 'internal + only'. The new client is owned by Cloud IAP. EXAMPLES - To create a Cloud OAuth client for the current project, run: + To create a Cloud IAP OAuth client for the current project, run: $ gcloud alpha iap oauth-clients create BRAND \ --display_name=DISPLAY_NAME - To create a Cloud OAuth client for the project PROJECT_ID, run: + To create a Cloud IAP OAuth client for the project PROJECT_ID, run: $ gcloud alpha iap oauth-clients create BRAND \ --display_name=DISPLAY_NAME --project=PROJECT_ID diff --git a/gcloud/alpha/iap/oauth-clients/delete b/gcloud/alpha/iap/oauth-clients/delete index b4d616269..3d28a5f9a 100644 --- a/gcloud/alpha/iap/oauth-clients/delete +++ b/gcloud/alpha/iap/oauth-clients/delete @@ -7,15 +7,16 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha iap oauth-clients delete is used to delete a Cloud IAP - OAuth client. + OAuth client. Note this command cannot be used to delete any other type of + OAuth client in your project. EXAMPLES - To delete a Cloud OAuth client named CLIENT for the current project and + To delete a Cloud IAP OAuth client named CLIENT for the current project and brand BRAND, run: $ gcloud alpha iap oauth-clients delete CLIENT --brand=BRAND - To delete a Cloud OAuth client named CLIENT for a specific project + To delete a Cloud IAP OAuth client named CLIENT for a specific project PROJECT_ID and brand BRAND, run: $ gcloud alpha iap oauth-clients delete CLIENT --brand=BRAND \ diff --git a/gcloud/alpha/iap/oauth-clients/describe b/gcloud/alpha/iap/oauth-clients/describe index 0ea1e16b7..fb603de98 100644 --- a/gcloud/alpha/iap/oauth-clients/describe +++ b/gcloud/alpha/iap/oauth-clients/describe @@ -7,14 +7,15 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha iap oauth-clients describe is used to describe a Cloud - IAP OAuth client. + IAP OAuth client. Note this command cannot be used to describe any other + type of OAuth client in your project. EXAMPLES - To describe a Cloud OAuth client for the current project, run: + To describe a Cloud IAP OAuth client for the current project, run: $ gcloud alpha iap oauth-clients describe NAME - To describe a Cloud OAuth client for a specific brand, run: + To describe a Cloud IAP OAuth client for a specific brand, run: $ gcloud alpha iap oauth-clients describe NAME --brand=BRAND diff --git a/gcloud/alpha/iap/oauth-clients/help b/gcloud/alpha/iap/oauth-clients/help index 4d7d7407c..15082d35e 100644 --- a/gcloud/alpha/iap/oauth-clients/help +++ b/gcloud/alpha/iap/oauth-clients/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud alpha iap oauth-clients COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Manage IAP OAuth clients. + (ALPHA) Manage OAuth clients that are used by Cloud Identity-Aware Proxy. + Note this API cannot be used as a generic management API for all OAuth + clients in your project. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,7 +18,7 @@ COMMANDS COMMAND is one of the following: create - (ALPHA) Create a Cloud IAP OAuth client for the project. + (ALPHA) Create a Cloud IAP OAuth client in the project. delete (ALPHA) Delete a Cloud IAP OAuth client. diff --git a/gcloud/alpha/iap/oauth-clients/list b/gcloud/alpha/iap/oauth-clients/list index c3b0f2505..9b362fee0 100644 --- a/gcloud/alpha/iap/oauth-clients/list +++ b/gcloud/alpha/iap/oauth-clients/list @@ -9,10 +9,11 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha iap oauth-clients list is used to list Cloud IAP OAuth - clients in a Cloud OAuth brand. + clients in a Cloud OAuth brand. Note this command will not list any other + type of OAuth client in your project. EXAMPLES - To list a Cloud OAuth client for the current project, run: + To list the Cloud IAP OAuth clients for the current project, run: $ gcloud alpha iap oauth-clients list BRAND diff --git a/gcloud/alpha/iap/oauth-clients/reset-secret b/gcloud/alpha/iap/oauth-clients/reset-secret index 3ec42c9f1..6d67cc622 100644 --- a/gcloud/alpha/iap/oauth-clients/reset-secret +++ b/gcloud/alpha/iap/oauth-clients/reset-secret @@ -8,14 +8,15 @@ SYNOPSIS DESCRIPTION (ALPHA) gcloud alpha iap oauth-clients reset-secret is used to reset a - Cloud IAP OAuth client secret. + Cloud IAP OAuth client secret. Note this command cannot be used to reset + the secret for any other type of OAuth client in your project. EXAMPLES - To reset a Cloud OAuth client secret, run: + To reset a Cloud IAP OAuth client secret, run: $ gcloud alpha iap oauth-clients reset-secret NAME - To reset a Cloud OAuth client secret for a specific brand, run: + To reset a Cloud IAP OAuth client secret for a specific brand, run: $ gcloud alpha iap oauth-clients reset-secret NAME --brand=BRAND diff --git a/gcloud/alpha/iap/web/add-iam-policy-binding b/gcloud/alpha/iap/web/add-iam-policy-binding index e7a80bbe8..615ebedee 100644 --- a/gcloud/alpha/iap/web/add-iam-policy-binding +++ b/gcloud/alpha/iap/web/add-iam-policy-binding @@ -109,7 +109,7 @@ OPTIONAL FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, iap_gateway. + app-engine, backend-services. --region=REGION Region name. Should only be specified with diff --git a/gcloud/alpha/iap/web/get-iam-policy b/gcloud/alpha/iap/web/get-iam-policy index 5d77007d5..f6397d594 100644 --- a/gcloud/alpha/iap/web/get-iam-policy +++ b/gcloud/alpha/iap/web/get-iam-policy @@ -60,7 +60,7 @@ EXAMPLES FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, iap_gateway. + app-engine, backend-services. --region=REGION Region name. Should only be specified with diff --git a/gcloud/alpha/iap/web/remove-iam-policy-binding b/gcloud/alpha/iap/web/remove-iam-policy-binding index 6c05a31dc..0457a0b33 100644 --- a/gcloud/alpha/iap/web/remove-iam-policy-binding +++ b/gcloud/alpha/iap/web/remove-iam-policy-binding @@ -125,7 +125,7 @@ OPTIONAL FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, iap_gateway. + app-engine, backend-services. --region=REGION Region name. Should only be specified with diff --git a/gcloud/alpha/iap/web/set-iam-policy b/gcloud/alpha/iap/web/set-iam-policy index 76a18d092..79289d63e 100644 --- a/gcloud/alpha/iap/web/set-iam-policy +++ b/gcloud/alpha/iap/web/set-iam-policy @@ -68,7 +68,7 @@ POSITIONAL ARGUMENTS FLAGS --resource-type=RESOURCE_TYPE Resource type of the IAP resource. RESOURCE_TYPE must be one of: - app-engine, backend-services, iap_gateway. + app-engine, backend-services. --region=REGION Region name. Should only be specified with diff --git a/gcloud/alpha/identity/groups/config/export b/gcloud/alpha/identity/groups/config/export index 6f27acba9..34056a258 100644 --- a/gcloud/alpha/identity/groups/config/export +++ b/gcloud/alpha/identity/groups/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/ids/endpoints/update b/gcloud/alpha/ids/endpoints/update index f1df850ff..9518b32c9 100644 --- a/gcloud/alpha/ids/endpoints/update +++ b/gcloud/alpha/ids/endpoints/update @@ -78,5 +78,9 @@ 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. + access allowlist. These variants are also available: + + $ gcloud ids endpoints update + + $ gcloud beta ids endpoints update diff --git a/gcloud/alpha/immersive-stream/xr/contents/build b/gcloud/alpha/immersive-stream/xr/contents/build index e618fb947..f5a41c082 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/build +++ b/gcloud/alpha/immersive-stream/xr/contents/build @@ -12,8 +12,8 @@ DESCRIPTION user specified version tag. EXAMPLES - To build a content resource 'my-content' tagged with version tag - 'my-version', run: + To build a content resource my-content tagged with version tag my-version, + run: $ gcloud alpha immersive-stream xr contents build my-content \ --version=my-version diff --git a/gcloud/alpha/immersive-stream/xr/contents/create b/gcloud/alpha/immersive-stream/xr/contents/create index 916b98690..e577a94d2 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/create +++ b/gcloud/alpha/immersive-stream/xr/contents/create @@ -11,8 +11,8 @@ DESCRIPTION (ALPHA) Create an Immersive Stream for XR content resource. EXAMPLES - To create a content resource called 'my-content' using Cloud Storage bucket - 'my-bucket', run: + To create a content resource called my-content using Cloud Storage bucket + my-bucket, run: $ gcloud alpha immersive-stream xr contents create my-content \ --bucket=my-bucket diff --git a/gcloud/alpha/immersive-stream/xr/contents/delete b/gcloud/alpha/immersive-stream/xr/contents/delete index 7075caed5..fe1fbd923 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/delete +++ b/gcloud/alpha/immersive-stream/xr/contents/delete @@ -10,7 +10,7 @@ DESCRIPTION (ALPHA) Delete an Immersive Stream for XR content resource. EXAMPLES - To delete a content called 'my-content', run: + To delete a content called my-content, run: $ gcloud alpha immersive-stream xr contents delete my-content diff --git a/gcloud/alpha/immersive-stream/xr/contents/update b/gcloud/alpha/immersive-stream/xr/contents/update index 3eadbd737..e75af8da6 100644 --- a/gcloud/alpha/immersive-stream/xr/contents/update +++ b/gcloud/alpha/immersive-stream/xr/contents/update @@ -4,24 +4,19 @@ NAME SYNOPSIS gcloud alpha immersive-stream xr contents update - (CONTENT : --location=LOCATION) (--bucket=BUCKET | --uiconfig) - [--async] [GCLOUD_WIDE_FLAG ...] + (CONTENT : --location=LOCATION) --bucket=BUCKET [--async] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update an Immersive Stream for XR content resource. EXAMPLES - To update the Cloud Storage bucket used by the content resource - 'my-content', to 'my-new-bucket' run: + To update the Cloud Storage bucket used by the content resource my-content, + to my-new-bucket run: $ gcloud alpha immersive-stream xr contents update my-content \ --bucket=my-new-bucket - To trigger an update to the UI configuration, run: - - $ gcloud alpha immersive-stream xr contents update my-content \ - --uiconfig - POSITIONAL ARGUMENTS Content resource - Immersive Stream for XR content resource to be updated. The arguments in this group can be used to specify the attributes of this @@ -50,14 +45,9 @@ POSITIONAL ARGUMENTS ▸ global is the only supported location. REQUIRED FLAGS - Exactly one of these must be specified: - - --bucket=BUCKET - The name of the Cloud Storage bucket in the consumer project that - stores the content source. - - --uiconfig - Boolean flag indicating that the update call is for UI configuration. + --bucket=BUCKET + The name of the Cloud Storage bucket in the consumer project that + stores the content source. OPTIONAL FLAGS --async diff --git a/gcloud/alpha/immersive-stream/xr/instances/create b/gcloud/alpha/immersive-stream/xr/instances/create index 523e72db7..72328afe8 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/create +++ b/gcloud/alpha/immersive-stream/xr/instances/create @@ -6,22 +6,33 @@ SYNOPSIS gcloud alpha immersive-stream xr instances create INSTANCE --add-region=[capacity=CAPACITY],[region=REGION] --version=VERSION (--content=CONTENT : --location=LOCATION) [--async] - [GCLOUD_WIDE_FLAG ...] + [--fallback-url=FALLBACK_URL] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create an Immersive Stream for XR service instance. EXAMPLES - To create a service instance called 'my-instance' serving content - 'my-content' with version 'my-version' that has availablilty for 2 - concurent sessions in us-west1 region and 3 concurrent sessions in us-east4 - region, run: + To create a service instance called my-instance serving content my-content + with version my-version that has availablilty for 2 concurent sessions in + us-west1 region and 3 concurrent sessions in us-east4 region, run: $ gcloud alpha immersive-stream xr instances create my-instance \ --content=my-content --version=my-version \ --add-region=region=us-west1,capacity=2 \ --add-region=region=us-east4,capacity=3 + Optionally, a fallback url may be specified. Users will be redirected to + this fallback url when the service instance is unable to provide the + streaming experience. To create a service instance called my-instance + serving content my-content with version my-version that has availablilty + for 2 concurent sessions in us-west1 and uses fallback url + https://www.google.com run: + + $ gcloud alpha immersive-stream xr instances create my-instance \ + --content=my-content --version=my-version \ + --add-region=region=us-west1,capacity=2 \ + --fallback-url="https://www.google.com" + POSITIONAL ARGUMENTS INSTANCE Name of the instance to be created @@ -72,6 +83,10 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --fallback-url=FALLBACK_URL + Fallback url to redirect users to when this service instance is unable + to provide the streaming experience + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/immersive-stream/xr/instances/delete b/gcloud/alpha/immersive-stream/xr/instances/delete index 4082a6c41..507cf9ea6 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/delete +++ b/gcloud/alpha/immersive-stream/xr/instances/delete @@ -10,7 +10,7 @@ DESCRIPTION (ALPHA) Delete an Immersive Stream for XR service instance. EXAMPLES - To delete a service instance called 'my-instance', run: + To delete a service instance called my-instance, run: $ gcloud alpha immersive-stream xr instances delete my-instance diff --git a/gcloud/alpha/immersive-stream/xr/instances/update b/gcloud/alpha/immersive-stream/xr/instances/update index b4d172a77..690a01de5 100644 --- a/gcloud/alpha/immersive-stream/xr/instances/update +++ b/gcloud/alpha/immersive-stream/xr/instances/update @@ -5,30 +5,53 @@ NAME SYNOPSIS gcloud alpha immersive-stream xr instances update (INSTANCE : --location=LOCATION) - (--update-region=[capacity=CAPACITY],[region=REGION] + (--add-region=[capacity=CAPACITY],[region=REGION] + | --fallback-url=FALLBACK_URL | --remove-region=REMOVE_REGION + | --update-region=[capacity=CAPACITY],[region=REGION] | --version=VERSION) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update an Immersive Stream for XR service instance. This command - can either be used to update the capacity for an existing region of the - service instance or to update the content build version served by the - instance. If updating the capacity, only one region may be updated for each - command execution, and the new capacity may not be 0 or exceed the quota - limit. + can be used to update one of the following: + ▪ the capacity for an existing region of the service instance + ▪ the content build version served by the instance + ▪ the fallback url to redirect users to when the service instance is + unable to provide the streaming experience + + If updating the capacity, only one region may be updated for each command + execution, and the new capacity may not be 0 or exceed the quota limit. EXAMPLES - To update the service instance 'my-instance' to have capacity 2 for region - us-west1, run: + To update the service instance my-instance to have capacity 2 for an + existing region us-west1, run: $ gcloud alpha immersive-stream xr instances update my-instance \ --update-region=region=us-west1,capacity=2 - To update the service instance 'my-instance' to serve content build version - 'my-version', run: + To update the service instance my-instance to have capacity 1 for a new + region us-east4, run: + + $ gcloud alpha immersive-stream xr instances update my-instance \ + --add-region=region=us-east4,capacity=1 + + To update the service instance my-instance to remove the existing region + us-east4, run: + + $ gcloud alpha immersive-stream xr instances update my-instance \ + --remove-region=us-east4 + + To update the service instance my-instance to serve content version + my-version, run: $ gcloud alpha immersive-stream xr instances update my-instance \ --version=my-version + To update the service instance my-instance to use fallback url + https://www.google.com, run: + + $ gcloud alpha immersive-stream xr instances update my-instance \ + --fallback-url="https://www.google.com" + POSITIONAL ARGUMENTS Instance resource - Immersive Stream for XR service instance to update. The arguments in this group can be used to specify the attributes of this @@ -62,6 +85,22 @@ REQUIRED FLAGS Exactly one of these must be specified: + --add-region=[capacity=CAPACITY],[region=REGION] + Flag used to specify region and capacity required for the service + instance's availability. + + 'region' is the region in which the instance is deployed. + + 'capacity' is the maxium number of concurrent streaming sessions that + the instance can support in the given region. + + --fallback-url=FALLBACK_URL + Fallback url to redirect users to when this service instance is + unable to provide the streaming experience + + --remove-region=REMOVE_REGION + Region to remove + --update-region=[capacity=CAPACITY],[region=REGION] Flag used to specify region and capacity required for the service instance's availability. diff --git a/gcloud/alpha/immersive-stream/xr/operations/describe b/gcloud/alpha/immersive-stream/xr/operations/describe index b7f9d4458..3e8d04da7 100644 --- a/gcloud/alpha/immersive-stream/xr/operations/describe +++ b/gcloud/alpha/immersive-stream/xr/operations/describe @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES To get information about a long-running operation with name - 'projects/my-project/locations/global/operations/operation-123', run the + projects/my-project/locations/global/operations/operation-123, run the following command: $ gcloud alpha immersive-stream xr operations describe \ diff --git a/gcloud/alpha/immersive-stream/xr/operations/wait b/gcloud/alpha/immersive-stream/xr/operations/wait index 8b50c9fee..f8945c0fa 100644 --- a/gcloud/alpha/immersive-stream/xr/operations/wait +++ b/gcloud/alpha/immersive-stream/xr/operations/wait @@ -13,7 +13,7 @@ DESCRIPTION EXAMPLES To poll a long-running Immersive Stream for XR operation named - 'projects/my-project/locations/global/operations/operation-123' until it + projects/my-project/locations/global/operations/operation-123 until it completes, run the following: $ gcloud alpha immersive-stream xr operations wait \ diff --git a/gcloud/alpha/kms/help b/gcloud/alpha/kms/help index 5ab1487cc..e032189d3 100644 --- a/gcloud/alpha/kms/help +++ b/gcloud/alpha/kms/help @@ -34,6 +34,9 @@ GROUPS import-jobs (ALPHA) Create and manage import jobs. + inventory + (ALPHA) Manages the KMS Inventory and Key Tracking commands. + keyrings (ALPHA) Create and manage keyrings. diff --git a/gcloud/alpha/kms/inventory/get-protected-resources-summary b/gcloud/alpha/kms/inventory/get-protected-resources-summary new file mode 100644 index 000000000..ef5a1205f --- /dev/null +++ b/gcloud/alpha/kms/inventory/get-protected-resources-summary @@ -0,0 +1,57 @@ +NAME + gcloud alpha kms inventory get-protected-resources-summary - gets the + protected resources summary + +SYNOPSIS + gcloud alpha kms inventory get-protected-resources-summary + (--keyname=KEYNAME : --keyring=KEYRING --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Gets the protected resources summary. + +REQUIRED FLAGS + Key resource - The KMS key resource. 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 --keyname on the command line with a fully + specified name; + ◆ set the property core/project. + + This must be specified. + + --keyname=KEYNAME + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument --keyname on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --keyring=KEYRING + The KMS keyring of the key. To set the keyring attribute: + ▸ provide the argument --keyname on the command line with a fully + specified name; + ▸ provide the argument --keyring on the command line. + + --location=LOCATION + The Cloud location for the key. To set the location attribute: + ▸ provide the argument --keyname on the command line with a fully + specified name; + ▸ provide the argument --location 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. + diff --git a/gcloud/alpha/kms/inventory/help b/gcloud/alpha/kms/inventory/help new file mode 100644 index 000000000..f4846633a --- /dev/null +++ b/gcloud/alpha/kms/inventory/help @@ -0,0 +1,33 @@ +NAME + gcloud alpha kms inventory - manages the KMS Inventory and Key Tracking + commands + +SYNOPSIS + gcloud alpha kms inventory COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manages the KMS Inventory and Key Tracking commands. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + get-protected-resources-summary + (ALPHA) Gets the protected resources summary. + + list-keys + (ALPHA) Lists the keys in a project. + + search-protected-resources + (ALPHA) Searches the resources protected by a key. + +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. + diff --git a/gcloud/alpha/kms/inventory/list-keys b/gcloud/alpha/kms/inventory/list-keys new file mode 100644 index 000000000..5a6d75605 --- /dev/null +++ b/gcloud/alpha/kms/inventory/list-keys @@ -0,0 +1,57 @@ +NAME + gcloud alpha kms inventory list-keys - lists the keys in a project + +SYNOPSIS + gcloud alpha kms inventory list-keys [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Lists the keys in a project. + +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 + 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. + diff --git a/gcloud/alpha/kms/inventory/search-protected-resources b/gcloud/alpha/kms/inventory/search-protected-resources new file mode 100644 index 000000000..8c28b6e0a --- /dev/null +++ b/gcloud/alpha/kms/inventory/search-protected-resources @@ -0,0 +1,94 @@ +NAME + gcloud alpha kms inventory search-protected-resources - searches the + resources protected by a key + +SYNOPSIS + gcloud alpha kms inventory search-protected-resources + --scope=ORGANIZATION_ID + (--keyname=KEYNAME : --keyring=KEYRING --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Searches the resources protected by a key. + +REQUIRED FLAGS + --scope=ORGANIZATION_ID + Organization ID. + + Key resource - The KMS key resource. 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 --keyname on the command line with a fully + specified name; + ◆ set the property core/project. + + This must be specified. + + --keyname=KEYNAME + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument --keyname on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --keyring=KEYRING + The KMS keyring of the key. To set the keyring attribute: + ▸ provide the argument --keyname on the command line with a fully + specified name; + ▸ provide the argument --keyring on the command line. + + --location=LOCATION + The Cloud location for the key. To set the location attribute: + ▸ provide the argument --keyname on the command line with a fully + specified name; + ▸ provide the argument --location 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. + +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. + diff --git a/gcloud/alpha/kms/keyrings/config/export b/gcloud/alpha/kms/keyrings/config/export index 7f68a8f32..555e318c9 100644 --- a/gcloud/alpha/kms/keyrings/config/export +++ b/gcloud/alpha/kms/keyrings/config/export @@ -78,7 +78,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/kms/keys/config/export b/gcloud/alpha/kms/keys/config/export index 9a63b9abf..ed25223df 100644 --- a/gcloud/alpha/kms/keys/config/export +++ b/gcloud/alpha/kms/keys/config/export @@ -85,7 +85,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/kms/keys/create b/gcloud/alpha/kms/keys/create index bbac4c835..a288efe17 100644 --- a/gcloud/alpha/kms/keys/create +++ b/gcloud/alpha/kms/keys/create @@ -162,7 +162,8 @@ OPTIONAL FLAGS https://cloud.google.com/kms/docs/algorithms. DEFAULT_ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, external-symmetric-encryption, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/alpha/kms/keys/update b/gcloud/alpha/kms/keys/update index 36831686a..953b73d26 100644 --- a/gcloud/alpha/kms/keys/update +++ b/gcloud/alpha/kms/keys/update @@ -112,7 +112,8 @@ FLAGS https://cloud.google.com/kms/docs/algorithms. DEFAULT_ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, external-symmetric-encryption, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/alpha/kms/keys/versions/import b/gcloud/alpha/kms/keys/versions/import index 3ac762777..62bb38c9f 100644 --- a/gcloud/alpha/kms/keys/versions/import +++ b/gcloud/alpha/kms/keys/versions/import @@ -32,7 +32,8 @@ REQUIRED FLAGS about supported algorithms, see https://cloud.google.com/kms/docs/algorithms. ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/alpha/logging/buckets/create b/gcloud/alpha/logging/buckets/create index f97eafbe7..437d80a75 100644 --- a/gcloud/alpha/logging/buckets/create +++ b/gcloud/alpha/logging/buckets/create @@ -1,5 +1,5 @@ NAME - gcloud alpha logging buckets create - creates a bucket + gcloud alpha logging buckets create - create a bucket SYNOPSIS gcloud alpha logging buckets create BUCKET_ID --location=LOCATION diff --git a/gcloud/alpha/logging/buckets/delete b/gcloud/alpha/logging/buckets/delete index a69fd6d3f..e66593831 100644 --- a/gcloud/alpha/logging/buckets/delete +++ b/gcloud/alpha/logging/buckets/delete @@ -24,16 +24,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a bucket associated with this billing account. + Billing account of the bucket to delete. --folder=FOLDER_ID - Delete a bucket associated with this folder. + Folder of the bucket to delete. --organization=ORGANIZATION_ID - Delete a bucket associated with this organization. + Organization of the bucket to delete. --project=PROJECT_ID - Delete a bucket associated with this project. + Project of the bucket to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/buckets/describe b/gcloud/alpha/logging/buckets/describe index 3647ac024..95f2028e3 100644 --- a/gcloud/alpha/logging/buckets/describe +++ b/gcloud/alpha/logging/buckets/describe @@ -1,5 +1,5 @@ NAME - gcloud alpha logging buckets describe - displays information about a bucket + gcloud alpha logging buckets describe - display information about a bucket SYNOPSIS gcloud alpha logging buckets describe BUCKET_ID --location=LOCATION @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Displays information about a bucket. + (ALPHA) Display information about a bucket. EXAMPLES To describe a bucket in a project, run: @@ -27,16 +27,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a bucket associated with this billing account. + Billing account of the bucket to describe. --folder=FOLDER_ID - Describe a bucket associated with this folder. + Folder of the bucket to describe. --organization=ORGANIZATION_ID - Describe a bucket associated with this organization. + Organization of the bucket to describe. --project=PROJECT_ID - Describe a bucket associated with this project. + Project of the bucket to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/buckets/help b/gcloud/alpha/logging/buckets/help index da91ad3b6..aa0be343f 100644 --- a/gcloud/alpha/logging/buckets/help +++ b/gcloud/alpha/logging/buckets/help @@ -18,22 +18,22 @@ COMMANDS COMMAND is one of the following: create - (ALPHA) Creates a bucket. + (ALPHA) Create a bucket. delete (ALPHA) Delete a bucket. describe - (ALPHA) Displays information about a bucket. + (ALPHA) Display information about a bucket. list - (ALPHA) Lists the defined buckets. + (ALPHA) List the defined buckets. undelete (ALPHA) Undelete a bucket. update - (ALPHA) Updates a bucket. + (ALPHA) Update a bucket. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/logging/buckets/list b/gcloud/alpha/logging/buckets/list index 7b8ee98f4..5f35bf03b 100644 --- a/gcloud/alpha/logging/buckets/list +++ b/gcloud/alpha/logging/buckets/list @@ -1,5 +1,5 @@ NAME - gcloud alpha logging buckets list - lists the defined buckets + gcloud alpha logging buckets list - list the defined buckets SYNOPSIS gcloud alpha logging buckets list [--location=LOCATION] @@ -9,7 +9,7 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Lists the buckets for a project. + (ALPHA) List the buckets for a project. EXAMPLES To list the buckets in a project, run: @@ -24,16 +24,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List buckets associated with this billing account. + Billing account of the buckets to list. --folder=FOLDER_ID - List buckets associated with this folder. + Folder of the buckets to list. --organization=ORGANIZATION_ID - List buckets associated with this organization. + Organization of the buckets to list. --project=PROJECT_ID - List buckets associated with this project. + Project of the buckets to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/buckets/undelete b/gcloud/alpha/logging/buckets/undelete index f17f40307..296595d2b 100644 --- a/gcloud/alpha/logging/buckets/undelete +++ b/gcloud/alpha/logging/buckets/undelete @@ -24,16 +24,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Undelete a bucket associated with this billing account. + Billing account of the bucket to undelete. --folder=FOLDER_ID - Undelete a bucket associated with this folder. + Folder of the bucket to undelete. --organization=ORGANIZATION_ID - Undelete a bucket associated with this organization. + Organization of the bucket to undelete. --project=PROJECT_ID - Undelete a bucket associated with this project. + Project of the bucket to undelete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/buckets/update b/gcloud/alpha/logging/buckets/update index d58b2bced..2024d51d1 100644 --- a/gcloud/alpha/logging/buckets/update +++ b/gcloud/alpha/logging/buckets/update @@ -1,5 +1,5 @@ NAME - gcloud alpha logging buckets update - updates a bucket + gcloud alpha logging buckets update - update a bucket SYNOPSIS gcloud alpha logging buckets update BUCKET_ID --location=LOCATION @@ -11,7 +11,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Updates the properties of a bucket. + (ALPHA) Update the properties of a bucket. EXAMPLES To update a bucket in your project, run: diff --git a/gcloud/alpha/logging/copy b/gcloud/alpha/logging/copy index 1c9d685c5..bec129b8a 100644 --- a/gcloud/alpha/logging/copy +++ b/gcloud/alpha/logging/copy @@ -44,16 +44,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Copy log entries associated with this billing account. + Billing account of the log entries to copy. --folder=FOLDER_ID - Copy log entries associated with this folder. + Folder of the log entries to copy. --organization=ORGANIZATION_ID - Copy log entries associated with this organization. + Organization of the log entries to copy. --project=PROJECT_ID - Copy log entries associated with this project. + Project of the log entries to copy. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/locations/describe b/gcloud/alpha/logging/locations/describe index 36b31e991..035c08fdb 100644 --- a/gcloud/alpha/logging/locations/describe +++ b/gcloud/alpha/logging/locations/describe @@ -24,16 +24,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a location associated with this billing account. + Billing account of the location to describe. --folder=FOLDER_ID - Describe a location associated with this folder. + Folder of the location to describe. --organization=ORGANIZATION_ID - Describe a location associated with this organization. + Organization of the location to describe. --project=PROJECT_ID - Describe a location associated with this project. + Project of the location to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/locations/list b/gcloud/alpha/logging/locations/list index 866d6d69d..b7fd2a99d 100644 --- a/gcloud/alpha/logging/locations/list +++ b/gcloud/alpha/logging/locations/list @@ -20,16 +20,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List locations associated with this billing account. + Billing account of the locations to list. --folder=FOLDER_ID - List locations associated with this folder. + Folder of the locations to list. --organization=ORGANIZATION_ID - List locations associated with this organization. + Organization of the locations to list. --project=PROJECT_ID - List locations associated with this project. + Project of the locations to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/logs/delete b/gcloud/alpha/logging/logs/delete index 04925e621..0273b48c5 100644 --- a/gcloud/alpha/logging/logs/delete +++ b/gcloud/alpha/logging/logs/delete @@ -1,16 +1,17 @@ NAME - gcloud alpha logging logs delete - deletes all entries from a log + gcloud alpha logging logs delete - delete all entries from a log in the + _Default log bucket SYNOPSIS gcloud alpha logging logs delete LOG_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Deletes all entries from a log. With no entries, the log will not - appear in the list of your project's logs. However, you can write new - entries to the log. + (ALPHA) Delete all entries from a log in the _Default log bucket. With no + entries, the log will not appear in the list of your project's logs. + However, you can write new entries to the log. EXAMPLES - To delete all entries from log 'my-log': + To delete all entries from log 'my-log' in the _Default log bucket: $ gcloud alpha logging logs delete my-log diff --git a/gcloud/alpha/logging/logs/help b/gcloud/alpha/logging/logs/help index dea43b5f1..682afc2fa 100644 --- a/gcloud/alpha/logging/logs/help +++ b/gcloud/alpha/logging/logs/help @@ -16,10 +16,10 @@ COMMANDS COMMAND is one of the following: delete - (ALPHA) Deletes all entries from a log. + (ALPHA) Delete all entries from a log in the _Default log bucket. list - (ALPHA) Lists your project's logs. + (ALPHA) List your project's logs. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/logging/logs/list b/gcloud/alpha/logging/logs/list index 6594e718f..033149cd2 100644 --- a/gcloud/alpha/logging/logs/list +++ b/gcloud/alpha/logging/logs/list @@ -1,5 +1,5 @@ NAME - gcloud alpha logging logs list - lists your project's logs + gcloud alpha logging logs list - list your project's logs SYNOPSIS gcloud alpha logging logs list diff --git a/gcloud/alpha/logging/metrics/create b/gcloud/alpha/logging/metrics/create index fe492c034..1c3834a6a 100644 --- a/gcloud/alpha/logging/metrics/create +++ b/gcloud/alpha/logging/metrics/create @@ -1,5 +1,5 @@ NAME - gcloud alpha logging metrics create - creates a logs-based metric + gcloud alpha logging metrics create - create a logs-based metric SYNOPSIS gcloud alpha logging metrics create METRIC_NAME @@ -8,7 +8,7 @@ SYNOPSIS : --bucket-name=BUCKET_NAME]) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Creates a logs-based metric to count the number of log entries that + (ALPHA) Create a logs-based metric to count the number of log entries that match a filter expression. Logs-based metrics can also be used to extract values from logs and create a distribution of the values. diff --git a/gcloud/alpha/logging/metrics/delete b/gcloud/alpha/logging/metrics/delete index aaad9ce0f..41684ff2f 100644 --- a/gcloud/alpha/logging/metrics/delete +++ b/gcloud/alpha/logging/metrics/delete @@ -1,11 +1,11 @@ NAME - gcloud alpha logging metrics delete - deletes a logs-based metric + gcloud alpha logging metrics delete - delete a logs-based metric SYNOPSIS gcloud alpha logging metrics delete METRIC_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Deletes a logs-based metric called high_severity_count. + (ALPHA) Delete a logs-based metric called high_severity_count. EXAMPLES To delete a metric called high_severity_count, run: diff --git a/gcloud/alpha/logging/metrics/describe b/gcloud/alpha/logging/metrics/describe index 206f4e315..156f1e9c9 100644 --- a/gcloud/alpha/logging/metrics/describe +++ b/gcloud/alpha/logging/metrics/describe @@ -1,12 +1,12 @@ NAME - gcloud alpha logging metrics describe - shows the definition of a + gcloud alpha logging metrics describe - display the definition of a logs-based metric SYNOPSIS gcloud alpha logging metrics describe METRIC_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Shows the definition of a logs-based metric. + (ALPHA) Show the definition of a logs-based metric. EXAMPLES To show the definition of a metric called high_severity_count, run: diff --git a/gcloud/alpha/logging/metrics/help b/gcloud/alpha/logging/metrics/help index 326bf5e6a..e89d2f5dc 100644 --- a/gcloud/alpha/logging/metrics/help +++ b/gcloud/alpha/logging/metrics/help @@ -16,19 +16,19 @@ COMMANDS COMMAND is one of the following: create - (ALPHA) Creates a logs-based metric. + (ALPHA) Create a logs-based metric. delete - (ALPHA) Deletes a logs-based metric. + (ALPHA) Delete a logs-based metric. describe - (ALPHA) Shows the definition of a logs-based metric. + (ALPHA) Display the definition of a logs-based metric. list - (ALPHA) Displays all logs-based metrics. + (ALPHA) Display all logs-based metrics. update - (ALPHA) Updates the definition of a logs-based metric. + (ALPHA) Update the definition of a logs-based metric. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/logging/metrics/list b/gcloud/alpha/logging/metrics/list index 01f7b95f5..f1554c3d0 100644 --- a/gcloud/alpha/logging/metrics/list +++ b/gcloud/alpha/logging/metrics/list @@ -1,5 +1,5 @@ NAME - gcloud alpha logging metrics list - displays all logs-based metrics + gcloud alpha logging metrics list - display all logs-based metrics SYNOPSIS gcloud alpha logging metrics list [--filter=EXPRESSION] [--limit=LIMIT] diff --git a/gcloud/alpha/logging/metrics/update b/gcloud/alpha/logging/metrics/update index da0124d91..4c1c10464 100644 --- a/gcloud/alpha/logging/metrics/update +++ b/gcloud/alpha/logging/metrics/update @@ -1,6 +1,6 @@ NAME - gcloud alpha logging metrics update - updates the definition of a - logs-based metric + gcloud alpha logging metrics update - update the definition of a logs-based + metric SYNOPSIS gcloud alpha logging metrics update METRIC_NAME @@ -9,7 +9,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Updates the description or the filter expression of an existing + (ALPHA) Update the description or the filter expression of an existing logs-based metric. EXAMPLES diff --git a/gcloud/alpha/logging/operations/cancel b/gcloud/alpha/logging/operations/cancel index 8de4540c0..5a5de7647 100644 --- a/gcloud/alpha/logging/operations/cancel +++ b/gcloud/alpha/logging/operations/cancel @@ -30,16 +30,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Cancel operation associated with this billing account. + Billing account of the operation to cancel. --folder=FOLDER_ID - Cancel operation associated with this folder. + Folder of the operation to cancel. --organization=ORGANIZATION_ID - Cancel operation associated with this organization. + Organization of the operation to cancel. --project=PROJECT_ID - Cancel operation associated with this project. + Project of the operation to cancel. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/operations/describe b/gcloud/alpha/logging/operations/describe index 8f65e10da..3b665fd8a 100644 --- a/gcloud/alpha/logging/operations/describe +++ b/gcloud/alpha/logging/operations/describe @@ -1,6 +1,6 @@ NAME - gcloud alpha logging operations describe - describe a long running - operation + gcloud alpha logging operations describe - display the information about a + long running operation SYNOPSIS gcloud alpha logging operations describe OPERATION_ID --location=LOCATION @@ -9,10 +9,11 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Describe a long running operation which was scheduled before. For - example, a copy_log_entries operation scheduled by command: "gcloud alpha - logging copy BUCKET_ID DESTINATION --location=LOCATION" OPERATION_ID and - LOCATION are required to locate such operation. + (ALPHA) Display the information about a long running operation which was + scheduled before. For example, a copy_log_entries operation scheduled by + command: "gcloud alpha logging copy BUCKET_ID DESTINATION + --location=LOCATION" OPERATION_ID and LOCATION are required to locate such + operation. EXAMPLES To describe an operation, run: @@ -32,16 +33,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe operation associated with this billing account. + Billing account of the operation to describe. --folder=FOLDER_ID - Describe operation associated with this folder. + Folder of the operation to describe. --organization=ORGANIZATION_ID - Describe operation associated with this organization. + Organization of the operation to describe. --project=PROJECT_ID - Describe operation associated with this project. + Project of the operation to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/operations/help b/gcloud/alpha/logging/operations/help index d99866cb6..69449302d 100644 --- a/gcloud/alpha/logging/operations/help +++ b/gcloud/alpha/logging/operations/help @@ -19,7 +19,7 @@ COMMANDS (ALPHA) Cancel a long running operation. describe - (ALPHA) Describe a long running operation. + (ALPHA) Display the information about a long running operation. list (ALPHA) List long running operations. diff --git a/gcloud/alpha/logging/operations/list b/gcloud/alpha/logging/operations/list index f58ce0160..6f5099cb1 100644 --- a/gcloud/alpha/logging/operations/list +++ b/gcloud/alpha/logging/operations/list @@ -62,16 +62,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List operations associated with this billing account. + Billing account of the operations to list. --folder=FOLDER_ID - List operations associated with this folder. + Folder of the operations to list. --organization=ORGANIZATION_ID - List operations associated with this organization. + Organization of the operations to list. --project=PROJECT_ID - List operations associated with this project. + Project of the operations to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/read b/gcloud/alpha/logging/read index 39971ed25..f9dcc368e 100644 --- a/gcloud/alpha/logging/read +++ b/gcloud/alpha/logging/read @@ -6,7 +6,8 @@ SYNOPSIS [--freshness=FRESHNESS; default="1d"] [--order=ORDER; default="desc"] [--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID | --organization=ORGANIZATION_ID | --project=PROJECT_ID] - [--bucket=BUCKET --location=LOCATION --view=VIEW] [--limit=LIMIT] + [--resource-names=[RESOURCE,...] + | --bucket=BUCKET --location=LOCATION --view=VIEW] [--limit=LIMIT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -49,13 +50,13 @@ EXAMPLES $ gcloud alpha logging read --bucket= \ --location=[LOCATION] --limit=1 - To read a log entry from the global Required log bucket using the bucket's - Default log view: + To read a log entry from the global _Required log bucket using the bucket's + _Default log view: $ gcloud alpha logging read "" --bucket=_Required \ --location=global --view=_Default --limit=1 - To read a log entry from a log bucket using the bucket's AllLogs log view: + To read a log entry from a log bucket using the bucket's _AllLogs log view: $ gcloud alpha logging read "" --bucket=[BUCKET_ID] \ --location=[LOCATION] --view=_AllLogs --limit=1 @@ -66,6 +67,15 @@ EXAMPLES $ gcloud alpha logging read "" --bucket=[BUCKET_ID] \ --location=[LOCATION] --view=[VIEW_ID] --limit=1 + To read log entries from multiple resources, specify them as a + comma-delimeted sequence with --resource-names. Each resource name can be + specified either as a top-level resource (e.g., projects/[PROJECT_ID], + folders/[FOLDER_ID], etc.) or as a Log View resource (e.g., + projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_NAME]/views/[VIEW_ID]). + + $ gcloud alpha logging read "" \ + --resource-names=[RESOURCE-1],[RESOURCE-2] + POSITIONAL ARGUMENTS [LOG_FILTER] Filter expression that specifies the log entries to return. Detailed @@ -85,16 +95,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Read log entries associated with this billing account. + Billing account of the log entries to read. --folder=FOLDER_ID - Read log entries associated with this folder. + Folder of the log entries to read. --organization=ORGANIZATION_ID - Read log entries associated with this organization. + Organization of the log entries to read. --project=PROJECT_ID - Read log entries associated with this project. + Project of the log entries to read. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be @@ -107,29 +117,38 @@ FLAGS and billing. To specify a different project for quota and billing, use --billing-project or billing/quota_project property. - These arguments are used in conjunction with the parent to construct a - view resource. + At most one of these can be specified: - --bucket=BUCKET - Id of the log bucket. If this argument is provided then --location - and --view must also be specified. + --resource-names=[RESOURCE,...] + Resource name(s) to read logs from. A resource can either be an + top-level resource (e.g., "projects/my-project") or a full log view + resource path (e.g., + "projects/my-project/locations/my-location/buckets/my-bucket/views/my-view"). + Multiple resources can be specified, separated by a comma. - This flag argument must be specified if any of the other arguments in - this group are specified. + These arguments are used in conjunction with the parent to construct a + view resource. - --location=LOCATION - Location of the log bucket. If this argument is provided then - --bucket and --view must also be specified. + --bucket=BUCKET + Id of the log bucket. If this argument is provided then --location + and --view must also be specified. - This flag argument must be specified if any of the other arguments in - this group are specified. + This flag argument must be specified if any of the other arguments + in this group are specified. - --view=VIEW - Id of the view. If this argument is provided then --location and - --bucket must also be specified. + --location=LOCATION + Location of the log bucket. If this argument is provided then + --bucket and --view must also be specified. - This flag argument must be specified if any of the other arguments in - this group are specified. + This flag argument must be specified if any of the other arguments + in this group are specified. + + --view=VIEW + Id of the view. If this argument is provided then --location and + --bucket must also be specified. + + This flag argument must be specified if any of the other arguments + in this group are specified. LIST COMMAND FLAGS --limit=LIMIT diff --git a/gcloud/alpha/logging/resource-descriptors/help b/gcloud/alpha/logging/resource-descriptors/help index 6249ee52d..5db3875b8 100644 --- a/gcloud/alpha/logging/resource-descriptors/help +++ b/gcloud/alpha/logging/resource-descriptors/help @@ -17,7 +17,7 @@ COMMANDS COMMAND is one of the following: list - (ALPHA) Lists all available resource descriptors. + (ALPHA) List all available resource descriptors. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/logging/resource-descriptors/list b/gcloud/alpha/logging/resource-descriptors/list index 0358280bb..3e7c56cfe 100644 --- a/gcloud/alpha/logging/resource-descriptors/list +++ b/gcloud/alpha/logging/resource-descriptors/list @@ -1,5 +1,5 @@ NAME - gcloud alpha logging resource-descriptors list - lists all available + gcloud alpha logging resource-descriptors list - list all available resource descriptors SYNOPSIS @@ -7,7 +7,7 @@ SYNOPSIS [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Lists all available resource descriptors that are used by Cloud + (ALPHA) List all available resource descriptors that are used by Cloud Logging. Each log entry must be associated with a valid resource descriptor. diff --git a/gcloud/alpha/logging/settings/describe b/gcloud/alpha/logging/settings/describe index 6da9485b1..f5bde809a 100644 --- a/gcloud/alpha/logging/settings/describe +++ b/gcloud/alpha/logging/settings/describe @@ -1,6 +1,6 @@ NAME - gcloud alpha logging settings describe - displays the settings for the - Cloud Logging Logs Router + gcloud alpha logging settings describe - display the settings for the Cloud + Logging Logs Router SYNOPSIS gcloud alpha logging settings describe @@ -33,16 +33,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe settings associated with this billing account. + Billing account of the settings to describe. --folder=FOLDER_ID - Describe settings associated with this folder. + Folder of the settings to describe. --organization=ORGANIZATION_ID - Describe settings associated with this organization. + Organization of the settings to describe. --project=PROJECT_ID - Describe settings associated with this project. + Project of the settings to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/settings/help b/gcloud/alpha/logging/settings/help index c274c25db..8e5ae6a4a 100644 --- a/gcloud/alpha/logging/settings/help +++ b/gcloud/alpha/logging/settings/help @@ -17,10 +17,10 @@ COMMANDS COMMAND is one of the following: describe - (ALPHA) Displays the settings for the Cloud Logging Logs Router. + (ALPHA) Display the settings for the Cloud Logging Logs Router. update - (ALPHA) Updates the settings for the Cloud Logging Logs Router. + (ALPHA) Update the settings for the Cloud Logging Logs Router. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/logging/settings/update b/gcloud/alpha/logging/settings/update index 76d519c7c..03408ea87 100644 --- a/gcloud/alpha/logging/settings/update +++ b/gcloud/alpha/logging/settings/update @@ -1,5 +1,5 @@ NAME - gcloud alpha logging settings update - updates the settings for the Cloud + gcloud alpha logging settings update - update the settings for the Cloud Logging Logs Router SYNOPSIS @@ -69,13 +69,13 @@ REQUIRED FLAGS OPTIONAL FLAGS --disable-default-sink - Enable or disable Default sink for the Default bucket. Specify - --no-disable-default-sink to enable a disabled Default sink. Note: It + Enable or disable _Default sink for the _Default bucket. Specify + --no-disable-default-sink to enable a disabled _Default sink. Note: It only applies to the newly created projects and will not affect the projects created before. --storage-location=STORAGE_LOCATION - Update the storage location for Default bucket and Required bucket. + Update the storage location for _Default bucket and _Required bucket. Note: It only applies to the newly created projects and will not affect the projects created before. diff --git a/gcloud/alpha/logging/sinks/create b/gcloud/alpha/logging/sinks/create index 1b14a4650..61d4d919b 100644 --- a/gcloud/alpha/logging/sinks/create +++ b/gcloud/alpha/logging/sinks/create @@ -124,16 +124,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Create a sink associated with this billing account. + Billing account of the sink to create. --folder=FOLDER_ID - Create a sink associated with this folder. + Folder of the sink to create. --organization=ORGANIZATION_ID - Create a sink associated with this organization. + Organization of the sink to create. --project=PROJECT_ID - Create a sink associated with this project. + Project of the sink to create. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/sinks/delete b/gcloud/alpha/logging/sinks/delete index 07c6008f5..eee1a6fa4 100644 --- a/gcloud/alpha/logging/sinks/delete +++ b/gcloud/alpha/logging/sinks/delete @@ -1,5 +1,5 @@ NAME - gcloud alpha logging sinks delete - deletes a sink + gcloud alpha logging sinks delete - delete a sink SYNOPSIS gcloud alpha logging sinks delete SINK_NAME @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Deletes a sink and halts the export of log entries associated with + (ALPHA) Delete a sink and halt the export of log entries associated with that sink. Deleting a sink does not affect log entries already exported through the deleted sink, and will not affect other sinks that are exporting the same log(s). @@ -26,16 +26,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a sink associated with this billing account. + Billing account of the sink to delete. --folder=FOLDER_ID - Delete a sink associated with this folder. + Folder of the sink to delete. --organization=ORGANIZATION_ID - Delete a sink associated with this organization. + Organization of the sink to delete. --project=PROJECT_ID - Delete a sink associated with this project. + Project of the sink to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/sinks/describe b/gcloud/alpha/logging/sinks/describe index 28a277ee3..566378dbd 100644 --- a/gcloud/alpha/logging/sinks/describe +++ b/gcloud/alpha/logging/sinks/describe @@ -1,5 +1,5 @@ NAME - gcloud alpha logging sinks describe - displays information about a sink + gcloud alpha logging sinks describe - display information about a sink SYNOPSIS gcloud alpha logging sinks describe SINK_NAME @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Displays information about a sink. + (ALPHA) Display information about a sink. EXAMPLES To describe a sync 'my-bq-sync': @@ -23,16 +23,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a sink associated with this billing account. + Billing account of the sink to describe. --folder=FOLDER_ID - Describe a sink associated with this folder. + Folder of the sink to describe. --organization=ORGANIZATION_ID - Describe a sink associated with this organization. + Organization of the sink to describe. --project=PROJECT_ID - Describe a sink associated with this project. + Project of the sink to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/sinks/help b/gcloud/alpha/logging/sinks/help index 99331bde6..631536c26 100644 --- a/gcloud/alpha/logging/sinks/help +++ b/gcloud/alpha/logging/sinks/help @@ -20,16 +20,16 @@ COMMANDS (ALPHA) Creates a log sink. delete - (ALPHA) Deletes a sink. + (ALPHA) Delete a sink. describe - (ALPHA) Displays information about a sink. + (ALPHA) Display information about a sink. list - (ALPHA) Lists the defined sinks. + (ALPHA) List the defined sinks. update - (ALPHA) Updates a sink. + (ALPHA) Update a sink. NOTES This command is currently in alpha and might change without notice. If this diff --git a/gcloud/alpha/logging/sinks/list b/gcloud/alpha/logging/sinks/list index 90678b4a2..e52a1aab2 100644 --- a/gcloud/alpha/logging/sinks/list +++ b/gcloud/alpha/logging/sinks/list @@ -1,5 +1,5 @@ NAME - gcloud alpha logging sinks list - lists the defined sinks + gcloud alpha logging sinks list - list the defined sinks SYNOPSIS gcloud alpha logging sinks list @@ -9,7 +9,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Lists the defined sinks. + (ALPHA) List the defined sinks. EXAMPLES To list all defined sinks: @@ -20,16 +20,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List sinks associated with this billing account. + Billing account of the sinks to list. --folder=FOLDER_ID - List sinks associated with this folder. + Folder of the sinks to list. --organization=ORGANIZATION_ID - List sinks associated with this organization. + Organization of the sinks to list. --project=PROJECT_ID - List sinks associated with this project. + Project of the sinks to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/sinks/update b/gcloud/alpha/logging/sinks/update index a3d5310be..d58525b8e 100644 --- a/gcloud/alpha/logging/sinks/update +++ b/gcloud/alpha/logging/sinks/update @@ -1,5 +1,5 @@ NAME - gcloud alpha logging sinks update - updates a sink + gcloud alpha logging sinks update - update a sink SYNOPSIS gcloud alpha logging sinks update SINK_NAME [DESTINATION] @@ -16,7 +16,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Changes the [DESTINATION] or --log-filter associated with a sink. + (ALPHA) Change the [DESTINATION] or --log-filter associated with a sink. The new destination must already exist and Cloud Logging must have permission to write to it. @@ -123,16 +123,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Update a sink associated with this billing account. + Billing account of the sink to update. --folder=FOLDER_ID - Update a sink associated with this folder. + Folder of the sink to update. --organization=ORGANIZATION_ID - Update a sink associated with this organization. + Organization of the sink to update. --project=PROJECT_ID - Update a sink associated with this project. + Project of the sink to update. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/tail b/gcloud/alpha/logging/tail index 6380a1994..92fb2aa90 100644 --- a/gcloud/alpha/logging/tail +++ b/gcloud/alpha/logging/tail @@ -76,16 +76,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Tail log entries associated with this billing account. + Billing account of the log entries to tail. --folder=FOLDER_ID - Tail log entries associated with this folder. + Folder of the log entries to tail. --organization=ORGANIZATION_ID - Tail log entries associated with this organization. + Organization of the log entries to tail. --project=PROJECT_ID - Tail log entries associated with this project. + Project of the log entries to tail. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/views/create b/gcloud/alpha/logging/views/create index 678c164bb..291171061 100644 --- a/gcloud/alpha/logging/views/create +++ b/gcloud/alpha/logging/views/create @@ -37,16 +37,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Create view associated with this billing account. + Billing account of the view to create. --folder=FOLDER_ID - Create view associated with this folder. + Folder of the view to create. --organization=ORGANIZATION_ID - Create view associated with this organization. + Organization of the view to create. --project=PROJECT_ID - Create view associated with this project. + Project of the view to create. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/views/delete b/gcloud/alpha/logging/views/delete index d80031c28..8c9944270 100644 --- a/gcloud/alpha/logging/views/delete +++ b/gcloud/alpha/logging/views/delete @@ -32,16 +32,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a bucket associated with this billing account. + Billing account of the view to delete. --folder=FOLDER_ID - Delete a bucket associated with this folder. + Folder of the view to delete. --organization=ORGANIZATION_ID - Delete a bucket associated with this organization. + Organization of the view to delete. --project=PROJECT_ID - Delete a bucket associated with this project. + Project of the view to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/views/describe b/gcloud/alpha/logging/views/describe index f10648fbc..2bbf9e42f 100644 --- a/gcloud/alpha/logging/views/describe +++ b/gcloud/alpha/logging/views/describe @@ -32,16 +32,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a view associated with this billing account. + Billing account of the view to describe. --folder=FOLDER_ID - Describe a view associated with this folder. + Folder of the view to describe. --organization=ORGANIZATION_ID - Describe a view associated with this organization. + Organization of the view to describe. --project=PROJECT_ID - Describe a view associated with this project. + Project of the view to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/views/list b/gcloud/alpha/logging/views/list index cbcc0294b..6ebab760a 100644 --- a/gcloud/alpha/logging/views/list +++ b/gcloud/alpha/logging/views/list @@ -27,16 +27,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List views associated with this billing account. + Billing account of the views to list. --folder=FOLDER_ID - List views associated with this folder. + Folder of the views to list. --organization=ORGANIZATION_ID - List views associated with this organization. + Organization of the views to list. --project=PROJECT_ID - List views associated with this project. + Project of the views to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/views/update b/gcloud/alpha/logging/views/update index 6ea80f454..87e7cd23d 100644 --- a/gcloud/alpha/logging/views/update +++ b/gcloud/alpha/logging/views/update @@ -39,16 +39,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Update view associated with this billing account. + Billing account of the view to update. --folder=FOLDER_ID - Update view associated with this folder. + Folder of the view to update. --organization=ORGANIZATION_ID - Update view associated with this organization. + Organization of the view to update. --project=PROJECT_ID - Update view associated with this project. + Project of the view to update. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/logging/write b/gcloud/alpha/logging/write index d99be1ef8..efea17df0 100644 --- a/gcloud/alpha/logging/write +++ b/gcloud/alpha/logging/write @@ -54,16 +54,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Write log entries associated with this billing account. + Billing account of the log entries to write. --folder=FOLDER_ID - Write log entries associated with this folder. + Folder of the log entries to write. --organization=ORGANIZATION_ID - Write log entries associated with this organization. + Organization of the log entries to write. --project=PROJECT_ID - Write log entries associated with this project. + Project of the log entries to write. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/alpha/memcache/instances/config/export b/gcloud/alpha/memcache/instances/config/export index fbd5c2221..fc90c4e3e 100644 --- a/gcloud/alpha/memcache/instances/config/export +++ b/gcloud/alpha/memcache/instances/config/export @@ -82,7 +82,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/metastore/services/alter-metadata-resource-location b/gcloud/alpha/metastore/services/alter-metadata-resource-location new file mode 100644 index 000000000..43710a0f8 --- /dev/null +++ b/gcloud/alpha/metastore/services/alter-metadata-resource-location @@ -0,0 +1,94 @@ +NAME + gcloud alpha metastore services alter-metadata-resource-location - alter + metadata resource location + +SYNOPSIS + gcloud alpha metastore services alter-metadata-resource-location + (SERVICE : --location=LOCATION) --location_uri=LOCATION_URI + --resource_name=RESOURCE_NAME [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Alter metadata resource location from a Dataproc Metastore + service's underlying metadata store. + + If run asynchronously with --async, exits after printing one operation name + that can be used to poll the status of the creation via: + + gcloud metastore operations describe + +EXAMPLES + To alter metadata resource location with the resource_name + databases/{database_id} or databases/{database_id}/tables/{table_id} or and + location_uri in location us-central, run: + + $ gcloud alpha metastore services alter-metadata-resource-location \ + my-metastore-service --location=us-central1 \ + --resource_name=databases/my-db \ + --location_uri=gs://destination_bucket/destination_object + +POSITIONAL ARGUMENTS + Service resource - Arguments and flags that specify the resource and the + location you want to alter. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataproc Metastore service. + + If not specified, will use default metastore/location. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property metastore/location. + +REQUIRED FLAGS + --location_uri=LOCATION_URI + The new location URI for the metadata resource. + + --resource_name=RESOURCE_NAME + The relative metadata resource name in the following format. + databases/{database_id} or databases/{database_id}/tables/{table_id} or + databases/{database_id}/tables/{table_id}/partitions/{partition_id} + +OPTIONAL 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 metastore/v1alpha API. The full documentation for + this API can be found at: https://cloud.google.com/dataproc-metastore/docs + +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 metastore services alter-metadata-resource-location + diff --git a/gcloud/alpha/metastore/services/help b/gcloud/alpha/metastore/services/help index 27a9fe42f..708369fc9 100644 --- a/gcloud/alpha/metastore/services/help +++ b/gcloud/alpha/metastore/services/help @@ -37,6 +37,9 @@ COMMANDS add-iam-policy-binding (ALPHA) Add an IAM policy binding to a service. + alter-metadata-resource-location + (ALPHA) Alter metadata resource location. + create (ALPHA) Create a Dataproc Metastore service. @@ -52,6 +55,13 @@ COMMANDS list (ALPHA) List Dataproc Metastore services. + move-table-to-database + (ALPHA) Move table to another database. + + query-metadata + (ALPHA) Execute a SQL query against a Dataproc Metastore Service's + metadata. + remove-iam-policy-binding (ALPHA) Remove an IAM policy binding from a service. diff --git a/gcloud/alpha/metastore/services/move-table-to-database b/gcloud/alpha/metastore/services/move-table-to-database new file mode 100644 index 000000000..684db9168 --- /dev/null +++ b/gcloud/alpha/metastore/services/move-table-to-database @@ -0,0 +1,97 @@ +NAME + gcloud alpha metastore services move-table-to-database - move table to + another database + +SYNOPSIS + gcloud alpha metastore services move-table-to-database + (SERVICE : --location=LOCATION) + --destination_db_name=DESTINATION_DB_NAME + --source_db_name=SOURCE_DB_NAME --table_name=TABLE_NAME [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Move table to another database from a Dataproc Metastore service's + underlying metadata store. + + If run asynchronously with --async, exits after printing one operation name + that can be used to poll the status of the creation via: + + gcloud metastore operations describe + +EXAMPLES + To move table to database with the table_name, source_db_name, and + destination_db_name in location us-central, run: + + $ gcloud alpha metastore services move-table-to-database \ + my-metastore-service --location=us-central1 \ + --table_name=table_name_to_move \ + --source_db_name=database_name_to_move \ + --destination_db_name=destination_database_name + +POSITIONAL ARGUMENTS + Service resource - Arguments and flags that specify the table and the + destination database you want to move to. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataproc Metastore service. + + If not specified, will use default metastore/location. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property metastore/location. + +REQUIRED FLAGS + --destination_db_name=DESTINATION_DB_NAME + The name of the database where the table should be moved. + + --source_db_name=SOURCE_DB_NAME + The name of the database where the table resides. + + --table_name=TABLE_NAME + The name of the table to be moved. + +OPTIONAL 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 metastore/v1alpha API. The full documentation for + this API can be found at: https://cloud.google.com/dataproc-metastore/docs + +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 metastore services move-table-to-database + diff --git a/gcloud/alpha/metastore/services/query-metadata b/gcloud/alpha/metastore/services/query-metadata new file mode 100644 index 000000000..74bad48b7 --- /dev/null +++ b/gcloud/alpha/metastore/services/query-metadata @@ -0,0 +1,82 @@ +NAME + gcloud alpha metastore services query-metadata - execute a SQL query + against a Dataproc Metastore Service's metadata + +SYNOPSIS + gcloud alpha metastore services query-metadata + (SERVICE : --location=LOCATION) --query=QUERY [--format=FORMAT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Execute a SQL query against a Dataproc Metastore Service's + metadata. + +EXAMPLES + To query metadata against a Dataproc Metastore service with the name + my-metastore-service in location us-central1, and the sql query "show + tables;", run: + + $ gcloud alpha metastore services query-metadata \ + my-metastore-service --location=us-central1 \ + --query="show tables;" + +POSITIONAL ARGUMENTS + Service resource - The service to query metadata. 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 service 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. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location to which the service belongs. To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property metastore/location. + +REQUIRED FLAGS + --query=QUERY + Use Google Standard SQL query for Cloud Spanner and MySQL query syntax + for Cloud SQL. Cloud Spanner SQL is described at + https://cloud.google.com/spanner/docs/query-syntax)" + +COMMONLY USED FLAGS + --format=FORMAT + Sets the format for printing command output resources. The default is a + command-specific human-friendly output format. If both core/format and + --format are specified, --format takes precedence. --format and + core/format both take precedence over core/default_format. The + supported formats are limited to: config, csv, default, diff, disable, + flattened, get, json, list, multi, none, object, table, text, value, + yaml. For more details run $ gcloud topic formats. Run $ gcloud config + set --help to see more information about core/format + +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 metastore services query-metadata + diff --git a/gcloud/alpha/ml/speech/recognize b/gcloud/alpha/ml/speech/recognize index e2faf681a..0388248de 100644 --- a/gcloud/alpha/ml/speech/recognize +++ b/gcloud/alpha/ml/speech/recognize @@ -78,7 +78,7 @@ OPTIONAL FLAGS --filter-profanity If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, - e.g. "f**". + e.g. f***. --hints=[HINT,...] A list of strings containing word and phrase "hints" so that the speech diff --git a/gcloud/alpha/ml/speech/recognize-long-running b/gcloud/alpha/ml/speech/recognize-long-running index 5a1f7666e..658eebe62 100644 --- a/gcloud/alpha/ml/speech/recognize-long-running +++ b/gcloud/alpha/ml/speech/recognize-long-running @@ -87,7 +87,7 @@ OPTIONAL FLAGS --filter-profanity If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, - e.g. "f**". + e.g. f***. --hints=[HINT,...] A list of strings containing word and phrase "hints" so that the speech diff --git a/gcloud/alpha/ml/speech/recognizers/create b/gcloud/alpha/ml/speech/recognizers/create index 140b0733e..a4c73b0aa 100644 --- a/gcloud/alpha/ml/speech/recognizers/create +++ b/gcloud/alpha/ml/speech/recognizers/create @@ -11,6 +11,8 @@ SYNOPSIS [--enable-spoken-punctuation=ENABLE_SPOKEN_PUNCTUATION] [--enable-word-confidence=ENABLE_WORD_CONFIDENCE] [--enable-word-time-offsets=ENABLE_WORD_TIME_OFFSETS] + [--max-speaker-count=MAX_SPEAKER_COUNT] + [--min-speaker-count=MIN_SPEAKER_COUNT] [--profanity-filter=PROFANITY_FILTER] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -78,6 +80,12 @@ OPTIONAL FLAGS --enable-word-time-offsets=ENABLE_WORD_TIME_OFFSETS If true, the top result includes a list of words and their timestamps. + --max-speaker-count=MAX_SPEAKER_COUNT + Maximum number of speakers in the conversation. + + --min-speaker-count=MIN_SPEAKER_COUNT + Minimum number of speakers in the conversation. + --profanity-filter=PROFANITY_FILTER If true, the server will censor profanities. diff --git a/gcloud/alpha/ml/speech/recognizers/update b/gcloud/alpha/ml/speech/recognizers/update index 684b5e685..c44f899c6 100644 --- a/gcloud/alpha/ml/speech/recognizers/update +++ b/gcloud/alpha/ml/speech/recognizers/update @@ -11,7 +11,9 @@ SYNOPSIS [--enable-spoken-punctuation=ENABLE_SPOKEN_PUNCTUATION] [--enable-word-confidence=ENABLE_WORD_CONFIDENCE] [--enable-word-time-offsets=ENABLE_WORD_TIME_OFFSETS] - [--language-codes=[LANGUAGE_CODE,...]] [--model=MODEL] + [--language-codes=[LANGUAGE_CODE,...]] + [--max-speaker-count=MAX_SPEAKER_COUNT] + [--min-speaker-count=MIN_SPEAKER_COUNT] [--model=MODEL] [--profanity-filter=PROFANITY_FILTER] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -75,6 +77,12 @@ FLAGS (https://cloud.google.com/speech-to-text/docs/multiple-languages) for using more than one language code. + --max-speaker-count=MAX_SPEAKER_COUNT + Maximum number of speakers in the conversation. + + --min-speaker-count=MIN_SPEAKER_COUNT + Minimum number of speakers in the conversation. + --model=MODEL latest_long or latest_short diff --git a/gcloud/alpha/ml/video/transcribe-speech b/gcloud/alpha/ml/video/transcribe-speech index 9dd072d19..e87ac35ec 100644 --- a/gcloud/alpha/ml/video/transcribe-speech +++ b/gcloud/alpha/ml/video/transcribe-speech @@ -70,7 +70,7 @@ OPTIONAL FLAGS --filter-profanity If enabled, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with - asterisks, e.g. "f**". If disabled or omitted, profanities will not be + asterisks, e.g. f***. If disabled or omitted, profanities will not be filtered out. --hints=[HINTS,...] diff --git a/gcloud/alpha/monitoring/channels/config/export b/gcloud/alpha/monitoring/channels/config/export index 89d8e378d..e3fc9b3d0 100644 --- a/gcloud/alpha/monitoring/channels/config/export +++ b/gcloud/alpha/monitoring/channels/config/export @@ -66,7 +66,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/monitoring/policies/config/export b/gcloud/alpha/monitoring/policies/config/export index 3a80a3568..c72cda9ee 100644 --- a/gcloud/alpha/monitoring/policies/config/export +++ b/gcloud/alpha/monitoring/policies/config/export @@ -64,7 +64,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/netapp/active-directories/create b/gcloud/alpha/netapp/active-directories/create new file mode 100644 index 000000000..96fdb20ed --- /dev/null +++ b/gcloud/alpha/netapp/active-directories/create @@ -0,0 +1,132 @@ +NAME + gcloud alpha netapp active-directories create - create a Cloud NetApp + Active Directory + +SYNOPSIS + gcloud alpha netapp active-directories create + (ACTIVE_DIRECTORY : --location=LOCATION) --dns=DNS --domain=DOMAIN + --net-bios=NET_BIOS --password=PASSWORD --username=USERNAME [--async] + [--backup-operators=[BACKUP_OPERATOR,...]] [--description=DESCRIPTION] + [--enable-aes=ENABLE_AES] [--enable-ldap-signing=ENABLE_LDAP_SIGNING] + [--encrypt-dc-connections=ENCRYPT_DC_CONNECTIONS] + [--kdc-hostname=KDC_HOSTNAME] [--kdc-ip=KDC_IP] + [--labels=[KEY=VALUE,...]] [--nfs-users-with-ldap=NFS_USERS_WITH_LDAP] + [--organizational-unit=ORGANIZATIONAL_UNIT] + [--security-operators=[SECURITY_OPERATOR,...]] [--site=SITE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud NetApp Active Directory. + +POSITIONAL ARGUMENTS + Active directory resource - The Active Directory to create. 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 active_directory 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. + + ACTIVE_DIRECTORY + ID of the active_directory or fully qualified identifier for the + active_directory. To set the active_directory attribute: + ▸ provide the argument active_directory on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the active_directory. To set the location attribute: + ▸ provide the argument active_directory on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +REQUIRED FLAGS + --dns=DNS + A comma separated list of DNS server IP addresses for the Active + Directory domain. + + --domain=DOMAIN + The Active Directory domain. + + --net-bios=NET_BIOS + NetBIOS name of the server. + + --password=PASSWORD + Password of the Active Directory domain administrator. + + --username=USERNAME + Username of the Active Directory domain administrator. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --backup-operators=[BACKUP_OPERATOR,...] + Users to be added to the Built-in Backup Operator Active Directory + group. + + --description=DESCRIPTION + A description of the Cloud NetApp Active Directory + + --enable-aes=ENABLE_AES + The Boolean value indiciating whether AES encryption will be enabled + for SMB communication. + + --enable-ldap-signing=ENABLE_LDAP_SIGNING + Boolean flag that specifies whether or not LDAP traffic needs to be + signed. + + --encrypt-dc-connections=ENCRYPT_DC_CONNECTIONS + Boolean flag that specifies whether traffic between SMB server to + Domain Controller (DC) will be encrypted. + + --kdc-hostname=KDC_HOSTNAME + Name of the Active Directory machine. + + --kdc-ip=KDC_IP + KDC server IP address for the Active Directory machine. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --nfs-users-with-ldap=NFS_USERS_WITH_LDAP + Boolean flag that allows access to local users and LDAP users. If + access is needed only for LDAP users, it has to be disabled. + + --organizational-unit=ORGANIZATIONAL_UNIT + The Organizational Unit (OU) within the Windows Active Directory the + user belongs to. + + --security-operators=[SECURITY_OPERATOR,...] + Domain users to be given the Security privilege. + + --site=SITE + The Active Directory site the service will limit Domain Controller + discovery to. + +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. + diff --git a/gcloud/alpha/netapp/active-directories/delete b/gcloud/alpha/netapp/active-directories/delete new file mode 100644 index 000000000..57f8b003e --- /dev/null +++ b/gcloud/alpha/netapp/active-directories/delete @@ -0,0 +1,59 @@ +NAME + gcloud alpha netapp active-directories delete - delete a Cloud NetApp + Active Directory + +SYNOPSIS + gcloud alpha netapp active-directories delete + (ACTIVE_DIRECTORY : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud NetApp Active Directory. + +POSITIONAL ARGUMENTS + Active directory resource - The Active Directory 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 active_directory 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. + + ACTIVE_DIRECTORY + ID of the active_directory or fully qualified identifier for the + active_directory. To set the active_directory attribute: + ▸ provide the argument active_directory on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the active_directory. To set the location attribute: + ▸ provide the argument active_directory on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/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. + +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. + diff --git a/gcloud/alpha/netapp/active-directories/describe b/gcloud/alpha/netapp/active-directories/describe new file mode 100644 index 000000000..b1bb48997 --- /dev/null +++ b/gcloud/alpha/netapp/active-directories/describe @@ -0,0 +1,53 @@ +NAME + gcloud alpha netapp active-directories describe - show metadata for a Cloud + NetApp Active Directory + +SYNOPSIS + gcloud alpha netapp active-directories describe + (ACTIVE_DIRECTORY : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show metadata for a Cloud NetApp Active Directory. + +POSITIONAL ARGUMENTS + Active directory resource - The Active Directory 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 active_directory 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. + + ACTIVE_DIRECTORY + ID of the active_directory or fully qualified identifier for the + active_directory. To set the active_directory attribute: + ▸ provide the argument active_directory on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the active_directory. To set the location attribute: + ▸ provide the argument active_directory on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/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 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. + diff --git a/gcloud/alpha/netapp/active-directories/help b/gcloud/alpha/netapp/active-directories/help new file mode 100644 index 000000000..dc9c5da44 --- /dev/null +++ b/gcloud/alpha/netapp/active-directories/help @@ -0,0 +1,39 @@ +NAME + gcloud alpha netapp active-directories - create and manage Cloud NetApp + Active Directories + +SYNOPSIS + gcloud alpha netapp active-directories COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Cloud NetApp Active Directories. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a Cloud NetApp Active Directory. + + delete + (ALPHA) Delete a Cloud NetApp Active Directory. + + describe + (ALPHA) Show metadata for a Cloud NetApp Active Directory. + + list + (ALPHA) List Cloud NetApp Active Directories. + + update + (ALPHA) Update a Cloud NetApp Active Directory. + +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. + diff --git a/gcloud/alpha/netapp/active-directories/list b/gcloud/alpha/netapp/active-directories/list new file mode 100644 index 000000000..1d2d1dcd6 --- /dev/null +++ b/gcloud/alpha/netapp/active-directories/list @@ -0,0 +1,79 @@ +NAME + gcloud alpha netapp active-directories list - list Cloud NetApp Active + Directories + +SYNOPSIS + gcloud alpha netapp active-directories list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Cloud NetApp Active Directories. + +FLAGS + Location resource - The location in which to list Active Directories. 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 --location on the command line with a fully + specified name; + ◆ uses all locations by default. with a fully specified name; + ◆ set the property netapp/location with a fully specified name; + ◆ set the property netapp/region with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ uses all locations by default.; + ▸ set the property netapp/location; + ▸ set the property netapp/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 + 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. + diff --git a/gcloud/alpha/netapp/active-directories/update b/gcloud/alpha/netapp/active-directories/update new file mode 100644 index 000000000..c73e77465 --- /dev/null +++ b/gcloud/alpha/netapp/active-directories/update @@ -0,0 +1,154 @@ +NAME + gcloud alpha netapp active-directories update - update a Cloud NetApp + Active Directory + +SYNOPSIS + gcloud alpha netapp active-directories update + (ACTIVE_DIRECTORY : --location=LOCATION) --dns=DNS --domain=DOMAIN + --net-bios=NET_BIOS --password=PASSWORD --username=USERNAME [--async] + [--backup-operators=[BACKUP_OPERATOR,...]] [--description=DESCRIPTION] + [--enable-aes=ENABLE_AES] [--enable-ldap-signing=ENABLE_LDAP_SIGNING] + [--encrypt-dc-connections=ENCRYPT_DC_CONNECTIONS] + [--kdc-hostname=KDC_HOSTNAME] [--kdc-ip=KDC_IP] + [--nfs-users-with-ldap=NFS_USERS_WITH_LDAP] + [--organizational-unit=ORGANIZATIONAL_UNIT] + [--security-operators=[SECURITY_OPERATOR,...]] [--site=SITE] + [--update-labels=[KEY=VALUE,...]] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud NetApp Active Directory. + +POSITIONAL ARGUMENTS + Active directory resource - The Active Directory to update. 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 active_directory 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. + + ACTIVE_DIRECTORY + ID of the active_directory or fully qualified identifier for the + active_directory. To set the active_directory attribute: + ▸ provide the argument active_directory on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the active_directory. To set the location attribute: + ▸ provide the argument active_directory on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +REQUIRED FLAGS + --dns=DNS + A comma separated list of DNS server IP addresses for the Active + Directory domain. + + --domain=DOMAIN + The Active Directory domain. + + --net-bios=NET_BIOS + NetBIOS name of the server. + + --password=PASSWORD + Password of the Active Directory domain administrator. + + --username=USERNAME + Username of the Active Directory domain administrator. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --backup-operators=[BACKUP_OPERATOR,...] + Users to be added to the Built-in Backup Operator Active Directory + group. + + --description=DESCRIPTION + A description of the Cloud NetApp Active Directory + + --enable-aes=ENABLE_AES + The Boolean value indiciating whether AES encryption will be enabled + for SMB communication. + + --enable-ldap-signing=ENABLE_LDAP_SIGNING + Boolean flag that specifies whether or not LDAP traffic needs to be + signed. + + --encrypt-dc-connections=ENCRYPT_DC_CONNECTIONS + Boolean flag that specifies whether traffic between SMB server to + Domain Controller (DC) will be encrypted. + + --kdc-hostname=KDC_HOSTNAME + Name of the Active Directory machine. + + --kdc-ip=KDC_IP + KDC server IP address for the Active Directory machine. + + --nfs-users-with-ldap=NFS_USERS_WITH_LDAP + Boolean flag that allows access to local users and LDAP users. If + access is needed only for LDAP users, it has to be disabled. + + --organizational-unit=ORGANIZATIONAL_UNIT + The Organizational Unit (OU) within the Windows Active Directory the + user belongs to. + + --security-operators=[SECURITY_OPERATOR,...] + Domain users to be given the Security privilege. + + --site=SITE + The Active Directory site the service will limit Domain Controller + discovery to. + + --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. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + 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 alpha netapp active-directories update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud alpha netapp active-directories 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. + +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. + diff --git a/gcloud/alpha/netapp/help b/gcloud/alpha/netapp/help new file mode 100644 index 000000000..f53d31cfd --- /dev/null +++ b/gcloud/alpha/netapp/help @@ -0,0 +1,48 @@ +NAME + gcloud alpha netapp - create and manipulate Cloud NetApp Files resources + +SYNOPSIS + gcloud alpha netapp GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) The gcloud netapp command group lets you create, configure and + manipulate Cloud NetApp Files resources such as Volumes, Storage Pools, + etc. + + With Cloud NetApp Files, you can take advantage of Google Cloud Platform's + scale, performance and value to manage and run on-prem NetApp Files + solutions on Google infrastructure, so you don't have to modernize your + file workloads, and allow for legacy feature support. + + More information on Cloud NetApp Files can be found here: + https://cloud.google.com/netapp/docs/reference/rest + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + active-directories + (ALPHA) Create and manage Cloud NetApp Active Directories. + + locations + (ALPHA) Get and list locations where Cloud NetApp Files is available. + + operations + (ALPHA) Read and manage Cloud NetApp Files Operations. + + storage-pools + (ALPHA) Create and manage Cloud NetApp Storage Pools. + + volumes + (ALPHA) Create and manage Cloud NetApp Volumes. + +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. + diff --git a/gcloud/alpha/netapp/locations/describe b/gcloud/alpha/netapp/locations/describe new file mode 100644 index 000000000..104e48549 --- /dev/null +++ b/gcloud/alpha/netapp/locations/describe @@ -0,0 +1,46 @@ +NAME + gcloud alpha netapp locations describe - describe a Cloud NetApp Files + location + +SYNOPSIS + gcloud alpha netapp locations describe LOCATION [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Cloud NetApp Files location. + +EXAMPLES + The following command shows the details for the NetApp Files location named + NAME. + + $ gcloud alpha netapp locations describe NAME + +POSITIONAL ARGUMENTS + Location resource - The location 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 location 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. + + LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument location 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. + diff --git a/gcloud/alpha/netapp/locations/help b/gcloud/alpha/netapp/locations/help new file mode 100644 index 000000000..ee9e75154 --- /dev/null +++ b/gcloud/alpha/netapp/locations/help @@ -0,0 +1,30 @@ +NAME + gcloud alpha netapp locations - get and list locations where Cloud NetApp + Files is available + +SYNOPSIS + gcloud alpha netapp locations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get and list locations where Cloud NetApp Files is available. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a Cloud NetApp Files location. + + list + (ALPHA) List all Cloud NetApp Files locations. + +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. + diff --git a/gcloud/alpha/netapp/locations/list b/gcloud/alpha/netapp/locations/list new file mode 100644 index 000000000..c2e2378ea --- /dev/null +++ b/gcloud/alpha/netapp/locations/list @@ -0,0 +1,57 @@ +NAME + gcloud alpha netapp locations list - list all Cloud NetApp Files locations + +SYNOPSIS + gcloud alpha netapp locations list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all Cloud NetApp Files locations. + +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 + 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. + diff --git a/gcloud/alpha/netapp/operations/describe b/gcloud/alpha/netapp/operations/describe new file mode 100644 index 000000000..92034201e --- /dev/null +++ b/gcloud/alpha/netapp/operations/describe @@ -0,0 +1,53 @@ +NAME + gcloud alpha netapp operations describe - describe a Cloud NetApp Files + operation + +SYNOPSIS + gcloud alpha netapp operations describe (OPERATION : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a Cloud NetApp Files operation. + +POSITIONAL ARGUMENTS + Operation resource - The operation 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 operation 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. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the operation. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/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 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. + diff --git a/gcloud/alpha/netapp/operations/help b/gcloud/alpha/netapp/operations/help new file mode 100644 index 000000000..79cb40011 --- /dev/null +++ b/gcloud/alpha/netapp/operations/help @@ -0,0 +1,30 @@ +NAME + gcloud alpha netapp operations - read and manage Cloud NetApp Files + Operations + +SYNOPSIS + gcloud alpha netapp operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Read and manage Cloud NetApp Files Operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe a Cloud NetApp Files operation. + + list + (ALPHA) List Cloud NetApp Files operations. + +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. + diff --git a/gcloud/alpha/netapp/operations/list b/gcloud/alpha/netapp/operations/list new file mode 100644 index 000000000..c2ef4b48c --- /dev/null +++ b/gcloud/alpha/netapp/operations/list @@ -0,0 +1,78 @@ +NAME + gcloud alpha netapp operations list - list Cloud NetApp Files operations + +SYNOPSIS + gcloud alpha netapp operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Cloud NetApp Files operations. + +FLAGS + Location resource - The location in which to list operations. 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 --location on the command line with a fully + specified name; + ◆ uses all locations by default. with a fully specified name; + ◆ set the property netapp/location with a fully specified name; + ◆ set the property netapp/region with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ uses all locations by default.; + ▸ set the property netapp/location; + ▸ set the property netapp/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 + 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. + diff --git a/gcloud/alpha/netapp/storage-pools/create b/gcloud/alpha/netapp/storage-pools/create new file mode 100644 index 000000000..2f70e5c0f --- /dev/null +++ b/gcloud/alpha/netapp/storage-pools/create @@ -0,0 +1,92 @@ +NAME + gcloud alpha netapp storage-pools create - create a Cloud NetApp Storage + Pool + +SYNOPSIS + gcloud alpha netapp storage-pools create + (STORAGE_POOL : --location=LOCATION) --capacity=CAPACITY + --service-level=SERVICE_LEVEL [--async] [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud NetApp Storage Pool. + +POSITIONAL ARGUMENTS + Storage pool resource - The Storage Pool to create. 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 storage_pool 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. + + STORAGE_POOL + ID of the storage_pool or fully qualified identifier for the + storage_pool. To set the storage_pool attribute: + ▸ provide the argument storage_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the storage_pool. To set the location attribute: + ▸ provide the argument storage_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +REQUIRED FLAGS + --capacity=CAPACITY + The desired capacity of the Storage Pool in GiB or TiB units.If no + capacity unit is specified, GiB is assumed. + + --service-level=SERVICE_LEVEL + The service level for the Cloud NetApp Storage Pool. For more details, + see: + https://cloud.google.com/architecture/partners/netapp-cloud-volumes/service-levels + + SERVICE_LEVEL must be one of: + + extreme + Extreme Service Level for Cloud NetApp Storage Pool. The Extreme + Service Level has a throughput per TiB of allocated volume size of + 128 MiB/s. + premium + Premium Service Level for Cloud NetApp Storage Pool. The Premium + Service Level has a throughput per TiB of allocated volume size of + 64 MiB/s. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description of the Cloud NetApp Storage Pool + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + +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. + diff --git a/gcloud/alpha/netapp/storage-pools/delete b/gcloud/alpha/netapp/storage-pools/delete new file mode 100644 index 000000000..a590eddd8 --- /dev/null +++ b/gcloud/alpha/netapp/storage-pools/delete @@ -0,0 +1,58 @@ +NAME + gcloud alpha netapp storage-pools delete - delete a Cloud NetApp Storage + Pool + +SYNOPSIS + gcloud alpha netapp storage-pools delete + (STORAGE_POOL : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud NetApp Storage Pool. + +POSITIONAL ARGUMENTS + Storage pool resource - The Storage Pool 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 storage_pool 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. + + STORAGE_POOL + ID of the storage_pool or fully qualified identifier for the + storage_pool. To set the storage_pool attribute: + ▸ provide the argument storage_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the storage_pool. To set the location attribute: + ▸ provide the argument storage_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/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. + +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. + diff --git a/gcloud/alpha/netapp/storage-pools/describe b/gcloud/alpha/netapp/storage-pools/describe new file mode 100644 index 000000000..7c7a1b351 --- /dev/null +++ b/gcloud/alpha/netapp/storage-pools/describe @@ -0,0 +1,53 @@ +NAME + gcloud alpha netapp storage-pools describe - show metadata for a Cloud + NetApp Storage Pool + +SYNOPSIS + gcloud alpha netapp storage-pools describe + (STORAGE_POOL : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show metadata for a Cloud NetApp Storage Pool. + +POSITIONAL ARGUMENTS + Storage pool resource - The Storage Pool 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 storage_pool 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. + + STORAGE_POOL + ID of the storage_pool or fully qualified identifier for the + storage_pool. To set the storage_pool attribute: + ▸ provide the argument storage_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the storage_pool. To set the location attribute: + ▸ provide the argument storage_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/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 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. + diff --git a/gcloud/alpha/netapp/storage-pools/help b/gcloud/alpha/netapp/storage-pools/help new file mode 100644 index 000000000..84755e859 --- /dev/null +++ b/gcloud/alpha/netapp/storage-pools/help @@ -0,0 +1,39 @@ +NAME + gcloud alpha netapp storage-pools - create and manage Cloud NetApp Storage + Pools + +SYNOPSIS + gcloud alpha netapp storage-pools COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Cloud NetApp Storage Pools. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a Cloud NetApp Storage Pool. + + delete + (ALPHA) Delete a Cloud NetApp Storage Pool. + + describe + (ALPHA) Show metadata for a Cloud NetApp Storage Pool. + + list + (ALPHA) List Cloud NetApp Storage Pools. + + update + (ALPHA) Update a Cloud NetApp Storage Pool. + +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. + diff --git a/gcloud/alpha/netapp/storage-pools/list b/gcloud/alpha/netapp/storage-pools/list new file mode 100644 index 000000000..26313495a --- /dev/null +++ b/gcloud/alpha/netapp/storage-pools/list @@ -0,0 +1,78 @@ +NAME + gcloud alpha netapp storage-pools list - list Cloud NetApp Storage Pools + +SYNOPSIS + gcloud alpha netapp storage-pools list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Cloud NetApp Storage Pools. + +FLAGS + Location resource - The location in which to list Storage Pools. 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 --location on the command line with a fully + specified name; + ◆ uses all locations by default. with a fully specified name; + ◆ set the property netapp/location with a fully specified name; + ◆ set the property netapp/region with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ uses all locations by default.; + ▸ set the property netapp/location; + ▸ set the property netapp/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 + 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. + diff --git a/gcloud/alpha/netapp/storage-pools/update b/gcloud/alpha/netapp/storage-pools/update new file mode 100644 index 000000000..d2888b9e9 --- /dev/null +++ b/gcloud/alpha/netapp/storage-pools/update @@ -0,0 +1,96 @@ +NAME + gcloud alpha netapp storage-pools update - update a Cloud NetApp Storage + Pool + +SYNOPSIS + gcloud alpha netapp storage-pools update + (STORAGE_POOL : --location=LOCATION) [--async] [--capacity=CAPACITY] + [--description=DESCRIPTION] [--update-labels=[KEY=VALUE,...]] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud NetApp Storage Pool. + +POSITIONAL ARGUMENTS + Storage pool resource - The Storage Pool to update. 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 storage_pool 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. + + STORAGE_POOL + ID of the storage_pool or fully qualified identifier for the + storage_pool. To set the storage_pool attribute: + ▸ provide the argument storage_pool on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the storage_pool. To set the location attribute: + ▸ provide the argument storage_pool on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --capacity=CAPACITY + The desired capacity of the Storage Pool in GiB or TiB units.If no + capacity unit is specified, GiB is assumed. + + --description=DESCRIPTION + A description of the Cloud NetApp Storage Pool + + --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. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + 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 alpha netapp storage-pools update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud alpha netapp storage-pools 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. + +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. + diff --git a/gcloud/alpha/netapp/volumes/create b/gcloud/alpha/netapp/volumes/create new file mode 100644 index 000000000..33cff9ae5 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/create @@ -0,0 +1,228 @@ +NAME + gcloud alpha netapp volumes create - create a Cloud NetApp Volume + +SYNOPSIS + gcloud alpha netapp volumes create (VOLUME : --location=LOCATION) + --capacity=CAPACITY + --network=[name=NAME],[reserved-ip-range=RESERVED-IP-RANGE] + --protocols=PROTOCOL,[PROTOCOL,...] --share-name=SHARE_NAME + --storage-pool=STORAGE_POOL --from-snapshot=FROM_SNAPSHOT [--async] + [--description=DESCRIPTION] [--enable-kerberos=ENABLE_KERBEROS] + [--enable-ldap=ENABLE_LDAP] + [--export-policy=[access-type=ACCESS-TYPE], + [allowed-clients=ALLOWED-CLIENTS],[has-root-access=HAS-ROOT-ACCESS], + [kerberos-5-read-only=KERBEROS-5-READ-ONLY], + [kerberos-5-read-write=KERBEROS-5-READ-WRITE], + [kerberos-5i-read-only=KERBEROS-5I-READ-ONLY], + [kerberos-5i-read-write=KERBEROS-5I-READ-WRITE], + [kerberos-5p-read-only=KERBEROS-5P-READ-ONLY], + [kerberos-5p-read-write=KERBEROS-5P-READ-WRITE], + [nfsv3=NFSV3],[nfsv4=NFSV4]] [--labels=[KEY=VALUE,...]] + [--security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED"] + [--smb-settings=SMB_SETTING,[SMB_SETTING,...]] + [--snap-reserve=SNAP_RESERVE] + [--snapshot-daily=[hour=HOUR], + [minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--snapshot-directory=SNAPSHOT_DIRECTORY; default="true"] + [--snapshot-hourly=[minute=MINUTE], + [snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--snapshot-monthly=[day=DAY], + [hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--snapshot-weekly=[day=DAY], + [hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--unix-permissions=UNIX_PERMISSIONS] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud NetApp Volume. + +POSITIONAL ARGUMENTS + Volume resource - The Volume to create. 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 volume 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. + + VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument volume on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the volume. To set the location attribute: + ▸ provide the argument volume on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +REQUIRED FLAGS + --capacity=CAPACITY + The desired capacity of the Volume in GiB or TiB units.If no capacity + unit is specified, GiB is assumed. + + --network=[name=NAME],[reserved-ip-range=RESERVED-IP-RANGE] + Network configuration for a Cloud NetApp Files Volume. Specifying + reserved-ip-range is optional. + name + The name of the Google Compute Engine VPC network to which the + instance is connected. + reserved-ip-range + The reserved-ip-range can have an allocated IP address range + (https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address). + When the name of an allocated IP address range is specified, it + must be one of the ranges associated with the private service + access connection. The range you specify can't overlap with either + existing subnets or assigned IP address ranges for other Cloud + NetApp Files Volumes in the selected VPC network. + + --protocols=PROTOCOL,[PROTOCOL,...] + Type of File System protocols for the Cloud NetApp Files VolumeValid + component values are: NFSV3, NFSV4, SMB + + For more information, look athttps://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#protocols. + + --share-name=SHARE_NAME + Share name of the Mount path clients will use. + + Storage pool resource - The Storage Pool to associate with Volume. 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 --storage-pool on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --storage-pool on the command line with a fully + specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + This must be specified. + + --storage-pool=STORAGE_POOL + ID of the storage_pool or fully qualified identifier for the + storage_pool. To set the storage_pool attribute: + ▸ provide the argument --storage-pool on the command line. + +OPTIONAL FLAGS + Snapshot resource - The Snapshot to create the Volume from. 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 --from-snapshot on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --from-snapshot on the command line with a fully + specified name; + ◆ set the property netapp/location; + ◆ set the property netapp/region. To set the volume attribute: + ◆ provide the argument --from-snapshot on the command line with a fully + specified name. + + --from-snapshot=FROM_SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument --from-snapshot on the command line. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description of the Cloud NetApp Volume + + --enable-kerberos=ENABLE_KERBEROS + Boolean flag indicating whether Volume is a kerberos Volume or not + + --enable-ldap=ENABLE_LDAP + Boolean flag indicating whether Volume is a NFS LDAP Volume or not + + --export-policy=[access-type=ACCESS-TYPE],[allowed-clients=ALLOWED-CLIENTS],[has-root-access=HAS-ROOT-ACCESS],[kerberos-5-read-only=KERBEROS-5-READ-ONLY],[kerberos-5-read-write=KERBEROS-5-READ-WRITE],[kerberos-5i-read-only=KERBEROS-5I-READ-ONLY],[kerberos-5i-read-write=KERBEROS-5I-READ-WRITE],[kerberos-5p-read-only=KERBEROS-5P-READ-ONLY],[kerberos-5p-read-write=KERBEROS-5P-READ-WRITE],[nfsv3=NFSV3],[nfsv4=NFSV4] + Export Policy of a Cloud NetApp Files Volume. This will be a field + similar to network in which export policy fields can be specified as + such: --export-policy=allowed-clients=ALLOWED_CLIENTS_IP_ADDRESSES, + has-root-access=HAS_ROOT_ACCESS_BOOL,access=ACCESS_TYPE,nfsv3=NFSV3, + nfsv4=NFSV4,kerberos-5-read-only=KERBEROS_5_READ_ONLY, + kerberos-5-read-write=KERBEROS_5_READ_WRITE, + kerberos-5i-read-only=KERBEROS_5I_READ_ONLY, + kerberos-5i-read-write=KERBEROS_5I_READ_WRITE, + kerberos-5p-read-only=KERBEROS_5P_READ_ONLY, + kerberos-5p-read-write=KERBEROS_5P_READ_WRITE + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED" + The security style of the Volume. This can either be UNIX or NTFS. + + SECURITY_STYLE must be one of: + + ntfs + NTFS security style for Volume. + unix + UNIX security style for Volume + + --smb-settings=SMB_SETTING,[SMB_SETTING,...] + List of settings specific to SMB protocolfor a Cloud NetApp Files + VolumeValid component values are: ENCRYPT_DATA, BROWSABLE, + CHANGE_NOTIFY, 'NON_BROWSABLE', 'OPLOCKS', 'SHOW_SNAPSHOT', + 'SHOW_PREVIOUS_VERSIONS', 'ACCESS_BASED_ENUMERATION', + 'CONTINUOUSLY_AVAILABLE' + + For more information, look athttps://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#smbsettings. + + --snap-reserve=SNAP_RESERVE + The percentage of volume storage reserved for snapshot storage. The + default value for this is 0 percent + + --snapshot-daily=[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot every day e.g. at 06:00, 05:20, 23:50 + + --snapshot-directory=SNAPSHOT_DIRECTORY; default="true" + Snapshot Directory if enabled (true) makes the Volume contain a + read-only .snapshot directory which provides access to each of the + volume's snapshots + + --snapshot-hourly=[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot every hour e.g. at 04:00, 05:20, 06:00 + + --snapshot-monthly=[day=DAY],[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 + + --snapshot-weekly=[day=DAY],[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, + Sunday 23:50 + + --unix-permissions=UNIX_PERMISSIONS + Unix permissions the mount point will be created with.Unix permissions + are only applicable with NFS protocol only + +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. + diff --git a/gcloud/alpha/netapp/volumes/delete b/gcloud/alpha/netapp/volumes/delete new file mode 100644 index 000000000..5e90d1ee7 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/delete @@ -0,0 +1,61 @@ +NAME + gcloud alpha netapp volumes delete - delete a Cloud NetApp Volume + +SYNOPSIS + gcloud alpha netapp volumes delete (VOLUME : --location=LOCATION) [--async] + [--force] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud NetApp Volume. + +POSITIONAL ARGUMENTS + Volume resource - The Volume 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 volume 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. + + VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument volume on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the volume. To set the location attribute: + ▸ provide the argument volume on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --force + Forces the deletion of a volume and its child resources, such as + snapshots. + +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. + diff --git a/gcloud/alpha/netapp/volumes/describe b/gcloud/alpha/netapp/volumes/describe new file mode 100644 index 000000000..114e0834f --- /dev/null +++ b/gcloud/alpha/netapp/volumes/describe @@ -0,0 +1,53 @@ +NAME + gcloud alpha netapp volumes describe - show metadata for a Cloud NetApp + Volume + +SYNOPSIS + gcloud alpha netapp volumes describe (VOLUME : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Show metadata for a Cloud NetApp Volume. + +POSITIONAL ARGUMENTS + Volume resource - The Volume 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 volume 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. + + VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument volume on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the volume. To set the location attribute: + ▸ provide the argument volume on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/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 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. + diff --git a/gcloud/alpha/netapp/volumes/help b/gcloud/alpha/netapp/volumes/help new file mode 100644 index 000000000..65bfe3a95 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/help @@ -0,0 +1,47 @@ +NAME + gcloud alpha netapp volumes - create and manage Cloud NetApp Volumes + +SYNOPSIS + gcloud alpha netapp volumes GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Cloud NetApp Volumes. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + snapshots + (ALPHA) Create and manage Cloud NetApp Volume Snapshots. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a Cloud NetApp Volume. + + delete + (ALPHA) Delete a Cloud NetApp Volume. + + describe + (ALPHA) Show metadata for a Cloud NetApp Volume. + + list + (ALPHA) List Cloud NetApp Volumes. + + revert + (ALPHA) Revert a Cloud NetApp Volume back to a specified Snapshot. + + update + (ALPHA) Update a Cloud NetApp Volume. + +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. + diff --git a/gcloud/alpha/netapp/volumes/list b/gcloud/alpha/netapp/volumes/list new file mode 100644 index 000000000..9da9bcde4 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/list @@ -0,0 +1,77 @@ +NAME + gcloud alpha netapp volumes list - list Cloud NetApp Volumes + +SYNOPSIS + gcloud alpha netapp volumes list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Cloud NetApp Volumes. + +FLAGS + Location resource - The location in which to list Volumes. 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 --location on the command line with a fully + specified name; + ◆ uses all locations by default. with a fully specified name; + ◆ set the property netapp/location with a fully specified name; + ◆ set the property netapp/region with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ uses all locations by default.; + ▸ set the property netapp/location; + ▸ set the property netapp/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 + 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. + diff --git a/gcloud/alpha/netapp/volumes/revert b/gcloud/alpha/netapp/volumes/revert new file mode 100644 index 000000000..ccdfcfce6 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/revert @@ -0,0 +1,76 @@ +NAME + gcloud alpha netapp volumes revert - revert a Cloud NetApp Volume back to a + specified Snapshot + +SYNOPSIS + gcloud alpha netapp volumes revert (VOLUME : --location=LOCATION) + --snapshot=SNAPSHOT [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Revert a Cloud NetApp Volume back to a specified Snapshot. + +POSITIONAL ARGUMENTS + Volume resource - The Volume to revert. 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 volume 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. + + VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument volume on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the volume. To set the location attribute: + ▸ provide the argument volume on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +REQUIRED FLAGS + Snapshot resource - The Snapshot to revert the Volume back 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 --snapshot on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --snapshot on the command line with a fully + specified name; + ◆ set the property netapp/location; + ◆ set the property netapp/region. To set the volume attribute: + ◆ provide the argument --snapshot on the command line with a fully + specified name. + + This must be specified. + + --snapshot=SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument --snapshot 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. + diff --git a/gcloud/alpha/netapp/volumes/snapshots/create b/gcloud/alpha/netapp/volumes/snapshots/create new file mode 100644 index 000000000..18a1ef751 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/snapshots/create @@ -0,0 +1,101 @@ +NAME + gcloud alpha netapp volumes snapshots create - creates a Cloud NetApp + Volume Snapshot + +SYNOPSIS + gcloud alpha netapp volumes snapshots create + (SNAPSHOT : --location=LOCATION --snapshot-volume=SNAPSHOT_VOLUME) + [--async] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--volume=VOLUME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creates a Cloud NetApp Volume Snapshot. + +POSITIONAL ARGUMENTS + Snapshot resource - The Snapshot to create. 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 snapshot 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. + + SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument snapshot on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the snapshot. To set the location attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + + --snapshot-volume=SNAPSHOT_VOLUME + The volume of the snapshot To set the volume attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --snapshot-volume on the command line; + ▸ provide the argument --volume on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description of the Cloud NetApp Snapshot + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + Volume resource - The Volume to take a Snapshot of. 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 --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + --volume=VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument --volume on the command line; + ▸ provide the argument --snapshot-volume 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. + diff --git a/gcloud/alpha/netapp/volumes/snapshots/delete b/gcloud/alpha/netapp/volumes/snapshots/delete new file mode 100644 index 000000000..8fbeb475c --- /dev/null +++ b/gcloud/alpha/netapp/volumes/snapshots/delete @@ -0,0 +1,93 @@ +NAME + gcloud alpha netapp volumes snapshots delete - deletes a Cloud NetApp + Volume Snapshot + +SYNOPSIS + gcloud alpha netapp volumes snapshots delete + (SNAPSHOT : --location=LOCATION --snapshot-volume=SNAPSHOT_VOLUME) + [--async] [--description=DESCRIPTION] [--volume=VOLUME] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Deletes a Cloud NetApp Volume Snapshot. + +POSITIONAL ARGUMENTS + Snapshot resource - The Snapshot 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 snapshot 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. + + SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument snapshot on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the snapshot. To set the location attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + + --snapshot-volume=SNAPSHOT_VOLUME + The volume of the snapshot To set the volume attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --snapshot-volume on the command line; + ▸ provide the argument --volume on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description of the Cloud NetApp Snapshot + + Volume resource - The Volume to take a Snapshot of. 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 --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + --volume=VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument --volume on the command line; + ▸ provide the argument --snapshot-volume 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. + diff --git a/gcloud/alpha/netapp/volumes/snapshots/describe b/gcloud/alpha/netapp/volumes/snapshots/describe new file mode 100644 index 000000000..a9e8ac5b2 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/snapshots/describe @@ -0,0 +1,85 @@ +NAME + gcloud alpha netapp volumes snapshots describe - describes a Cloud NetApp + Volume Snapshot + +SYNOPSIS + gcloud alpha netapp volumes snapshots describe + (SNAPSHOT : --location=LOCATION --snapshot-volume=SNAPSHOT_VOLUME) + [--volume=VOLUME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describes a Cloud NetApp Volume Snapshot. + +POSITIONAL ARGUMENTS + Snapshot resource - The Snapshot 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 snapshot 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. + + SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument snapshot on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the snapshot. To set the location attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + + --snapshot-volume=SNAPSHOT_VOLUME + The volume of the snapshot To set the volume attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --snapshot-volume on the command line; + ▸ provide the argument --volume on the command line. + +FLAGS + Volume resource - The Volume to take a Snapshot of. 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 --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + --volume=VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument --volume on the command line; + ▸ provide the argument --snapshot-volume 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. + diff --git a/gcloud/alpha/netapp/volumes/snapshots/help b/gcloud/alpha/netapp/volumes/snapshots/help new file mode 100644 index 000000000..9445e3dc6 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/snapshots/help @@ -0,0 +1,39 @@ +NAME + gcloud alpha netapp volumes snapshots - create and manage Cloud NetApp + Volume Snapshots + +SYNOPSIS + gcloud alpha netapp volumes snapshots COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create and manage Cloud NetApp Volume Snapshots. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Creates a Cloud NetApp Volume Snapshot. + + delete + (ALPHA) Deletes a Cloud NetApp Volume Snapshot. + + describe + (ALPHA) Describes a Cloud NetApp Volume Snapshot. + + list + (ALPHA) List Cloud NetApp Volume Snapshots. + + update + (ALPHA) Creates a Cloud NetApp Volume Snapshot. + +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. + diff --git a/gcloud/alpha/netapp/volumes/snapshots/list b/gcloud/alpha/netapp/volumes/snapshots/list new file mode 100644 index 000000000..f630845c4 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/snapshots/list @@ -0,0 +1,103 @@ +NAME + gcloud alpha netapp volumes snapshots list - list Cloud NetApp Volume + Snapshots + +SYNOPSIS + gcloud alpha netapp volumes snapshots list [--location=LOCATION] + [--volume=VOLUME] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Cloud NetApp Volume Snapshots. + +FLAGS + Location resource - The location in which to list Volume Snapshots. 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 --location on the command line with a fully + specified name; + ◆ uses all locations by default. with a fully specified name; + ◆ set the property netapp/location with a fully specified name; + ◆ set the property netapp/region with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ uses all locations by default.; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + + Volume resource - The Volume to take a Snapshot of. 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 --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + --volume=VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument --volume on the command line; + ▸ provide the argument --snapshot-volume 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. + +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. + diff --git a/gcloud/alpha/netapp/volumes/snapshots/update b/gcloud/alpha/netapp/volumes/snapshots/update new file mode 100644 index 000000000..a685c32b6 --- /dev/null +++ b/gcloud/alpha/netapp/volumes/snapshots/update @@ -0,0 +1,123 @@ +NAME + gcloud alpha netapp volumes snapshots update - creates a Cloud NetApp + Volume Snapshot + +SYNOPSIS + gcloud alpha netapp volumes snapshots update + (SNAPSHOT : --location=LOCATION --snapshot-volume=SNAPSHOT_VOLUME) + [--async] [--description=DESCRIPTION] [--update-labels=[KEY=VALUE,...]] + [--volume=VOLUME] [--clear-labels | --remove-labels=[KEY,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creates a Cloud NetApp Volume Snapshot. + +POSITIONAL ARGUMENTS + Snapshot resource - The Snapshot to update. 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 snapshot 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. + + SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument snapshot on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the snapshot. To set the location attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + + --snapshot-volume=SNAPSHOT_VOLUME + The volume of the snapshot To set the volume attribute: + ▸ provide the argument snapshot on the command line with a fully + specified name; + ▸ provide the argument --snapshot-volume on the command line; + ▸ provide the argument --volume on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + A description of the Cloud NetApp Snapshot + + --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. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + Volume resource - The Volume to take a Snapshot of. 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 --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --volume on the command line with a fully + specified name; + ◆ provide the argument --snapshot-volume on the command line with a + fully specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + --volume=VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument --volume on the command line; + ▸ provide the argument --snapshot-volume on the command line. + + 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 alpha netapp volumes snapshots update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud alpha netapp volumes snapshots 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. + +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. + diff --git a/gcloud/alpha/netapp/volumes/update b/gcloud/alpha/netapp/volumes/update new file mode 100644 index 000000000..a145293ab --- /dev/null +++ b/gcloud/alpha/netapp/volumes/update @@ -0,0 +1,247 @@ +NAME + gcloud alpha netapp volumes update - update a Cloud NetApp Volume + +SYNOPSIS + gcloud alpha netapp volumes update (VOLUME : --location=LOCATION) + --from-snapshot=FROM_SNAPSHOT --storage-pool=STORAGE_POOL [--async] + [--capacity=CAPACITY] [--description=DESCRIPTION] + [--enable-kerberos=ENABLE_KERBEROS] [--enable-ldap=ENABLE_LDAP] + [--export-policy=[access-type=ACCESS-TYPE], + [allowed-clients=ALLOWED-CLIENTS],[has-root-access=HAS-ROOT-ACCESS], + [kerberos-5-read-only=KERBEROS-5-READ-ONLY], + [kerberos-5-read-write=KERBEROS-5-READ-WRITE], + [kerberos-5i-read-only=KERBEROS-5I-READ-ONLY], + [kerberos-5i-read-write=KERBEROS-5I-READ-WRITE], + [kerberos-5p-read-only=KERBEROS-5P-READ-ONLY], + [kerberos-5p-read-write=KERBEROS-5P-READ-WRITE], + [nfsv3=NFSV3],[nfsv4=NFSV4]] + [--network=[name=NAME],[reserved-ip-range=RESERVED-IP-RANGE]] + [--protocols=PROTOCOL,[PROTOCOL,...]] + [--security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED"] + [--share-name=SHARE_NAME] + [--smb-settings=SMB_SETTING,[SMB_SETTING,...]] + [--snap-reserve=SNAP_RESERVE] + [--snapshot-daily=[hour=HOUR], + [minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--snapshot-directory=SNAPSHOT_DIRECTORY; default="true"] + [--snapshot-hourly=[minute=MINUTE], + [snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--snapshot-monthly=[day=DAY], + [hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--snapshot-weekly=[day=DAY], + [hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP]] + [--unix-permissions=UNIX_PERMISSIONS] [--update-labels=[KEY=VALUE,...]] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud NetApp Volume. + +POSITIONAL ARGUMENTS + Volume resource - The Volume to update. 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 volume 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. + + VOLUME + ID of the volume or fully qualified identifier for the volume. To set + the volume attribute: + ▸ provide the argument volume on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the volume. To set the location attribute: + ▸ provide the argument volume on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property netapp/location; + ▸ set the property netapp/region. + +FLAGS + Snapshot resource - The Snapshot to create the Volume from. 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 --from-snapshot on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --from-snapshot on the command line with a fully + specified name; + ◆ set the property netapp/location; + ◆ set the property netapp/region. To set the volume attribute: + ◆ provide the argument --from-snapshot on the command line with a fully + specified name. + + --from-snapshot=FROM_SNAPSHOT + ID of the snapshot or fully qualified identifier for the snapshot. To + set the snapshot attribute: + ▸ provide the argument --from-snapshot on the command line. + + Storage pool resource - The Storage Pool to associate with Volume. 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 --storage-pool on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the location attribute: + ◆ provide the argument --storage-pool on the command line with a fully + specified name; + ◆ provide the argument --location on the command line; + ◆ set the property netapp/location; + ◆ set the property netapp/region. + + --storage-pool=STORAGE_POOL + ID of the storage_pool or fully qualified identifier for the + storage_pool. To set the storage_pool attribute: + ▸ provide the argument --storage-pool on the command line. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --capacity=CAPACITY + The desired capacity of the Volume in GiB or TiB units.If no capacity + unit is specified, GiB is assumed. + + --description=DESCRIPTION + A description of the Cloud NetApp Volume + + --enable-kerberos=ENABLE_KERBEROS + Boolean flag indicating whether Volume is a kerberos Volume or not + + --enable-ldap=ENABLE_LDAP + Boolean flag indicating whether Volume is a NFS LDAP Volume or not + + --export-policy=[access-type=ACCESS-TYPE],[allowed-clients=ALLOWED-CLIENTS],[has-root-access=HAS-ROOT-ACCESS],[kerberos-5-read-only=KERBEROS-5-READ-ONLY],[kerberos-5-read-write=KERBEROS-5-READ-WRITE],[kerberos-5i-read-only=KERBEROS-5I-READ-ONLY],[kerberos-5i-read-write=KERBEROS-5I-READ-WRITE],[kerberos-5p-read-only=KERBEROS-5P-READ-ONLY],[kerberos-5p-read-write=KERBEROS-5P-READ-WRITE],[nfsv3=NFSV3],[nfsv4=NFSV4] + Export Policy of a Cloud NetApp Files Volume. This will be a field + similar to network in which export policy fields can be specified as + such: --export-policy=allowed-clients=ALLOWED_CLIENTS_IP_ADDRESSES, + has-root-access=HAS_ROOT_ACCESS_BOOL,access=ACCESS_TYPE,nfsv3=NFSV3, + nfsv4=NFSV4,kerberos-5-read-only=KERBEROS_5_READ_ONLY, + kerberos-5-read-write=KERBEROS_5_READ_WRITE, + kerberos-5i-read-only=KERBEROS_5I_READ_ONLY, + kerberos-5i-read-write=KERBEROS_5I_READ_WRITE, + kerberos-5p-read-only=KERBEROS_5P_READ_ONLY, + kerberos-5p-read-write=KERBEROS_5P_READ_WRITE + + --network=[name=NAME],[reserved-ip-range=RESERVED-IP-RANGE] + Network configuration for a Cloud NetApp Files Volume. Specifying + reserved-ip-range is optional. + name + The name of the Google Compute Engine VPC network to which the + instance is connected. + reserved-ip-range + The reserved-ip-range can have an allocated IP address range + (https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address). + When the name of an allocated IP address range is specified, it + must be one of the ranges associated with the private service + access connection. The range you specify can't overlap with either + existing subnets or assigned IP address ranges for other Cloud + NetApp Files Volumes in the selected VPC network. + + --protocols=PROTOCOL,[PROTOCOL,...] + Type of File System protocols for the Cloud NetApp Files VolumeValid + component values are: NFSV3, NFSV4, SMB + + For more information, look athttps://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#protocols. + + --security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED" + The security style of the Volume. This can either be UNIX or NTFS. + + SECURITY_STYLE must be one of: + + ntfs + NTFS security style for Volume. + unix + UNIX security style for Volume + + --share-name=SHARE_NAME + Share name of the Mount path clients will use. + + --smb-settings=SMB_SETTING,[SMB_SETTING,...] + List of settings specific to SMB protocolfor a Cloud NetApp Files + VolumeValid component values are: ENCRYPT_DATA, BROWSABLE, + CHANGE_NOTIFY, 'NON_BROWSABLE', 'OPLOCKS', 'SHOW_SNAPSHOT', + 'SHOW_PREVIOUS_VERSIONS', 'ACCESS_BASED_ENUMERATION', + 'CONTINUOUSLY_AVAILABLE' + + For more information, look athttps://cloud.google.com/netapp/docs/reference/rest/v1alpha1/projects.locations.volumes#smbsettings. + + --snap-reserve=SNAP_RESERVE + The percentage of volume storage reserved for snapshot storage. The + default value for this is 0 percent + + --snapshot-daily=[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot every day e.g. at 06:00, 05:20, 23:50 + + --snapshot-directory=SNAPSHOT_DIRECTORY; default="true" + Snapshot Directory if enabled (true) makes the Volume contain a + read-only .snapshot directory which provides access to each of the + volume's snapshots + + --snapshot-hourly=[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot every hour e.g. at 04:00, 05:20, 06:00 + + --snapshot-monthly=[day=DAY],[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot once a month e.g. at 2nd 04:00, 7th 05:20, 24th 23:50 + + --snapshot-weekly=[day=DAY],[hour=HOUR],[minute=MINUTE],[snapshots-to-keep=SNAPSHOTS-TO-KEEP] + Make a snapshot every week e.g. at Monday 04:00, Wednesday 05:20, + Sunday 23:50 + + --unix-permissions=UNIX_PERMISSIONS + Unix permissions the mount point will be created with.Unix permissions + are only applicable with NFS protocol only + + --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. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + 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 alpha netapp volumes update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud alpha netapp volumes 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. + +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. + diff --git a/gcloud/alpha/network-connectivity/help b/gcloud/alpha/network-connectivity/help index 29e144248..f591af35a 100644 --- a/gcloud/alpha/network-connectivity/help +++ b/gcloud/alpha/network-connectivity/help @@ -20,7 +20,7 @@ GROUPS (ALPHA) Manage Network Connectivity Center hubs. internal-ranges - (ALPHA) Manage Internal Ranges. + (ALPHA) Manage internal ranges. policy-based-routes (ALPHA) Manage Policy Based Routes. diff --git a/gcloud/alpha/network-connectivity/internal-ranges/create b/gcloud/alpha/network-connectivity/internal-ranges/create index 0a05621d8..e9c1785cc 100644 --- a/gcloud/alpha/network-connectivity/internal-ranges/create +++ b/gcloud/alpha/network-connectivity/internal-ranges/create @@ -52,7 +52,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The location Id. + The location ID. To set the region attribute: ▸ provide the argument internal_range on the command line with a @@ -116,14 +116,14 @@ OPTIONAL FLAGS This behavior can be set when the internal range is being reserved for usage by the peers. This means that no resource within the VPC in which it is being created can use this to associate with a cloud - resource, but one of the peer's can. This represents "donating" a + resource, but one of the peers can. This represents "donating" a range for peers to use. for-self This beharior represents the case that the internal range is intended to be used in the VPC on which it is created and is - accessible from it's peers. This implies that peers or - peer-of-peer's cannot use this range. + accessible from its peers. This implies that peers or peer-of-peers + cannot use this range. not-shared This behavior can be set when the internal range is being reserved @@ -131,7 +131,7 @@ OPTIONAL FLAGS peers. In a sense it is local to the VPC. This can be used to create internal ranges for various purposes like HTTP_INTERNAL_LOAD_BALANCER or for interconnect routes that are not - shared with peers. This also implies that peer's cannot use this + shared with peers. This also implies that peers cannot use this range in a way that is visible to this VPC, but can re-use this range as long as it is NOT_SHARED from the peer VPC too. @@ -165,5 +165,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud network-connectivity internal-ranges create diff --git a/gcloud/alpha/network-connectivity/internal-ranges/delete b/gcloud/alpha/network-connectivity/internal-ranges/delete index e37d72205..78604a728 100644 --- a/gcloud/alpha/network-connectivity/internal-ranges/delete +++ b/gcloud/alpha/network-connectivity/internal-ranges/delete @@ -35,7 +35,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The location Id. + The location ID. To set the region attribute: ▸ provide the argument internal_range on the command line with a @@ -65,5 +65,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud network-connectivity internal-ranges delete diff --git a/gcloud/alpha/network-connectivity/internal-ranges/describe b/gcloud/alpha/network-connectivity/internal-ranges/describe index fae49fbdd..8a1a63f85 100644 --- a/gcloud/alpha/network-connectivity/internal-ranges/describe +++ b/gcloud/alpha/network-connectivity/internal-ranges/describe @@ -35,7 +35,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The location Id. + The location ID. To set the region attribute: ▸ provide the argument internal_range on the command line with a @@ -60,5 +60,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud network-connectivity internal-ranges describe diff --git a/gcloud/alpha/network-connectivity/internal-ranges/help b/gcloud/alpha/network-connectivity/internal-ranges/help index 90f496b0f..7e53934d4 100644 --- a/gcloud/alpha/network-connectivity/internal-ranges/help +++ b/gcloud/alpha/network-connectivity/internal-ranges/help @@ -1,12 +1,12 @@ NAME - gcloud alpha network-connectivity internal-ranges - manage Internal Ranges + gcloud alpha network-connectivity internal-ranges - manage internal ranges SYNOPSIS gcloud alpha network-connectivity internal-ranges COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Manage Internal Ranges. + (ALPHA) Manage internal ranges. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -35,5 +35,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud network-connectivity internal-ranges diff --git a/gcloud/alpha/network-connectivity/internal-ranges/list b/gcloud/alpha/network-connectivity/internal-ranges/list index dd9eddcfc..e5b582456 100644 --- a/gcloud/alpha/network-connectivity/internal-ranges/list +++ b/gcloud/alpha/network-connectivity/internal-ranges/list @@ -76,5 +76,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud network-connectivity internal-ranges list diff --git a/gcloud/alpha/network-connectivity/internal-ranges/update b/gcloud/alpha/network-connectivity/internal-ranges/update index cad2ffc79..8b73467be 100644 --- a/gcloud/alpha/network-connectivity/internal-ranges/update +++ b/gcloud/alpha/network-connectivity/internal-ranges/update @@ -9,7 +9,7 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Update the detail of an internal range. + (ALPHA) Update the details of an internal range. EXAMPLES Update ip-cidr-range of an internal range named my-range: @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --region=REGION - The location Id. + The location ID. To set the region attribute: ▸ provide the argument internal_range on the command line with a @@ -83,5 +83,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud network-connectivity internal-ranges update diff --git a/gcloud/alpha/network-management/help b/gcloud/alpha/network-management/help new file mode 100644 index 000000000..d8dc92acd --- /dev/null +++ b/gcloud/alpha/network-management/help @@ -0,0 +1,24 @@ +NAME + gcloud alpha network-management - manage Network Management resources + +SYNOPSIS + gcloud alpha network-management GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Network Management resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + 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 network-management + + $ gcloud beta network-management + diff --git a/gcloud/alpha/network-security/gateway-security-policies/delete b/gcloud/alpha/network-security/gateway-security-policies/delete new file mode 100644 index 000000000..7c3c1895c --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/delete @@ -0,0 +1,71 @@ +NAME + gcloud alpha network-security gateway-security-policies delete - delete + GatewaySecurityPolicy + +SYNOPSIS + gcloud alpha network-security gateway-security-policies delete + (GATEWAY_SECURITY_POLICY : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete the specified GatewaySecurityPolicy. + +EXAMPLES + To delete a GatewaySecurityPolicy called 'my-gateway-security-policy', run: + + $ gcloud alpha network-security gateway-security-policies delete \ + my-gateway-security-policy --location=global + +POSITIONAL ARGUMENTS + Gateway security policy resource - Name of the GatewaySecurityPolicy you + want 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 gateway_security_policy on the command line with + a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + GATEWAY_SECURITY_POLICY + ID of the gateway security policy or fully qualified identifier for + the gateway security policy. To set the gateway_security_policy + attribute: + ▸ provide the argument gateway_security_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument gateway_security_policy on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/export b/gcloud/alpha/network-security/gateway-security-policies/export new file mode 100644 index 000000000..2f7eb3391 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/export @@ -0,0 +1,75 @@ +NAME + gcloud alpha network-security gateway-security-policies export - export + GatewaySecurityPolicy + +SYNOPSIS + gcloud alpha network-security gateway-security-policies export + (GATEWAY_SECURITY_POLICY : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export a GatewaySecurityPolicy. + +EXAMPLES + To export a GatewaySecurityPolicy, run: + + $ gcloud alpha network-security gateway-security-policies export \ + my-gateway-security-policy \ + --destination=my-gateway-security-policy-list.yaml \ + --location=global + +POSITIONAL ARGUMENTS + Gateway security policy resource - Name of the GatewaySecurityPolicy to + export. 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 gateway_security_policy on the command line with + a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + GATEWAY_SECURITY_POLICY + ID of the gateway security policy or fully qualified identifier for + the gateway security policy. To set the gateway_security_policy + attribute: + ▸ provide the argument gateway_security_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument gateway_security_policy on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/help b/gcloud/alpha/network-security/gateway-security-policies/help new file mode 100644 index 000000000..fee292583 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/help @@ -0,0 +1,43 @@ +NAME + gcloud alpha network-security gateway-security-policies - manage Network + Security GatewaySecurityPolicies + +SYNOPSIS + gcloud alpha network-security gateway-security-policies GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Network Security GatewaySecurityPolicies. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + rules + (ALPHA) Manage Network Security GatewaySecurityPolicyRules. + +COMMANDS + COMMAND is one of the following: + + delete + (ALPHA) Delete GatewaySecurityPolicy. + + export + (ALPHA) Export GatewaySecurityPolicy. + + import + (ALPHA) Import GatewaySecurityPolicy. + + list + (ALPHA) List GatewaySecurityPolicies. + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/import b/gcloud/alpha/network-security/gateway-security-policies/import new file mode 100644 index 000000000..8fd6c0c93 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/import @@ -0,0 +1,81 @@ +NAME + gcloud alpha network-security gateway-security-policies import - import + GatewaySecurityPolicy + +SYNOPSIS + gcloud alpha network-security gateway-security-policies import + (GATEWAY_SECURITY_POLICY : --location=LOCATION) [--async] + [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import a GatewaySecurityPolicy. + +EXAMPLES + To import a GatewaySecurityPolicy from a YAML file, run: + + $ gcloud alpha network-security gateway-security-policies import \ + my-gateway-security-policy \ + --source=my-gateway-security-policy-list.yaml --location=global + +POSITIONAL ARGUMENTS + Gateway security policy resource - Name of the GatewaySecurityPolicy to + import. 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 gateway_security_policy on the command line with + a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + GATEWAY_SECURITY_POLICY + ID of the gateway security policy or fully qualified identifier for + the gateway security policy. To set the gateway_security_policy + attribute: + ▸ provide the argument gateway_security_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument gateway_security_policy on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/list b/gcloud/alpha/network-security/gateway-security-policies/list new file mode 100644 index 000000000..06a088da3 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/list @@ -0,0 +1,87 @@ +NAME + gcloud alpha network-security gateway-security-policies list - list + GatewaySecurityPolicies + +SYNOPSIS + gcloud alpha network-security gateway-security-policies list + --location=LOCATION [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all GatewaySecurityPolicies in the specified location of the + current project. + +EXAMPLES + To list GatewaySecurityPolicies in the current project, run: + + $ gcloud alpha network-security gateway-security-policies list \ + --location=global + +REQUIRED FLAGS + Location resource - The project of the GatewaySecurityPolicies to display. + 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 --location on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location 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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/rules/delete b/gcloud/alpha/network-security/gateway-security-policies/rules/delete new file mode 100644 index 000000000..ba89549d2 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/rules/delete @@ -0,0 +1,82 @@ +NAME + gcloud alpha network-security gateway-security-policies rules delete - + delete GatewaySecurityPolicyRule + +SYNOPSIS + gcloud alpha network-security gateway-security-policies rules delete + (GATEWAY_SECURITY_POLICY_RULE + : --gateway-security-policy=GATEWAY_SECURITY_POLICY + --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete the specified GatewaySecurityPolicyRule. + +EXAMPLES + To delete a GatewaySecurityPolicyRule called 'my-rule', run: + + $ gcloud alpha network-security gateway-security-policies rules \ + delete my-rule --location={region} \ + --gateway-security-policy={policy-name} + +POSITIONAL ARGUMENTS + Gateway security policy rule resource - Name of the + GatewaySecurityPolicyRule you want 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 gateway_security_policy_rule on the command line + with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + GATEWAY_SECURITY_POLICY_RULE + ID of the gateway security policy rule or fully qualified identifier + for the gateway security policy rule. To set the + gateway_security_policy_rule attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --gateway-security-policy=GATEWAY_SECURITY_POLICY + Id of the gateway security policy. To set the gateway-security-policy + attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line with a fully specified name; + ▸ provide the argument --gateway-security-policy on the command + line. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line with a fully specified name; + ▸ provide the argument --location on the command line. + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/rules/export b/gcloud/alpha/network-security/gateway-security-policies/rules/export new file mode 100644 index 000000000..047bc50f7 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/rules/export @@ -0,0 +1,86 @@ +NAME + gcloud alpha network-security gateway-security-policies rules export - + export GatewaySecurityPolicyRule + +SYNOPSIS + gcloud alpha network-security gateway-security-policies rules export + (GATEWAY_SECURITY_POLICY_RULE + : --gateway-security-policy=GATEWAY_SECURITY_POLICY + --location=LOCATION) [--destination=DESTINATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export a GatewaySecurityPolicyRule. + +EXAMPLES + To export a GatewaySecurityPolicyRule, run: + + $ gcloud alpha network-security gateway-security-policies rules \ + export my-rule --destination=my-rule.yaml --location={region} \ + --gateway-security-policy={policy-name} + +POSITIONAL ARGUMENTS + Gateway security policy rule resource - Name of the + GatewaySecurityPolicyRule to export. 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 gateway_security_policy_rule on the command line + with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + GATEWAY_SECURITY_POLICY_RULE + ID of the gateway security policy rule or fully qualified identifier + for the gateway security policy rule. To set the + gateway_security_policy_rule attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --gateway-security-policy=GATEWAY_SECURITY_POLICY + Id of the gateway security policy. To set the gateway-security-policy + attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line with a fully specified name; + ▸ provide the argument --gateway-security-policy on the command + line. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line with a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/rules/help b/gcloud/alpha/network-security/gateway-security-policies/rules/help new file mode 100644 index 000000000..4af602be1 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/rules/help @@ -0,0 +1,37 @@ +NAME + gcloud alpha network-security gateway-security-policies rules - manage + Network Security GatewaySecurityPolicyRules + +SYNOPSIS + gcloud alpha network-security gateway-security-policies rules COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Network Security GatewaySecurityPolicyRules. + +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 GatewaySecurityPolicyRule. + + export + (ALPHA) Export GatewaySecurityPolicyRule. + + import + (ALPHA) Import GatewaySecurityPolicy. + + list + (ALPHA) List GatewaySecurityPolicyRules. + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/rules/import b/gcloud/alpha/network-security/gateway-security-policies/rules/import new file mode 100644 index 000000000..6ae8ee7f9 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/rules/import @@ -0,0 +1,93 @@ +NAME + gcloud alpha network-security gateway-security-policies rules import - + import GatewaySecurityPolicy + +SYNOPSIS + gcloud alpha network-security gateway-security-policies rules import + (GATEWAY_SECURITY_POLICY_RULE + : --gateway-security-policy=GATEWAY_SECURITY_POLICY + --location=LOCATION) [--async] [--source=SOURCE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import a GatewaySecurityPolicy. + +EXAMPLES + To import a GatewaySecurityPolicy from a YAML file, run: + + $ gcloud alpha network-security gateway-security-policies rules \ + import my-rule --source=my-rule.yaml --location={region} \ + --gateway-security-policy={policy-name} + +POSITIONAL ARGUMENTS + Gateway security policy rule resource - Name of the GatewaySecurityPolicy + to import. 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 gateway_security_policy_rule on the command line + with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + GATEWAY_SECURITY_POLICY_RULE + ID of the gateway security policy rule or fully qualified identifier + for the gateway security policy rule. To set the + gateway_security_policy_rule attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --gateway-security-policy=GATEWAY_SECURITY_POLICY + Id of the gateway security policy. To set the gateway-security-policy + attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line with a fully specified name; + ▸ provide the argument --gateway-security-policy on the command + line. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument gateway_security_policy_rule on the command + line with a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/gateway-security-policies/rules/list b/gcloud/alpha/network-security/gateway-security-policies/rules/list new file mode 100644 index 000000000..6c36bb585 --- /dev/null +++ b/gcloud/alpha/network-security/gateway-security-policies/rules/list @@ -0,0 +1,102 @@ +NAME + gcloud alpha network-security gateway-security-policies rules list - list + GatewaySecurityPolicyRules + +SYNOPSIS + gcloud alpha network-security gateway-security-policies rules list + (--gateway-security-policy=GATEWAY_SECURITY_POLICY + : --location=LOCATION) [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all GatewaySecurityPolicyRules in the specified location of + the current project. + +EXAMPLES + To list GatewaySecurityPolicyRules in the current project, run: + + $ gcloud alpha network-security gateway-security-policies rules \ + list --location={region} --gateway-security-policy={policy-name} + +REQUIRED FLAGS + Gateway security policy resource - The project of the + GatewaySecurityPolicyRules to display. 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 --gateway-security-policy on the command line + with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --gateway-security-policy=GATEWAY_SECURITY_POLICY + ID of the gateway security policy or fully qualified identifier for + the gateway security policy. To set the gateway-security-policy + attribute: + ▸ provide the argument --gateway-security-policy on the command + line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument --gateway-security-policy on the command + line with a fully specified name; + ▸ provide the argument --location 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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/help b/gcloud/alpha/network-security/help index d4db817bb..7efe43a16 100644 --- a/gcloud/alpha/network-security/help +++ b/gcloud/alpha/network-security/help @@ -21,9 +21,15 @@ GROUPS client-tls-policies (ALPHA) Manage Network Security ClientTlsPolicies. + gateway-security-policies + (ALPHA) Manage Network Security GatewaySecurityPolicies. + server-tls-policies (ALPHA) Manage Network Security ServerTlsPolicies. + url-lists + (ALPHA) Manage Network Security UrlLists. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/network-security/url-lists/delete b/gcloud/alpha/network-security/url-lists/delete new file mode 100644 index 000000000..babf11c0f --- /dev/null +++ b/gcloud/alpha/network-security/url-lists/delete @@ -0,0 +1,67 @@ +NAME + gcloud alpha network-security url-lists delete - delete UrlList + +SYNOPSIS + gcloud alpha network-security url-lists delete + (URL_LIST : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete the specified UrlList. + +EXAMPLES + To delete a UrlList called 'my-url-list', run: + + $ gcloud alpha network-security url-lists delete my-url-list \ + --location=global + +POSITIONAL ARGUMENTS + Url list resource - Name of the UrlList you want 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 url_list on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + URL_LIST + ID of the url list or fully qualified identifier for the url list. To + set the url_list attribute: + ▸ provide the argument url_list on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument url_list on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/url-lists/export b/gcloud/alpha/network-security/url-lists/export new file mode 100644 index 000000000..9215299bb --- /dev/null +++ b/gcloud/alpha/network-security/url-lists/export @@ -0,0 +1,71 @@ +NAME + gcloud alpha network-security url-lists export - export UrlList + +SYNOPSIS + gcloud alpha network-security url-lists export + (URL_LIST : --location=LOCATION) [--destination=DESTINATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Export a UrlList. + +EXAMPLES + To export a UrlList, run: + + $ gcloud alpha network-security url-lists export my-url-list \ + --destination=my-url-list.yaml --location=global + +POSITIONAL ARGUMENTS + Url list resource - Name of the UrlList to export. 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 url_list on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + URL_LIST + ID of the url list or fully qualified identifier for the url list. To + set the url_list attribute: + ▸ provide the argument url_list on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument url_list on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/url-lists/help b/gcloud/alpha/network-security/url-lists/help new file mode 100644 index 000000000..f6e5527a1 --- /dev/null +++ b/gcloud/alpha/network-security/url-lists/help @@ -0,0 +1,35 @@ +NAME + gcloud alpha network-security url-lists - manage Network Security UrlLists + +SYNOPSIS + gcloud alpha network-security url-lists COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Network Security UrlLists. + +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 UrlList. + + export + (ALPHA) Export UrlList. + + import + (ALPHA) Import UrlList. + + list + (ALPHA) List UrlLists. + +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. + diff --git a/gcloud/alpha/network-security/url-lists/import b/gcloud/alpha/network-security/url-lists/import new file mode 100644 index 000000000..8738da055 --- /dev/null +++ b/gcloud/alpha/network-security/url-lists/import @@ -0,0 +1,78 @@ +NAME + gcloud alpha network-security url-lists import - import UrlList + +SYNOPSIS + gcloud alpha network-security url-lists import + (URL_LIST : --location=LOCATION) [--async] [--source=SOURCE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Import a UrlList. + +EXAMPLES + To import a UrlList from a YAML file, run: + + $ gcloud alpha network-security url-lists import my-url-list \ + --source=my-url-list.yaml --location=global + +POSITIONAL ARGUMENTS + Url list resource - Name of the UrlList to import. 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 url_list on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + URL_LIST + ID of the url list or fully qualified identifier for the url list. To + set the url_list attribute: + ▸ provide the argument url_list on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument url_list on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/network-security/url-lists/list b/gcloud/alpha/network-security/url-lists/list new file mode 100644 index 000000000..be9406a04 --- /dev/null +++ b/gcloud/alpha/network-security/url-lists/list @@ -0,0 +1,83 @@ +NAME + gcloud alpha network-security url-lists list - list UrlLists + +SYNOPSIS + gcloud alpha network-security url-lists list --location=LOCATION + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all UrlLists in the specified location of the current project. + +EXAMPLES + To list UrlLists in the current project, run: + + $ gcloud alpha network-security url-lists list --location=global + +REQUIRED FLAGS + Location resource - The project of the UrlLists to display. 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 --location on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location 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 networksecurity/v1alpha1 API. The full documentation + for this API can be found at: https://cloud.google.com/networking + +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. + diff --git a/gcloud/alpha/notebooks/instances/create b/gcloud/alpha/notebooks/instances/create index 10e7eb920..31533433b 100644 --- a/gcloud/alpha/notebooks/instances/create +++ b/gcloud/alpha/notebooks/instances/create @@ -15,6 +15,8 @@ SYNOPSIS [--metadata=[KEY=VALUE,...]] [--post-startup-script=POST_STARTUP_SCRIPT] [--service-account=SERVICE_ACCOUNT] + [--no-shielded-integrity-monitoring] [--shielded-secure-boot] + [--no-shielded-vtpm] [--accelerator-core-count=ACCELERATOR_CORE_COUNT --accelerator-type=ACCELERATOR_TYPE] [--boot-disk-size=BOOT_DISK_SIZE --boot-disk-type=BOOT_DISK_TYPE] @@ -23,7 +25,9 @@ SYNOPSIS : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]] [--network=NETWORK : --no-proxy-access --no-public-ip [--subnet=SUBNET - : --subnet-region=SUBNET_REGION]] [GCLOUD_WIDE_FLAG ...] + : --subnet-region=SUBNET_REGION]] + [--reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; + default="TYPE_UNSPECIFIED"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Request for creating notebook instances. @@ -181,6 +185,17 @@ OPTIONAL FLAGS the instance. If not specified, the Compute Engine default service account is used. + --shielded-integrity-monitoring + Enable monitoring of the boot integrity of the instance. Enabled by + default, use --no-shielded-integrity-monitoring to disable. + + --shielded-secure-boot + Boot instance with secure boot enabled. Disabled by default. + + --shielded-vtpm + Boot instance with TPM (Trusted Platform Module) enabled. Enabled by + default, use --no-shielded-vtpm to disable. + The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the `machine_type` you have selected. @@ -307,6 +322,17 @@ OPTIONAL FLAGS specified name; ▫ provide the argument --subnet-region on the command line. + Specifies the reservation for the instance. + + --reservation=RESERVATION + The name of the reservation, required when + --reservation-affinity=SPECIFIC_RESERVATION. + + --reservation-affinity=RESERVATION_AFFINITY; default="TYPE_UNSPECIFIED" + The type of reservation for the instance. RESERVATION_AFFINITY must + be one of: TYPE_UNSPECIFIED, NO_RESERVATION, ANY_RESERVATION, + SPECIFIC_RESERVATION. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/notebooks/instances/diagnose b/gcloud/alpha/notebooks/instances/diagnose new file mode 100644 index 000000000..bf28abf9e --- /dev/null +++ b/gcloud/alpha/notebooks/instances/diagnose @@ -0,0 +1,107 @@ +NAME + gcloud alpha notebooks instances diagnose - request for diagnose instances + +SYNOPSIS + gcloud alpha notebooks instances diagnose (INSTANCE : --location=LOCATION) + --gcs-bucket=GCS_BUCKET [--async] [--enable-copy-home-files] + [--enable-packet-capture] [--enable-repair] + [--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Request for diagnose notebook instances. + +EXAMPLES + To diagnose an instance, run: + + $ gcloud alpha notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket + + To diagnose an instance with a relative path: + + $ gcloud alpha notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket \ + --relative-path=logs + + To diagnose an instance, with packet capture: + + $ gcloud alpha notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket \ + --enable-packet-capture + +POSITIONAL ARGUMENTS + Instance resource - User-defined unique name of this instance. The + instance name must be 1 to 63 characters long and contain only lowercase + letters, numeric characters, and dashes. The first character must be a + lowercase letter and the last character cannot be a dash. 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 instance 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. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. To + set the instance attribute: + ▸ provide the argument instance on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location of this environment + https://cloud.google.com/compute/docs/regions-zones/#locations. To + set the location attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property notebooks/location. + +REQUIRED FLAGS + --gcs-bucket=GCS_BUCKET + The Cloud Storage bucket where the log files generated from the + diagnose command will be stored. storage.buckets.writer permissions + must be given to project's service account or user credential. Format: + gs://{gcs_bucket} + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --enable-copy-home-files + Enables flag to copy all /home/jupyter folder contents + + --enable-packet-capture + Enables flag to capture packets from the instance for 30 seconds + + --enable-repair + Enables flag to repair service for instance + + --relative-path=RELATIVE_PATH + Defines the relative storage path in the Cloud Storage bucket where the + diagnostic logs will be written. Default path will be the root + directory of the Cloud Storage bucketFormat of full path: + gs://{gcs_bucket}/{relative_path}/ + +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 notebooks instances diagnose + + $ gcloud beta notebooks instances diagnose + diff --git a/gcloud/alpha/notebooks/instances/help b/gcloud/alpha/notebooks/instances/help index 3310b68a2..374e277dd 100644 --- a/gcloud/alpha/notebooks/instances/help +++ b/gcloud/alpha/notebooks/instances/help @@ -27,6 +27,9 @@ COMMANDS describe (ALPHA) Request for describing instances. + diagnose + (ALPHA) Request for diagnose instances. + get-iam-policy (ALPHA) Get IAM policy for an instance. diff --git a/gcloud/alpha/pubsub/lite-subscriptions/create b/gcloud/alpha/pubsub/lite-subscriptions/create index b35287371..2dd8cddb9 100644 --- a/gcloud/alpha/pubsub/lite-subscriptions/create +++ b/gcloud/alpha/pubsub/lite-subscriptions/create @@ -6,7 +6,11 @@ SYNOPSIS gcloud alpha pubsub lite-subscriptions create SUBSCRIPTION --topic=TOPIC [--delivery-requirement=DELIVERY_REQUIREMENT; default="deliver-immediately"] [--location=LOCATION] - [--starting-offset=STARTING_OFFSET; default="end"] + [--event-time=EVENT_TIME | --publish-time=PUBLISH_TIME + | --starting-offset=STARTING_OFFSET; default="end"] + [--export-pubsub-topic=EXPORT_PUBSUB_TOPIC + : --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + --export-desired-state=EXPORT_DESIRED_STATE; default="active"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -25,6 +29,13 @@ EXAMPLES --location=us-central1-a --topic=mytopic \ --starting-offset=beginning + To create a Pub/Sub Lite subscription that exports messages from a Pub/Sub + Lite topic to a Pub/Sub topic, run: + + $ gcloud alpha pubsub lite-subscriptions create mysubscription \ + --location=us-central1-a --topic=mytopic \ + --export-pubsub-topic=pubsubtopic + POSITIONAL ARGUMENTS SUBSCRIPTION Subscription ID. @@ -58,11 +69,43 @@ OPTIONAL FLAGS ▸ provide the argument --location on the command line; ▸ provide the argument --zone on the command line. - --starting-offset=STARTING_OFFSET; default="end" - The offset at which a newly created or seeked subscription will start - receiving messages. A subscription can be initialized at the offset of - the oldest retained message (beginning), or at the current HEAD offset - (end). STARTING_OFFSET must be one of: beginning, end. + At most one of these can be specified: + + --event-time=EVENT_TIME + The event time to which you seek a subscription. The subscription + seeks to the first message with event time greater than or equal to + the specified event time. Messages missing an event time use publish + time as a fallback. As event times are user supplied, subsequent + messages may have event times less than the specified event time and + must be filtered by the client, if necessary. Run $ gcloud topic + datetimes for information on time formats. + + --publish-time=PUBLISH_TIME + The publish time to which you seek a subscription. Messages with + publish time greater than or equal to the specified time are + delivered after the seek operation. Run $ gcloud topic datetimes for + information on time formats. + + --starting-offset=STARTING_OFFSET; default="end" + The offset at which a newly created or seeked subscription starts + receiving messages. A subscription can be initialized at the offset + of the oldest retained message (beginning), or at the current HEAD + offset (end). STARTING_OFFSET must be one of: beginning, end. + + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC + The name of the destination Pub/Sub topic to which messages are + exported. Must be the topic's fully specified path if it is not in the + same project as the subscription to be created. + + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + The name of the Pub/Sub Lite topic to write messages that cannot be + exported. Must be in the same project and location as the subscription + to be created. Note that this is a Lite topic. + + --export-desired-state=EXPORT_DESIRED_STATE; default="active" + The desired state of the export. Process messages by setting the value + to ACTIVE or pause message processing by setting the value to PAUSED. + EXPORT_DESIRED_STATE must be one of: active, paused. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/pubsub/lite-subscriptions/seek b/gcloud/alpha/pubsub/lite-subscriptions/seek index d567161cb..807ee41bd 100644 --- a/gcloud/alpha/pubsub/lite-subscriptions/seek +++ b/gcloud/alpha/pubsub/lite-subscriptions/seek @@ -65,21 +65,22 @@ REQUIRED FLAGS Exactly one of these must be specified: --event-time=EVENT_TIME - The event time to seek a subscription to. Seeks to the first message - with event time greater than or equal to the specified event time. As - event times are user supplied, subsequent messages may have event - times less than the specified event time and should be filtered by - the client, if necessary. Messages missing an event time use publish - time as a fallback. Run $ gcloud topic datetimes for information on - time formats. + The event time to which you seek a subscription. The subscription + seeks to the first message with event time greater than or equal to + the specified event time. Messages missing an event time use publish + time as a fallback. As event times are user supplied, subsequent + messages may have event times less than the specified event time and + must be filtered by the client, if necessary. Run $ gcloud topic + datetimes for information on time formats. --publish-time=PUBLISH_TIME - The publish time to seek a subscription to. Messages with publish - time greater than or equal to this time will be delivered post-seek. - Run $ gcloud topic datetimes for information on time formats. + The publish time to which you seek a subscription. Messages with + publish time greater than or equal to the specified time are + delivered after the seek operation. Run $ gcloud topic datetimes for + information on time formats. --starting-offset=STARTING_OFFSET - The offset at which a newly created or seeked subscription will start + The offset at which a newly created or seeked subscription starts receiving messages. A subscription can be initialized at the offset of the oldest retained message (beginning), or at the current HEAD offset (end). STARTING_OFFSET must be one of: beginning, end. diff --git a/gcloud/alpha/pubsub/lite-subscriptions/update b/gcloud/alpha/pubsub/lite-subscriptions/update index 024ae144d..76f3d7772 100644 --- a/gcloud/alpha/pubsub/lite-subscriptions/update +++ b/gcloud/alpha/pubsub/lite-subscriptions/update @@ -5,13 +5,16 @@ NAME SYNOPSIS gcloud alpha pubsub lite-subscriptions update (SUBSCRIPTION : --location=LOCATION) - --delivery-requirement=DELIVERY_REQUIREMENT [GCLOUD_WIDE_FLAG ...] + (--delivery-requirement=DELIVERY_REQUIREMENT + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + --export-desired-state=EXPORT_DESIRED_STATE + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Update a Pub/Sub Lite subscription. EXAMPLES - To update a Cloud Pub/Sub lite-subscription, run: + To update a Pub/Sub Lite subscription, run: $ gcloud alpha pubsub lite-subscriptions update mysubscription \ --location=us-central1-a \ @@ -47,12 +50,29 @@ POSITIONAL ARGUMENTS ▸ provide the argument --zone on the command line. REQUIRED FLAGS - --delivery-requirement=DELIVERY_REQUIREMENT - When this subscription should send messages to subscribers relative to - messages persistence in storage. See - https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions - for more info. DELIVERY_REQUIREMENT must be one of: - deliver-after-stored, deliver-immediately. + At least one of these must be specified: + + --delivery-requirement=DELIVERY_REQUIREMENT + When this subscription should send messages to subscribers relative + to messages persistence in storage. See + https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions + for more info. DELIVERY_REQUIREMENT must be one of: + deliver-after-stored, deliver-immediately. + + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + The name of the Pub/Sub Lite topic to write messages that cannot be + exported. Must be in the same project and location as the + subscription to be created. Note that this is a Lite topic. + + --export-desired-state=EXPORT_DESIRED_STATE + The desired state of the export. Process messages by setting the + value to ACTIVE or pause message processing by setting the value to + PAUSED. EXPORT_DESIRED_STATE must be one of: active, paused. + + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC + The name of the destination Pub/Sub topic to which messages are + exported. Must be the topic's fully specified path if it is not in + the same project as the subscription to be created. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/pubsub/subscriptions/config/export b/gcloud/alpha/pubsub/subscriptions/config/export index f45315cf6..2a8f78af4 100644 --- a/gcloud/alpha/pubsub/subscriptions/config/export +++ b/gcloud/alpha/pubsub/subscriptions/config/export @@ -64,7 +64,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/pubsub/topics/config/export b/gcloud/alpha/pubsub/topics/config/export index 022a5587e..5f790ff54 100644 --- a/gcloud/alpha/pubsub/topics/config/export +++ b/gcloud/alpha/pubsub/topics/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/redis/instances/config/export b/gcloud/alpha/redis/instances/config/export index 160bf31ae..c0c444785 100644 --- a/gcloud/alpha/redis/instances/config/export +++ b/gcloud/alpha/redis/instances/config/export @@ -82,7 +82,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/resource-config/bulk-export b/gcloud/alpha/resource-config/bulk-export index f7cba0a6c..1e2b7b063 100644 --- a/gcloud/alpha/resource-config/bulk-export +++ b/gcloud/alpha/resource-config/bulk-export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/resource-manager/liens/config/export b/gcloud/alpha/resource-manager/liens/config/export index 3fcc97925..a196d7280 100644 --- a/gcloud/alpha/resource-manager/liens/config/export +++ b/gcloud/alpha/resource-manager/liens/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index cf0765a0f..726d3eed0 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -31,6 +31,10 @@ SYNOPSIS | --clear-cloudsql-instances | --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...] | --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...] + --add-custom-audiences=[CUSTOM-AUDIENCES,...] + | --clear-custom-audiences + | --remove-custom-audiences=[CUSTOM-AUDIENCES,...] + | --set-custom-audiences=[CUSTOM-AUDIENCES,...] --binary-authorization=POLICY | --clear-binary-authorization --clear-encryption-key-shutdown-hours | --encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS @@ -213,7 +217,10 @@ FLAGS --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. + 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 @@ -378,7 +385,7 @@ FLAGS --[no-]cpu-boost Whether to allocate extra CPU to containers on startup. This can - reduce the percieved latency of a cold start request. Use --cpu-boost + reduce the perceived latency of a cold start request. Use --cpu-boost to enable and --no-cpu-boost to disable. --[no-]cpu-throttling @@ -447,6 +454,24 @@ FLAGS Completely replace the current Cloud SQL instances with the given values. + These flags modify the custom audiences that can be used in the audience + field of ID token for authenticated requests. + + At most one of these can be specified: + + --add-custom-audiences=[CUSTOM-AUDIENCES,...] + Append the given values to the current custom audiences. + + --clear-custom-audiences + Empty the current custom audiences. + + --remove-custom-audiences=[CUSTOM-AUDIENCES,...] + Remove the given values from the current custom audiences. + + --set-custom-audiences=[CUSTOM-AUDIENCES,...] + Completely replace the current custom audiences with the given + values. + At most one of these can be specified: --binary-authorization=POLICY diff --git a/gcloud/alpha/run/integrations/create b/gcloud/alpha/run/integrations/create index bc7b2b6dd..3c9195d81 100644 --- a/gcloud/alpha/run/integrations/create +++ b/gcloud/alpha/run/integrations/create @@ -54,5 +54,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations create diff --git a/gcloud/alpha/run/integrations/delete b/gcloud/alpha/run/integrations/delete index 777949791..7fc1808d6 100644 --- a/gcloud/alpha/run/integrations/delete +++ b/gcloud/alpha/run/integrations/delete @@ -35,5 +35,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations delete diff --git a/gcloud/alpha/run/integrations/describe b/gcloud/alpha/run/integrations/describe index 628d0af0f..e50d9e06b 100644 --- a/gcloud/alpha/run/integrations/describe +++ b/gcloud/alpha/run/integrations/describe @@ -34,5 +34,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations describe diff --git a/gcloud/alpha/run/integrations/help b/gcloud/alpha/run/integrations/help index cf0234dec..845fc11e2 100644 --- a/gcloud/alpha/run/integrations/help +++ b/gcloud/alpha/run/integrations/help @@ -53,5 +53,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations diff --git a/gcloud/alpha/run/integrations/list b/gcloud/alpha/run/integrations/list index e9065283e..62ef3980f 100644 --- a/gcloud/alpha/run/integrations/list +++ b/gcloud/alpha/run/integrations/list @@ -78,5 +78,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations list diff --git a/gcloud/alpha/run/integrations/types/describe b/gcloud/alpha/run/integrations/types/describe index 92379d9e0..6d16478c8 100644 --- a/gcloud/alpha/run/integrations/types/describe +++ b/gcloud/alpha/run/integrations/types/describe @@ -35,5 +35,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations types describe diff --git a/gcloud/alpha/run/integrations/types/help b/gcloud/alpha/run/integrations/types/help index 0e26b7e27..163acb92d 100644 --- a/gcloud/alpha/run/integrations/types/help +++ b/gcloud/alpha/run/integrations/types/help @@ -38,5 +38,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations types diff --git a/gcloud/alpha/run/integrations/types/list b/gcloud/alpha/run/integrations/types/list index 028a6a261..9f8cd411f 100644 --- a/gcloud/alpha/run/integrations/types/list +++ b/gcloud/alpha/run/integrations/types/list @@ -64,5 +64,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations types list diff --git a/gcloud/alpha/run/integrations/update b/gcloud/alpha/run/integrations/update index 262d253aa..dee4aebeb 100644 --- a/gcloud/alpha/run/integrations/update +++ b/gcloud/alpha/run/integrations/update @@ -50,5 +50,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run integrations update diff --git a/gcloud/alpha/run/jobs/create b/gcloud/alpha/run/jobs/create index d903fa2eb..0d712fbd2 100644 --- a/gcloud/alpha/run/jobs/create +++ b/gcloud/alpha/run/jobs/create @@ -9,11 +9,12 @@ SYNOPSIS [--memory=MEMORY] [--parallelism=PARALLELISM] [--region=REGION] [--service-account=SERVICE_ACCOUNT] [--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]] - [--set-env-vars=[KEY=VALUE,...]] [--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] [GCLOUD_WIDE_FLAG ...] + [--async | --wait] + [--env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Deploys a new job to Google Cloud Run. @@ -92,7 +93,7 @@ OPTIONAL FLAGS List of label KEY=VALUE pairs to add. --max-retries=MAX_RETRIES - Number of times an task is allowed to restart in case of failure before + 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. @@ -110,21 +111,14 @@ OPTIONAL FLAGS --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. For the managed platform, - this is the email address of an IAM service account. For the - Kubernetes-based platforms (gke, kubernetes), this is the name of a - Kubernetes service account in the same namespace as the service. If not - provided, the revision will use the default service account of the - project, or default Kubernetes namespace service account respectively. + 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 :: for the instance. - --set-env-vars=[KEY=VALUE,...] - List of key-value pairs to set as environment variables. - --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 @@ -173,6 +167,18 @@ OPTIONAL FLAGS 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, diff --git a/gcloud/alpha/run/jobs/deploy b/gcloud/alpha/run/jobs/deploy index 171634e7a..0c3059c2c 100644 --- a/gcloud/alpha/run/jobs/deploy +++ b/gcloud/alpha/run/jobs/deploy @@ -9,12 +9,14 @@ SYNOPSIS [--memory=MEMORY] [--parallelism=PARALLELISM] [--region=REGION] [--service-account=SERVICE_ACCOUNT] [--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]] - [--set-env-vars=[KEY=VALUE,...]] [--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] [--image=IMAGE | --source=SOURCE] - [GCLOUD_WIDE_FLAG ...] + [--async | --wait] + [--clear-env-vars | --env-vars-file=FILE_PATH + | --set-env-vars=[KEY=VALUE,...] + | --remove-env-vars=[KEY,...] --update-env-vars=[KEY=VALUE,...]] + [--image=IMAGE | --source=SOURCE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Creates or updates a Cloud Run job. @@ -88,7 +90,7 @@ FLAGS List of label KEY=VALUE pairs to add. --max-retries=MAX_RETRIES - Number of times an task is allowed to restart in case of failure before + 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. @@ -106,21 +108,14 @@ FLAGS --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. For the managed platform, - this is the email address of an IAM service account. For the - Kubernetes-based platforms (gke, kubernetes), this is the name of a - Kubernetes service account in the same namespace as the service. If not - provided, the revision will use the default service account of the - project, or default Kubernetes namespace service account respectively. + 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 :: for the instance. - --set-env-vars=[KEY=VALUE,...] - List of key-value pairs to set as environment variables. - --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 @@ -169,6 +164,32 @@ FLAGS set, gcloud exits successfully when the execution has started. Implies --execute-now. + 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: --image=IMAGE diff --git a/gcloud/alpha/run/jobs/help b/gcloud/alpha/run/jobs/help index 826135eea..30329b51d 100644 --- a/gcloud/alpha/run/jobs/help +++ b/gcloud/alpha/run/jobs/help @@ -30,6 +30,9 @@ GROUPS executions (ALPHA) View and manage your Cloud Run jobs executions. + logs + (ALPHA) Read logs for Cloud Run (fully managed) services. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/run/jobs/logs/help b/gcloud/alpha/run/jobs/logs/help new file mode 100644 index 000000000..9825b785f --- /dev/null +++ b/gcloud/alpha/run/jobs/logs/help @@ -0,0 +1,44 @@ +NAME + gcloud alpha run jobs logs - read logs for Cloud Run (fully managed) + services + +SYNOPSIS + gcloud alpha run jobs logs COMMAND [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Read logs for Cloud Run (fully managed) services. + +EXAMPLES + To tail logs executions for a job, run: + + $ gcloud alpha run jobs logs tail my-job + + To read logs executions for a job, run: + + $ gcloud alpha run jobs logs read 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. + +COMMANDS + COMMAND is one of the following: + + read + (ALPHA) Read logs for a job. + + tail + (ALPHA) Tail logs for a job. + +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. + diff --git a/gcloud/alpha/run/jobs/logs/read b/gcloud/alpha/run/jobs/logs/read new file mode 100644 index 000000000..853d343cd --- /dev/null +++ b/gcloud/alpha/run/jobs/logs/read @@ -0,0 +1,82 @@ +NAME + gcloud alpha run jobs logs read - read logs for a job + +SYNOPSIS + gcloud alpha run jobs logs read JOB [--freshness=FRESHNESS; default="1d"] + [--log-filter=LOG_FILTER] [--order=ORDER; default="desc"] + [--region=REGION] [--limit=LIMIT] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha run jobs logs read reads log entries. Log entries + matching --log-filter are returned according to the specified --order. If + the log entries come from multiple logs, then entries from different logs + might be intermingled in the results. + +EXAMPLES + To read log entries from for a Cloud Run Job, run: + + $ gcloud alpha run jobs logs read my-job + + To read log entries with severity ERROR or higher, run: + + $ gcloud alpha run jobs logs read my-job \ + --log-filter="severity>=ERROR" + + To read log entries written in a specific time window, run: + + $ gcloud alpha run jobs logs read my-job \ + --log-filter='timestamp<="2015-05-31T23:59:59Z" AND + timestamp>="2015-05-31T00:00:00Z"' + + To read up to 10 log entries in your job payloads that include the word + SearchText and format the output in JSON format, run: + + $ gcloud alpha run jobs logs read my-job \ + --log-filter="textPayload:SearchText" --limit=10 --format=json + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + JOB + Name for a Cloud Run job. + +FLAGS + --freshness=FRESHNESS; default="1d" + Return entries that are not older than this value. Works only with DESC + ordering and filters without a timestamp. See $ gcloud topic datetimes + for information on duration formats. + + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --order=ORDER; default="desc" + Ordering of returned log entries based on timestamp field. ORDER must + be one of: desc, asc. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + +LIST COMMAND FLAGS + --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. + +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. + diff --git a/gcloud/alpha/run/jobs/logs/tail b/gcloud/alpha/run/jobs/logs/tail new file mode 100644 index 000000000..1445df90c --- /dev/null +++ b/gcloud/alpha/run/jobs/logs/tail @@ -0,0 +1,53 @@ +NAME + gcloud alpha run jobs logs tail - tail logs for a job + +SYNOPSIS + gcloud alpha run jobs logs tail JOB [--log-filter=LOG_FILTER] + [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha run jobs logs tail tails log-entries for a particular + Cloud Run job in real time. The log entries are formatted for consumption + in a terminal. + +EXAMPLES + To tail log entries for a Cloud Run job, run: + + $ gcloud alpha run jobs logs tail my-job + + To tail log entries with severity ERROR or higher, run: + + $ gcloud alpha run jobs logs tail my-job \ + --log-filter="severity>=ERROR" + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + JOB + Name for a Cloud Run job. + +FLAGS + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --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 + 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. + diff --git a/gcloud/alpha/run/jobs/update b/gcloud/alpha/run/jobs/update index 3adf730eb..0c7059e34 100644 --- a/gcloud/alpha/run/jobs/update +++ b/gcloud/alpha/run/jobs/update @@ -2,10 +2,10 @@ NAME gcloud alpha run jobs update - update a Cloud Run Job SYNOPSIS - gcloud alpha run jobs update [JOB] [--args=[ARG,...]] [--async] + gcloud alpha run jobs update [JOB] [--args=[ARG,...]] [--breakglass=JUSTIFICATION] [--clear-vpc-connector] - [--command=[COMMAND,...]] [--cpu=CPU] [--image=IMAGE] [--key=KEY] - [--max-retries=MAX_RETRIES] [--memory=MEMORY] + [--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] @@ -14,6 +14,7 @@ SYNOPSIS | --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,...] @@ -57,10 +58,6 @@ FLAGS 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. - --async - Return immediately, without waiting for the operation in progress to - complete. - --breakglass=JUSTIFICATION Justification to bypass Binary Authorization policy constraints and allow the operation. See @@ -83,6 +80,9 @@ FLAGS (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). @@ -91,7 +91,7 @@ FLAGS CMEK key reference to encrypt the container with. --max-retries=MAX_RETRIES - Number of times an task is allowed to restart in case of failure before + 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. @@ -109,12 +109,8 @@ FLAGS --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. For the managed platform, - this is the email address of an IAM service account. For the - Kubernetes-based platforms (gke, kubernetes), this is the name of a - Kubernetes service account in the same namespace as the service. If not - provided, the revision will use the default service account of the - project, or default Kubernetes namespace service account respectively. + 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 @@ -166,6 +162,17 @@ FLAGS 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 @@ -183,7 +190,10 @@ FLAGS --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. + 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 diff --git a/gcloud/alpha/run/revisions/logs/help b/gcloud/alpha/run/revisions/logs/help index 2e70a074b..5d4f56632 100644 --- a/gcloud/alpha/run/revisions/logs/help +++ b/gcloud/alpha/run/revisions/logs/help @@ -106,5 +106,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run revisions logs diff --git a/gcloud/alpha/run/revisions/logs/read b/gcloud/alpha/run/revisions/logs/read index 7236ec9b3..223c8352f 100644 --- a/gcloud/alpha/run/revisions/logs/read +++ b/gcloud/alpha/run/revisions/logs/read @@ -154,5 +154,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run revisions logs read diff --git a/gcloud/alpha/run/revisions/logs/tail b/gcloud/alpha/run/revisions/logs/tail index 1b1713bba..12c41e1bf 100644 --- a/gcloud/alpha/run/revisions/logs/tail +++ b/gcloud/alpha/run/revisions/logs/tail @@ -123,5 +123,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run revisions logs tail diff --git a/gcloud/alpha/run/services/logs/help b/gcloud/alpha/run/services/logs/help index 710b9feea..f84fba15a 100644 --- a/gcloud/alpha/run/services/logs/help +++ b/gcloud/alpha/run/services/logs/help @@ -106,5 +106,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run services logs diff --git a/gcloud/alpha/run/services/logs/read b/gcloud/alpha/run/services/logs/read index d9cb11841..e64988a95 100644 --- a/gcloud/alpha/run/services/logs/read +++ b/gcloud/alpha/run/services/logs/read @@ -154,5 +154,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run services logs read diff --git a/gcloud/alpha/run/services/logs/tail b/gcloud/alpha/run/services/logs/tail index 062a54ab7..c5cf5d740 100644 --- a/gcloud/alpha/run/services/logs/tail +++ b/gcloud/alpha/run/services/logs/tail @@ -123,5 +123,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta run services logs tail diff --git a/gcloud/alpha/run/services/update b/gcloud/alpha/run/services/update index ae98b2e73..c8684b91e 100644 --- a/gcloud/alpha/run/services/update +++ b/gcloud/alpha/run/services/update @@ -19,6 +19,10 @@ SYNOPSIS | --clear-cloudsql-instances | --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...] | --set-cloudsql-instances=[CLOUDSQL-INSTANCES,...] + --add-custom-audiences=[CUSTOM-AUDIENCES,...] + | --clear-custom-audiences + | --remove-custom-audiences=[CUSTOM-AUDIENCES,...] + | --set-custom-audiences=[CUSTOM-AUDIENCES,...] --binary-authorization=POLICY | --clear-binary-authorization --clear-encryption-key-shutdown-hours | --encryption-key-shutdown-hours=ENCRYPTION_KEY_SHUTDOWN_HOURS @@ -213,7 +217,7 @@ FLAGS --[no-]cpu-boost Whether to allocate extra CPU to containers on startup. This can - reduce the percieved latency of a cold start request. Use --cpu-boost + reduce the perceived latency of a cold start request. Use --cpu-boost to enable and --no-cpu-boost to disable. --[no-]cpu-throttling @@ -279,6 +283,24 @@ FLAGS Completely replace the current Cloud SQL instances with the given values. + These flags modify the custom audiences that can be used in the audience + field of ID token for authenticated requests. + + At most one of these can be specified: + + --add-custom-audiences=[CUSTOM-AUDIENCES,...] + Append the given values to the current custom audiences. + + --clear-custom-audiences + Empty the current custom audiences. + + --remove-custom-audiences=[CUSTOM-AUDIENCES,...] + Remove the given values from the current custom audiences. + + --set-custom-audiences=[CUSTOM-AUDIENCES,...] + Completely replace the current custom audiences with the given + values. + At most one of these can be specified: --binary-authorization=POLICY @@ -328,7 +350,10 @@ FLAGS --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. + 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 diff --git a/gcloud/alpha/scc/assets/describe b/gcloud/alpha/scc/assets/describe index 1d9efd2ce..27922741a 100644 --- a/gcloud/alpha/scc/assets/describe +++ b/gcloud/alpha/scc/assets/describe @@ -33,15 +33,17 @@ EXAMPLES $ gcloud alpha scc assets describe folders/456/assets/5678 POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/alpha/scc/assets/group b/gcloud/alpha/scc/assets/group index 8405d46e3..9fc75d350 100644 --- a/gcloud/alpha/scc/assets/group +++ b/gcloud/alpha/scc/assets/group @@ -53,15 +53,17 @@ EXAMPLES --group-by="state_change" POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/alpha/scc/assets/list b/gcloud/alpha/scc/assets/list index 97c0131e5..272558786 100644 --- a/gcloud/alpha/scc/assets/list +++ b/gcloud/alpha/scc/assets/list @@ -72,15 +72,17 @@ EXAMPLES $ gcloud alpha scc assets list 123456 --compare-duration=86400s POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/alpha/scc/findings/create b/gcloud/alpha/scc/findings/create index 8383f78e8..238008dc0 100644 --- a/gcloud/alpha/scc/findings/create +++ b/gcloud/alpha/scc/findings/create @@ -5,8 +5,8 @@ NAME SYNOPSIS gcloud alpha scc findings create (FINDING : --organization=ORGANIZATION --source=SOURCE) - --category=CATEGORY --resource-name=RESOURCE_NAME - [--event-time=EVENT_TIME] [--external-uri=EXTERNAL_URI] + --category=CATEGORY --event-time=EVENT_TIME + --resource-name=RESOURCE_NAME [--external-uri=EXTERNAL_URI] [--source-properties=[SOURCE_PROPERTIES,...]] [--state=STATE] [GCLOUD_WIDE_FLAG ...] @@ -20,8 +20,9 @@ EXAMPLES $ gcloud alpha scc findings create my-finding \ --organization=123456 --source=5678 --state=ACTIVE \ --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' Create an ACTIVE my-finding attached to example-project under project example-project and source 5678: @@ -29,8 +30,9 @@ EXAMPLES $ gcloud alpha scc findings create \ projects/example-project/sources/5678/findings/my-finding \ --state=ACTIVE --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' Create an ACTIVE my-finding attached to example-project under folder 456 and source 5678: @@ -38,8 +40,9 @@ EXAMPLES $ gcloud alpha scc findings create \ folders/456/sources/5678/findings/my-finding --state=ACTIVE \ --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' POSITIONAL ARGUMENTS Finding resource - The finding to be used for the SCC (Security Command @@ -84,19 +87,18 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --category=CATEGORY Taxonomy group within findings from a given source. Example: - XSS_FLASH_INJECTION + XSS_SCRIPTING + + --event-time=EVENT_TIME + Time at which the issue is detected or the finding is created, in the + following format: YYYY-MM-DDThh:mm:ss.ffffffZ. Example: + 2023-01-11T07:00:06.861Z --resource-name=RESOURCE_NAME Full resource name of the Google Cloud Platform resource this finding is for. OPTIONAL FLAGS - --event-time=EVENT_TIME - Time at which the event took place. For example, if the finding - represents an open firewall it would capture the time the open firewall - was detected. If event-time is not provided, it will default to UTC - version of NOW. For example 2019-02-28T07:00:00Z - --external-uri=EXTERNAL_URI URI that, if available, points to a web page outside of Cloud SCC (Security Command Center) where additional information about the diff --git a/gcloud/alpha/scc/findings/group b/gcloud/alpha/scc/findings/group index 34d951f6a..bd77be260 100644 --- a/gcloud/alpha/scc/findings/group +++ b/gcloud/alpha/scc/findings/group @@ -55,15 +55,17 @@ EXAMPLES --group-by="state_change" --compare-duration=86400s POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/alpha/scc/findings/list b/gcloud/alpha/scc/findings/list index e05ea3a34..9c72e771b 100644 --- a/gcloud/alpha/scc/findings/list +++ b/gcloud/alpha/scc/findings/list @@ -65,15 +65,17 @@ EXAMPLES --filter="state=\"ACTIVE\"" --read-time="2019-01-01T01:00:00Z" POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/alpha/scc/notifications/list b/gcloud/alpha/scc/notifications/list index 429a02d50..a5cf72a71 100644 --- a/gcloud/alpha/scc/notifications/list +++ b/gcloud/alpha/scc/notifications/list @@ -25,15 +25,17 @@ EXAMPLES $ gcloud alpha scc notifications list projects/789 POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/alpha/secrets/config/export b/gcloud/alpha/secrets/config/export index 34fed3e2c..b48725a4a 100644 --- a/gcloud/alpha/secrets/config/export +++ b/gcloud/alpha/secrets/config/export @@ -62,7 +62,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/secrets/versions/config/export b/gcloud/alpha/secrets/versions/config/export index ac001c61c..94cf26f27 100644 --- a/gcloud/alpha/secrets/versions/config/export +++ b/gcloud/alpha/secrets/versions/config/export @@ -78,7 +78,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/services/api-keys/create b/gcloud/alpha/services/api-keys/create index 2101e537b..8f5d40323 100644 --- a/gcloud/alpha/services/api-keys/create +++ b/gcloud/alpha/services/api-keys/create @@ -2,8 +2,8 @@ NAME gcloud alpha services api-keys create - create an API key SYNOPSIS - gcloud alpha services api-keys create [--async] - [--display-name=DISPLAY_NAME] + gcloud alpha services api-keys create [--annotations=[KEY=VALUE,...]] + [--async] [--display-name=DISPLAY_NAME] [--api-target=service=SERVICE,[...] --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT, package_name=PACKAGE_NAME,...] @@ -20,6 +20,10 @@ EXAMPLES $ gcloud alpha services api-keys create --display-name="test name" \ --allowed-ips=2620:15c:2c4:203:2776:1f90:6b3b:217,104.133.8.78 + To create a key with annotations: + + $ gcloud alpha services api-keys create --annotations=foo=bar,abc=def + To create a key with allowed referrers restriction: $ gcloud alpha services api-keys create \ @@ -61,6 +65,10 @@ EXAMPLES - "barmethod" FLAGS + --annotations=[KEY=VALUE,...] + Annotations are key resource. Specify annotations as a key-value + dictionary for small amounts of arbitrary client data. + --async Return immediately, without waiting for the operation in progress to complete. @@ -69,17 +77,17 @@ FLAGS Display name of the key to create. --api-target=service=SERVICE,[...] - This flag is repeatable to specify multiple api targets. service and - optionally one or multiple specific methods. Both fields are case - insensitive. If you need to specify methods, it should be specified - with the --flags-file. See $ gcloud topic flags-file for details. See - the examples section for how to use --api-target in --flags-file. + Repeatable. Specify service and optionally one or multiple specific + methods. Both fields are case insensitive. If you need to specify + methods, it should be specified with the --flags-file. See $ gcloud + topic flags-file for details. See the examples section for how to use + --api-target in --flags-file. At most one of these can be specified: --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT,package_name=PACKAGE_NAME,...] - This flag is repeatable to specify multiple allowed applications. The - accepted keys are sha1_fingerprint and package_name. + Repeatable. Specify multiple allowed applications. The accepted keys + are sha1_fingerprint and package_name. --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] iOS app's bundle ids that are allowed to use the key. @@ -104,5 +112,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta services api-keys create diff --git a/gcloud/alpha/services/api-keys/delete b/gcloud/alpha/services/api-keys/delete index d6ad35d41..3c5bd35b8 100644 --- a/gcloud/alpha/services/api-keys/delete +++ b/gcloud/alpha/services/api-keys/delete @@ -52,5 +52,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta services api-keys delete diff --git a/gcloud/alpha/services/api-keys/describe b/gcloud/alpha/services/api-keys/describe index 4e9536e45..8505c3ab6 100644 --- a/gcloud/alpha/services/api-keys/describe +++ b/gcloud/alpha/services/api-keys/describe @@ -9,14 +9,20 @@ DESCRIPTION (ALPHA) Describe an API key's metadata. EXAMPLES - To describe an API key: + To describe an API key using Key: - $ gcloud alpha services api-keys describe \ - projects/myproject/locations/global/keys/1234 OR $ gcloud alpha services api-keys describe 1234 OR - $ gcloud alpha services api-keys describe 1234 --project=myproject OR + $ gcloud alpha services api-keys describe \ + projects/myproject/locations/global/keys/1234 + + To describe an API key with key and project: + + $ gcloud alpha services api-keys describe 1234 --project=myproject + + To describe an API key with key, project, and location: + $ gcloud alpha services api-keys describe 1234 --project=myproject \ - --location=global + --location=global POSITIONAL ARGUMENTS Key resource - The name of the key to describe. The arguments in this @@ -57,7 +63,9 @@ 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: + access allowlist. These variants are also available: $ gcloud services api-keys describe + $ gcloud beta services api-keys describe + diff --git a/gcloud/alpha/services/api-keys/get-key-string b/gcloud/alpha/services/api-keys/get-key-string index 61278448b..c98ae7b59 100644 --- a/gcloud/alpha/services/api-keys/get-key-string +++ b/gcloud/alpha/services/api-keys/get-key-string @@ -1,13 +1,21 @@ NAME - gcloud alpha services api-keys get-key-string - get key string of an API - key + gcloud alpha services api-keys get-key-string - get the key string of an + API key SYNOPSIS gcloud alpha services api-keys get-key-string (KEY : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] -DESCRIPTION - (ALPHA) Get key string of an API key. +EXAMPLES + To get the key string of API key 1234, run: + + $ gcloud alpha services api-keys get-key-string 1234 + + To get the key string of API key 1234 in project myproject using the fully + qualified API key name, run: + + $ gcloud alpha services api-keys get-key-string \ + projects/myproject/locations/global/keys/1234 POSITIONAL ARGUMENTS Key resource - The name of the key to retrieve key string. The arguments @@ -48,5 +56,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta services api-keys get-key-string diff --git a/gcloud/alpha/services/api-keys/help b/gcloud/alpha/services/api-keys/help index 49058b1f7..50ccfe323 100644 --- a/gcloud/alpha/services/api-keys/help +++ b/gcloud/alpha/services/api-keys/help @@ -25,7 +25,7 @@ COMMANDS (ALPHA) Describe an API key's metadata. get-key-string - (ALPHA) Get key string of an API key. + (ALPHA) Get the key string of an API key. list (ALPHA) Lists API keys. @@ -43,7 +43,9 @@ 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: + access allowlist. These variants are also available: $ gcloud services api-keys + $ gcloud beta services api-keys + diff --git a/gcloud/alpha/services/api-keys/list b/gcloud/alpha/services/api-keys/list index 32f85eacc..f7748f6ba 100644 --- a/gcloud/alpha/services/api-keys/list +++ b/gcloud/alpha/services/api-keys/list @@ -68,7 +68,9 @@ 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: + access allowlist. These variants are also available: $ gcloud services api-keys list + $ gcloud beta services api-keys list + diff --git a/gcloud/alpha/services/api-keys/lookup b/gcloud/alpha/services/api-keys/lookup index 7b7ae838a..e6297e3a7 100644 --- a/gcloud/alpha/services/api-keys/lookup +++ b/gcloud/alpha/services/api-keys/lookup @@ -24,5 +24,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta services api-keys lookup diff --git a/gcloud/alpha/services/api-keys/undelete b/gcloud/alpha/services/api-keys/undelete index d91e44bd6..876b37010 100644 --- a/gcloud/alpha/services/api-keys/undelete +++ b/gcloud/alpha/services/api-keys/undelete @@ -10,6 +10,14 @@ DESCRIPTION days. If a key is still within this retention window, it can be undeleted with this command. +EXAMPLES + UnDelete an API Key : + + $ gcloud alpha services api-keys undelete \ + projects/myproject/locations/global/keys/1234 + + $ gcloud alpha services api-keys undelete 1234 + POSITIONAL ARGUMENTS Key resource - The name of the key to undelete. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some @@ -54,5 +62,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta services api-keys undelete diff --git a/gcloud/alpha/services/api-keys/update b/gcloud/alpha/services/api-keys/update index a1f2561a0..8dd12182c 100644 --- a/gcloud/alpha/services/api-keys/update +++ b/gcloud/alpha/services/api-keys/update @@ -2,9 +2,10 @@ NAME gcloud alpha services api-keys update - update an API key's metadata SYNOPSIS - gcloud alpha services api-keys update (KEY : --location=LOCATION) [--async] - [--display-name=DISPLAY_NAME] - [--clear-restrictions | --api-target=service=SERVICE,[...] + gcloud alpha services api-keys update (KEY : --location=LOCATION) + [--annotations=[KEY=VALUE,...]] [--async] [--display-name=DISPLAY_NAME] + [--clear-annotations | --clear-restrictions + | --api-target=service=SERVICE,[...] --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT, package_name=PACKAGE_NAME,...] | --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] @@ -26,6 +27,11 @@ EXAMPLES projects/myproject/keys/my-key-id --display-name="test name" \ --allowed-ips=2620:15c:2c4:203:2776:1f90:6b3b:217,104.133.8.78 + To update annoatations: + + $ gcloud alpha services api-keys update \ + projects/myproject/keys/my-key-id --annotations=foo=bar,abc=def + To update key's allowed referrers restriction: $ gcloud alpha services api-keys update \ @@ -97,6 +103,10 @@ POSITIONAL ARGUMENTS ▸ location will default to global. FLAGS + --annotations=[KEY=VALUE,...] + Annotations are key resource. Specify annotations as a key-value + dictionary for small amounts of arbitrary client data. + --async Return immediately, without waiting for the operation in progress to complete. @@ -106,21 +116,24 @@ FLAGS At most one of these can be specified: + --clear-annotations + If set, clear all annotations on the key. + --clear-restrictions If set, clear all restrictions on the key. --api-target=service=SERVICE,[...] - This flag is repeatable to specify multiple api targets. service and - optionally one or multiple specific methods. Both fields are case - insensitive. If you need to specify methods, it should be specified - with the --flags-file. See $ gcloud topic flags-file for details. See - the examples section for how to use --api-target in --flags-file. + Repeatable. Specify service and optionally one or multiple specific + methods. Both fields are case insensitive. If you need to specify + methods, it should be specified with the --flags-file. See $ gcloud + topic flags-file for details. See the examples section for how to use + --api-target in --flags-file. At most one of these can be specified: --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT,package_name=PACKAGE_NAME,...] - This flag is repeatable to specify multiple allowed applications. - The accepted keys are sha1_fingerprint and package_name. + Repeatable. Specify multiple allowed applications. The accepted + keys are sha1_fingerprint and package_name. --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] iOS app's bundle ids that are allowed to use the key. @@ -145,5 +158,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud beta services api-keys update diff --git a/gcloud/alpha/services/list b/gcloud/alpha/services/list index 7204f8459..611fd376d 100644 --- a/gcloud/alpha/services/list +++ b/gcloud/alpha/services/list @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud alpha services list [--available | --enabled] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] + [--limit=LIMIT] [--page-size=PAGE_SIZE; default=200] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command lists the services that are enabled or available to be @@ -44,12 +44,11 @@ LIST COMMAND FLAGS flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit. - --page-size=PAGE_SIZE + --page-size=PAGE_SIZE; default=200 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. + specifies the maximum number of resources per page. The default is 200. + 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 diff --git a/gcloud/alpha/source/repos/config/export b/gcloud/alpha/source/repos/config/export index 819706760..236ccceea 100644 --- a/gcloud/alpha/source/repos/config/export +++ b/gcloud/alpha/source/repos/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/spanner/databases/config/export b/gcloud/alpha/spanner/databases/config/export index d7678876b..9feb38362 100644 --- a/gcloud/alpha/spanner/databases/config/export +++ b/gcloud/alpha/spanner/databases/config/export @@ -81,7 +81,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/spanner/help b/gcloud/alpha/spanner/help index ce586d06e..f7c06f511 100644 --- a/gcloud/alpha/spanner/help +++ b/gcloud/alpha/spanner/help @@ -27,6 +27,9 @@ GROUPS instances (ALPHA) Manage Cloud Spanner instances. + migration + (ALPHA) Migrate external databases to Cloud Spanner. + operations (ALPHA) Manage Cloud Spanner operations. diff --git a/gcloud/alpha/spanner/instances/config/export b/gcloud/alpha/spanner/instances/config/export index 81ecbe9fb..adb8ae0a2 100644 --- a/gcloud/alpha/spanner/instances/config/export +++ b/gcloud/alpha/spanner/instances/config/export @@ -61,7 +61,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/spanner/migration/data b/gcloud/alpha/spanner/migration/data new file mode 100644 index 000000000..700e05b40 --- /dev/null +++ b/gcloud/alpha/spanner/migration/data @@ -0,0 +1,74 @@ +NAME + gcloud alpha spanner migration data - migrate data from a source database + to Cloud Spanner given a schema + +SYNOPSIS + gcloud alpha spanner migration data --session=SESSION --source=SOURCE + [--dry-run] [--log-level=LOG_LEVEL] [--prefix=PREFIX] + [--skip-foreign-keys] [--source-profile=SOURCE_PROFILE] + [--target=TARGET] [--target-profile=TARGET_PROFILE] + [--write-limit=WRITE_LIMIT] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Migrate data from a source database to Cloud Spanner given a + schema. + +EXAMPLES + To copy data to Cloud Spanner given a session file: + + $ gcloud alpha spanner migration data --session=./session.json \ + --source=postgresql < ~/cart.pg_dump \ + --target-profile='instance=spanner-instance' + +REQUIRED FLAGS + --session=SESSION + Specifies the file that you restore session state from. + + --source=SOURCE + Flag for specifying source database (e.g., PostgreSQL, MySQL, + DynamoDB). + +OPTIONAL FLAGS + --dry-run + Flag for generating DDL and schema conversion report without creating a + Cloud Spanner database. + + --log-level=LOG_LEVEL + To configure the log level for the execution (INFO, VERBOSE). + + --prefix=PREFIX + File prefix for generated files. + + --skip-foreign-keys + Skip creating foreign keys after data migration is complete. + + --source-profile=SOURCE_PROFILE + Flag for specifying connection profile for source database (e.g., + "file=,format=dump"). + + --target=TARGET + Specifies the target database, defaults to Spanner (accepted values: + Spanner) (default "Spanner"). + + --target-profile=TARGET_PROFILE + Flag for specifying connection profile for target database (e.g., + "dialect=postgresql)". + + --write-limit=WRITE_LIMIT + Number of parallel writers to Cloud Spanner during bulk data migrations + (default 40). + +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. + diff --git a/gcloud/alpha/spanner/migration/help b/gcloud/alpha/spanner/migration/help new file mode 100644 index 000000000..4508416cd --- /dev/null +++ b/gcloud/alpha/spanner/migration/help @@ -0,0 +1,38 @@ +NAME + gcloud alpha spanner migration - migrate external databases to Cloud + Spanner + +SYNOPSIS + gcloud alpha spanner migration COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Migrate external databases to Cloud Spanner. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + data + (ALPHA) Migrate data from a source database to Cloud Spanner given a + schema. + + schema + (ALPHA) Migrate schema from a source database to Cloud Spanner. + + schema-and-data + (ALPHA) Migrate data from a source database to Cloud Spanner given a + schema. + + web + (ALPHA) Run the web UI assistant for schema migrations. + +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. + diff --git a/gcloud/alpha/spanner/migration/schema b/gcloud/alpha/spanner/migration/schema new file mode 100644 index 000000000..512a128e8 --- /dev/null +++ b/gcloud/alpha/spanner/migration/schema @@ -0,0 +1,61 @@ +NAME + gcloud alpha spanner migration schema - migrate schema from a source + database to Cloud Spanner + +SYNOPSIS + gcloud alpha spanner migration schema --source=SOURCE [--dry-run] + [--log-level=LOG_LEVEL] [--prefix=PREFIX] + [--source-profile=SOURCE_PROFILE] [--target=TARGET] + [--target-profile=TARGET_PROFILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Migrate schema from a source database to Cloud Spanner. + +EXAMPLES + To generate schema file from the source database: + + $ gcloud alpha spanner migration schema --source=postgresql < \ + ~/cart.pg_dump + +REQUIRED FLAGS + --source=SOURCE + Flag for specifying source database (e.g., PostgreSQL, MySQL, + DynamoDB). + +OPTIONAL FLAGS + --dry-run + Flag for generating DDL and schema conversion report without creating a + Cloud Spanner database. + + --log-level=LOG_LEVEL + To configure the log level for the execution (INFO, VERBOSE). + + --prefix=PREFIX + File prefix for generated files. + + --source-profile=SOURCE_PROFILE + Flag for specifying connection profile for source database (e.g., + "file=,format=dump"). + + --target=TARGET + Specifies the target database, defaults to Spanner (accepted values: + Spanner) (default "Spanner"). + + --target-profile=TARGET_PROFILE + Flag for specifying connection profile for target database (e.g., + "dialect=postgresql)". + +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. + diff --git a/gcloud/alpha/spanner/migration/schema-and-data b/gcloud/alpha/spanner/migration/schema-and-data new file mode 100644 index 000000000..d7bd49241 --- /dev/null +++ b/gcloud/alpha/spanner/migration/schema-and-data @@ -0,0 +1,71 @@ +NAME + gcloud alpha spanner migration schema-and-data - migrate data from a source + database to Cloud Spanner given a schema + +SYNOPSIS + gcloud alpha spanner migration schema-and-data --source=SOURCE [--dry-run] + [--log-level=LOG_LEVEL] [--prefix=PREFIX] [--skip-foreign-keys] + [--source-profile=SOURCE_PROFILE] [--target=TARGET] + [--target-profile=TARGET_PROFILE] [--write-limit=WRITE_LIMIT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Migrate data from a source database to Cloud Spanner given a + schema. + +EXAMPLES + To generate schema and copy data to Cloud Spanner from a source database: + + $ gcloud alpha spanner migration schema-and-data \ + --source=postgresql < ~/cart.pg_dump \ + --target-profile='instance=spanner-instance' + +REQUIRED FLAGS + --source=SOURCE + Flag for specifying source database (e.g., PostgreSQL, MySQL, + DynamoDB). + +OPTIONAL FLAGS + --dry-run + Flag for generating DDL and schema conversion report without creating a + Cloud Spanner database. + + --log-level=LOG_LEVEL + To configure the log level for the execution (INFO, VERBOSE). + + --prefix=PREFIX + File prefix for generated files. + + --skip-foreign-keys + Skip creating foreign keys after data migration is complete. + + --source-profile=SOURCE_PROFILE + Flag for specifying connection profile for source database (e.g., + "file=,format=dump"). + + --target=TARGET + Specifies the target database, defaults to Spanner (accepted values: + Spanner) (default "Spanner"). + + --target-profile=TARGET_PROFILE + Flag for specifying connection profile for target database (e.g., + "dialect=postgresql)". + + --write-limit=WRITE_LIMIT + Number of parallel writers to Cloud Spanner during bulk data migrations + (default 40). + +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. + diff --git a/gcloud/alpha/spanner/migration/web b/gcloud/alpha/spanner/migration/web new file mode 100644 index 000000000..fe0ee4bf1 --- /dev/null +++ b/gcloud/alpha/spanner/migration/web @@ -0,0 +1,29 @@ +NAME + gcloud alpha spanner migration web - run the web UI assistant for schema + migrations + +SYNOPSIS + gcloud alpha spanner migration web [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Run the web UI assistant for schema migrations. + +EXAMPLES + To run the web UI assistant: + + $ gcloud alpha spanner migration web + +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. + diff --git a/gcloud/alpha/sql/databases/config/export b/gcloud/alpha/sql/databases/config/export index 522dadf13..1acb6fa61 100644 --- a/gcloud/alpha/sql/databases/config/export +++ b/gcloud/alpha/sql/databases/config/export @@ -78,7 +78,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/sql/export/bak b/gcloud/alpha/sql/export/bak index a24b265e6..f8ffd4239 100644 --- a/gcloud/alpha/sql/export/bak +++ b/gcloud/alpha/sql/export/bak @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud alpha sql export bak INSTANCE URI --database=DATABASE,[DATABASE,...], -d DATABASE,[DATABASE,...] - [--async] [GCLOUD_WIDE_FLAG ...] + [--async] [--stripe_count=STRIPE_COUNT] [--[no-]striped] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Export data from a Cloud SQL instance to a Google Cloud Storage @@ -38,6 +39,13 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --stripe_count=STRIPE_COUNT + Specifies the number of stripes to use for SQL Server exports. + + --[no-]striped + Whether SQL Server export should be striped. Use --striped to enable + and --no-striped to disable. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/sql/import/bak b/gcloud/alpha/sql/import/bak index 7f024b44c..95f150ec9 100644 --- a/gcloud/alpha/sql/import/bak +++ b/gcloud/alpha/sql/import/bak @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha sql import bak INSTANCE URI --database=DATABASE, -d DATABASE - [--async] + [--async] [--[no-]striped] [--cert-path=CERT_PATH --pvk-path=PVK_PATH (--prompt-for-pvk-password | --pvk-password=PVK_PASSWORD)] [GCLOUD_WIDE_FLAG ...] @@ -50,6 +50,10 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --[no-]striped + Whether SQL Server import should be striped. Use --striped to enable + and --no-striped to disable. + Encryption info to support importing an encrypted .bak file --cert-path=CERT_PATH diff --git a/gcloud/alpha/sql/instances/clone b/gcloud/alpha/sql/instances/clone index d4fb07e5b..3814095ff 100644 --- a/gcloud/alpha/sql/instances/clone +++ b/gcloud/alpha/sql/instances/clone @@ -4,8 +4,10 @@ NAME SYNOPSIS gcloud alpha sql instances clone SOURCE DESTINATION [--allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME] [--async] - [--point-in-time=POINT_IN_TIME | --bin-log-file-name=BIN_LOG_FILE_NAME - --bin-log-position=BIN_LOG_POSITION] [GCLOUD_WIDE_FLAG ...] + [--bin-log-file-name=BIN_LOG_FILE_NAME + --bin-log-position=BIN_LOG_POSITION | [--point-in-time=POINT_IN_TIME + : --restore-database-name=RESTORE_DATABASE_NAME]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha sql instances clone creates a clone of a Cloud SQL @@ -22,6 +24,10 @@ DESCRIPTION the instance to clone. If not specified, the current state of the instance is cloned. + For SQL Server: The point in time, if specified, defines a past state of + the instance to clone. If not specified, the current state of the instance + is cloned. + EXAMPLES To clone an instance from its current state (most recent binary log coordinates): @@ -44,6 +50,11 @@ EXAMPLES $ gcloud alpha sql instances clone instance-foo instance-bar \ --point-in-time '2012-11-15T16:19:00.094Z' + To clone a SQL Server source instance at a specific point in time: + + $ gcloud alpha sql instances clone instance-foo instance-bar \ + --point-in-time '2012-11-15T16:19:00.094Z' + To specify the allocated IP range for the private IP target Instance (reserved for future use): @@ -61,8 +72,8 @@ FLAGS --allocated-ip-range-name=ALLOCATED_IP_RANGE_NAME The name of the IP range allocated for the destination instance with private network connectivity. For example: - 'google-managed-services-default'. If set, the the destination instance - IP is created in the allocated range represented by this name. Reserved + 'google-managed-services-default'. If set, the destination instance IP + is created in the allocated range represented by this name. Reserved for future use. --async @@ -71,17 +82,6 @@ FLAGS At most one of these can be specified: - --point-in-time=POINT_IN_TIME - Represents the state of an instance at any given point in time inside - a transaction log file. For MySQL, the binary log file is used for - transaction logs. For PostgreSQL, the write-ahead log file is used - for transaction logs. To create a transaction log, enable - point-in-time recovery on the source instance. Instance should have - transaction logs accumulated upto the point in time they want to - restore upto. Uses RFC 3339 format in UTC timezone. If specified, - defines a past state of the instance to clone. For example, - '2012-11-15T16:19:00.094Z'. - Binary log coordinates for point-in-time recovery. --bin-log-file-name=BIN_LOG_FILE_NAME @@ -104,6 +104,26 @@ FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --point-in-time=POINT_IN_TIME + Represents the state of an instance at any given point in time inside + a transaction log file. For MySQL, the binary log file is used for + transaction logs. For PostgreSQL, the write-ahead log file is used + for transaction logs. For SQL Server, the log backup file is used for + such purpose. To create a transaction log, enable point-in-time + recovery on the source instance. Instance should have transaction + logs accumulated up to the point in time they want to restore up to. + Uses RFC 3339 format in UTC timezone. If specified, defines a past + state of the instance to clone. For example, + '2012-11-15T16:19:00.094Z'. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --restore-database-name=RESTORE_DATABASE_NAME + The name of the database to be restored for a point-in-time restore. + If set, the destination instance will only restore the specified + database. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/sql/instances/config/export b/gcloud/alpha/sql/instances/config/export index 3bfbdd79f..4f5706e54 100644 --- a/gcloud/alpha/sql/instances/config/export +++ b/gcloud/alpha/sql/instances/config/export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/sql/instances/create b/gcloud/alpha/sql/instances/create index 1e87f621f..bd9dd57d5 100644 --- a/gcloud/alpha/sql/instances/create +++ b/gcloud/alpha/sql/instances/create @@ -20,8 +20,8 @@ SYNOPSIS [--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE] [--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE] [--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] - [--enable-bin-log] [--enable-password-policy] - [--enable-point-in-time-recovery] + [--enable-bin-log] [--enable-google-private-path] + [--enable-password-policy] [--enable-point-in-time-recovery] [--failover-replica-name=FAILOVER_REPLICA_NAME] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] @@ -46,6 +46,7 @@ SYNOPSIS [--storage-auto-increase-limit=STORAGE_AUTO_INCREASE_LIMIT] [--storage-size=STORAGE_SIZE] [--storage-type=STORAGE_TYPE] [--tier=TIER, -t TIER] [--time-zone=TIME_ZONE] + [--timeout=TIMEOUT; default=3600] [--disk-encryption-key=DISK_ENCRYPTION_KEY : --disk-encryption-key-keyring=DISK_ENCRYPTION_KEY_KEYRING --disk-encryption-key-location=DISK_ENCRYPTION_KEY_LOCATION @@ -116,8 +117,7 @@ FLAGS --[no-]assign-ip Assign a public IP address to the instance. This is a public, externally available IPv4 address that you can use to connect to your - instance when properly authorized. Use --assign-ip to enable a public - IP and --no-assign-ip to disable it. Use --assign-ip to enable and + instance when properly authorized. Use --assign-ip to enable and --no-assign-ip to disable. --async @@ -202,9 +202,8 @@ FLAGS --[no-]deletion-protection Enable deletion protection on a Cloud SQL instance. Use - --deletion-protection to enable deletion protection on an instance and - --no-deletion-protection to disable it. Use --deletion-protection to - enable and --no-deletion-protection to disable. + --deletion-protection to enable and --no-deletion-protection to + disable. --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE Date when the deny maintenance period ends, that is 2021-01-10. @@ -220,6 +219,13 @@ FLAGS fraction of a second. Must have automatic backups enabled to use. Make sure storage can support at least 7 days of logs. + --enable-google-private-path + Enable a private path for Google Cloud services. This flag specifies + whether the instance is accessible to internal Google Cloud services + such as BigQuery. This is only applicable to MySQL and PostgreSQL + instances that don't use public IP. Currently, SQL Server isn't + supported. + --enable-password-policy Enable the password policy, which enforces user password management with the policies configured for the instance. This flag is only @@ -398,6 +404,12 @@ FLAGS --time-zone=TIME_ZONE Set a non-default time zone. Only available for SQL Server instances. + --timeout=TIMEOUT; default=3600 + Time to synchronously wait for the operation to complete, after which + the operation continues asynchronously. Ignored if --async flag is + specified. By default, set to 3600s. To wait indefinitely, set to + unlimited. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/alpha/sql/instances/patch b/gcloud/alpha/sql/instances/patch index 3e2ef353f..61bb0fd3d 100644 --- a/gcloud/alpha/sql/instances/patch +++ b/gcloud/alpha/sql/instances/patch @@ -17,8 +17,8 @@ SYNOPSIS [--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE] [--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] [--diff] [--[no-]enable-bin-log] [--[no-]enable-database-replication] - [--enable-password-policy] [--enable-point-in-time-recovery] - [--follow-gae-app=FOLLOW_GAE_APP] + [--enable-google-private-path] [--enable-password-policy] + [--enable-point-in-time-recovery] [--follow-gae-app=FOLLOW_GAE_APP] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] [--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH] @@ -81,8 +81,7 @@ FLAGS --[no-]assign-ip Assign a public IP address to the instance. This is a public, externally available IPv4 address that you can use to connect to your - instance when properly authorized. Use --assign-ip to enable a public - IP and --no-assign-ip to disable it. Use --assign-ip to enable and + instance when properly authorized. Use --assign-ip to enable and --no-assign-ip to disable. --async @@ -143,9 +142,8 @@ FLAGS --[no-]deletion-protection Enable deletion protection on a Cloud SQL instance. Use - --deletion-protection to enable deletion protection on an instance and - --no-deletion-protection to disable it. Use --deletion-protection to - enable and --no-deletion-protection to disable. + --deletion-protection to enable and --no-deletion-protection to + disable. --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE Date when the deny maintenance period ends, that is 2021-01-10. @@ -171,6 +169,13 @@ FLAGS --enable-database-replication to enable and --no-enable-database-replication to disable. + --enable-google-private-path + Enable a private path for Google Cloud services. This flag specifies + whether the instance is accessible to internal Google Cloud services + such as BigQuery. This is only applicable to MySQL and PostgreSQL + instances that don't use public IP. Currently, SQL Server isn't + supported. + --enable-password-policy Enable the password policy, which enforces user password management with the policies configured for the instance. This flag is only diff --git a/gcloud/alpha/sql/users/describe b/gcloud/alpha/sql/users/describe new file mode 100644 index 000000000..6f4709a2c --- /dev/null +++ b/gcloud/alpha/sql/users/describe @@ -0,0 +1,50 @@ +NAME + gcloud alpha sql users describe - retrieves information about a Cloud SQL + user in a given instance + +SYNOPSIS + gcloud alpha sql users describe USERNAME --instance=INSTANCE, -i INSTANCE + [--host=HOST] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Retrieves information about a Cloud SQL user in a given instance. + +EXAMPLES + To fetch a user with name 'my-user' and optional host '%' in instance + 'my-instance', run: + + $ gcloud alpha sql users describe my-user --host=% \ + --instance=my-instance + +POSITIONAL ARGUMENTS + USERNAME + Cloud SQL username. + +REQUIRED FLAGS + --instance=INSTANCE, -i INSTANCE + Cloud SQL instance ID. + +OPTIONAL FLAGS + --host=HOST + Cloud SQL user's host name expressed as a specific IP address or + address range. % denotes an unrestricted host name. Applicable flag for + MySQL instances; ignored for all other engines. Note, if you connect to + your instance using IP addresses, you must add your client IP address + as an Authorized Address, even if your host name is unrestricted. For + help on how to do so, read: + https://cloud.google.com/sql/docs/mysql/configure-ip + +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. + diff --git a/gcloud/alpha/sql/users/help b/gcloud/alpha/sql/users/help index 5e53f837d..b799b7a0c 100644 --- a/gcloud/alpha/sql/users/help +++ b/gcloud/alpha/sql/users/help @@ -22,6 +22,10 @@ COMMANDS delete (ALPHA) Deletes a Cloud SQL user in a given instance. + describe + (ALPHA) Retrieves information about a Cloud SQL user in a given + instance. + list (ALPHA) Lists Cloud SQL users in a given instance. diff --git a/gcloud/alpha/iap/gateway/add-iam-policy-binding b/gcloud/alpha/storage/buckets/add-iam-policy-binding similarity index 70% rename from gcloud/alpha/iap/gateway/add-iam-policy-binding rename to gcloud/alpha/storage/buckets/add-iam-policy-binding index 5846d51f3..a322c0b79 100644 --- a/gcloud/alpha/iap/gateway/add-iam-policy-binding +++ b/gcloud/alpha/storage/buckets/add-iam-policy-binding @@ -1,41 +1,38 @@ NAME - gcloud alpha iap gateway add-iam-policy-binding - add IAM policy binding to - an IAP gateway resource + gcloud alpha storage buckets add-iam-policy-binding - add an IAM policy + binding to a bucket SYNOPSIS - gcloud alpha iap gateway add-iam-policy-binding --member=PRINCIPAL + gcloud alpha storage buckets add-iam-policy-binding URL --member=PRINCIPAL --role=ROLE [--condition=[KEY=VALUE,...] | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Adds a policy binding to the IAM policy of an IAP gateway resource. - One binding consists of a member, a role, and an optional condition. + (ALPHA) Add an IAM policy binding to a bucket. For more information, see + Cloud Identity and Access Management + (https://cloud.google.com/storage/docs/access-control/iam). EXAMPLES - To add an IAM policy binding for the role of 'roles/editor' for the user - 'test-user@gmail.com', run: + To grant a single role to a single principal for BUCKET: - $ gcloud alpha iap gateway add-iam-policy-binding \ - --member='user:test-user@gmail.com' --role='roles/editor' + $ gcloud alpha storage buckets add-iam-policy-binding gs://BUCKET \ + --member=user:john.doe@example.com \ + --role=roles/storage.objectCreator - To add an IAM policy binding for the role of 'roles/editor' for all - authenticated users, run: + To make objects in BUCKET publicly readable: - $ gcloud alpha iap gateway add-iam-policy-binding \ - --member='allAuthenticatedUsers' --role='roles/editor' + $ gcloud alpha storage buckets add-iam-policy-binding gs://BUCKET \ + --member=AllUsers --role=roles/storage.objectViewer - To add an IAM policy binding which expires at the end of the year 2018 for - the role of 'roles/browser' and the user 'test-user@gmail.com' , run: + To specify a custom role for a principal on BUCKET: - $ gcloud alpha iap gateway add-iam-policy-binding \ - --member='user:test-user@gmail.com' --role='roles/browser' \ - --condition='expression=request.time < - timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018, - description=Expires at midnight on 2018-12-31' + $ gcloud alpha storage buckets add-iam-policy-binding gs://BUCKET \ + --member=user:john.doe@example.com --role=roles/customRoleName - See https://cloud.google.com/iam/docs/managing-policies for details of - policy role and member types. +POSITIONAL ARGUMENTS + URL + URL of bucket to add IAM policy binding to. REQUIRED FLAGS --member=PRINCIPAL @@ -108,5 +105,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud storage buckets add-iam-policy-binding diff --git a/gcloud/alpha/storage/buckets/create b/gcloud/alpha/storage/buckets/create index 6decab510..30a63f04b 100644 --- a/gcloud/alpha/storage/buckets/create +++ b/gcloud/alpha/storage/buckets/create @@ -2,13 +2,15 @@ NAME gcloud alpha storage buckets create - create buckets for storing objects SYNOPSIS - gcloud alpha storage buckets create URL + gcloud alpha storage buckets create URL [--additional-headers=HEADER=VALUE] [--default-encryption-key=DEFAULT_ENCRYPTION_KEY, -k DEFAULT_ENCRYPTION_KEY] [--default-storage-class=DEFAULT_STORAGE_CLASS, -c DEFAULT_STORAGE_CLASS, -s DEFAULT_STORAGE_CLASS] - [--location=LOCATION, -l LOCATION] + [--[no-]enable-autoclass] [--location=LOCATION, -l LOCATION] [--[no-]pap, --[no-]public-access-prevention] + [--placement=REGION,REGION] + [--recovery-point-objective=SETTING, --rpo=SETTING] [--retention-period=RETENTION_PERIOD] [--[no-]uniform-bucket-level-access, -b] [GCLOUD_WIDE_FLAG ...] @@ -32,6 +34,12 @@ POSITIONAL ARGUMENTS The URL of the bucket to create. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --default-encryption-key=DEFAULT_ENCRYPTION_KEY, -k DEFAULT_ENCRYPTION_KEY Set the default KMS key using the full path to the key, which has the following form: @@ -43,6 +51,11 @@ FLAGS If not specified, the default storage class used by Cloud Storage is "Standard". + --[no-]enable-autoclass + The Autoclass feature automatically selects the best storage class for + objects based on access patterns. Use --enable-autoclass to enable and + --no-enable-autoclass to disable. + --location=LOCATION, -l LOCATION Location (https://cloud.google.com/storage/docs/locations) for the bucket. If not specified, the location used by Cloud Storage is us. A @@ -51,10 +64,28 @@ FLAGS --[no-]pap, --[no-]public-access-prevention Sets public access prevention to "enforced". For details on how exactly public access is blocked, see: - http://cloud/storage/docs/public-access-prevention. Use + http://cloud.google.com/storage/docs/public-access-prevention. Use --public-access-prevention to enable and --no-public-access-prevention to disable. + --placement=REGION,REGION + A comma-separated list of exactly 2 regions that form the custom + dual-region. Only regions within the same continent are or will ever be + valid. Invalid location pairs (such as mixed-continent, or with + unsupported regions) will return an error. + + --recovery-point-objective=SETTING, --rpo=SETTING + Sets the recovery point objective + (https://cloud.google.com/architecture/dr-scenarios-planning-guide#basics_of_dr_planning) + of a bucket. This flag can only be used with multi-region and + dual-region buckets. DEFAULT option is valid for multi-region and + dual-regions buckets. ASYNC_TURBO option is only valid for dual-region + buckets. If unspecified when the bucket is created, it defaults to + DEFAULT for dual-region and multi-region buckets. For more information, + see Turbo Replication + (https://cloud.google.com/storage/docs/turbo-replication). SETTING must + be one of: ASYNC_TURBO, DEFAULT. + --retention-period=RETENTION_PERIOD Minimum retention period (https://cloud.google.com/storage/docs/bucket-lock#retention-periods) diff --git a/gcloud/alpha/storage/buckets/delete b/gcloud/alpha/storage/buckets/delete index 5bb05dceb..dbb38451b 100644 --- a/gcloud/alpha/storage/buckets/delete +++ b/gcloud/alpha/storage/buckets/delete @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud alpha storage buckets delete URLS [URLS ...] - [--continue-on-error, -c] [GCLOUD_WIDE_FLAG ...] + [--additional-headers=HEADER=VALUE] [--continue-on-error, -c] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Deletes one or more Cloud Storage buckets. @@ -23,6 +24,12 @@ POSITIONAL ARGUMENTS Specifies the URLs of the buckets to delete. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --continue-on-error, -c If any operations are unsuccessful, the command will exit with a non-zero exit status after completing the remaining operations. This diff --git a/gcloud/alpha/storage/buckets/describe b/gcloud/alpha/storage/buckets/describe index 6660c3aaa..dd3247697 100644 --- a/gcloud/alpha/storage/buckets/describe +++ b/gcloud/alpha/storage/buckets/describe @@ -2,7 +2,8 @@ NAME gcloud alpha storage buckets describe - describes Cloud Storage buckets SYNOPSIS - gcloud alpha storage buckets describe URL [GCLOUD_WIDE_FLAG ...] + gcloud alpha storage buckets describe URL + [--additional-headers=HEADER=VALUE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Describe a Cloud Storage bucket. @@ -21,6 +22,13 @@ POSITIONAL ARGUMENTS URL Specifies URL of bucket to describe. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/storage/buckets/get-iam-policy b/gcloud/alpha/storage/buckets/get-iam-policy new file mode 100644 index 000000000..0470db6c5 --- /dev/null +++ b/gcloud/alpha/storage/buckets/get-iam-policy @@ -0,0 +1,42 @@ +NAME + gcloud alpha storage buckets get-iam-policy - get the IAM policy for a + bucket + +SYNOPSIS + gcloud alpha storage buckets get-iam-policy URL [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get the IAM policy for a bucket. For more information, see Cloud + Identity and Access Management + (https://cloud.google.com/storage/docs/access-control/iam). + +EXAMPLES + To get the IAM policy for BUCKET: + + $ gcloud alpha storage buckets get-iam-policy gs://BUCKET + + To output the IAM policy for BUCKET to a file: + + $ gcloud alpha storage buckets get-iam-policy gs://BUCKET > \ + policy.txt + +POSITIONAL ARGUMENTS + URL + Request IAM policy for this bucket. + +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 storage buckets get-iam-policy + diff --git a/gcloud/alpha/storage/buckets/help b/gcloud/alpha/storage/buckets/help index f4179ddf0..827964a67 100644 --- a/gcloud/alpha/storage/buckets/help +++ b/gcloud/alpha/storage/buckets/help @@ -21,6 +21,9 @@ GROUPS COMMANDS COMMAND is one of the following: + add-iam-policy-binding + (ALPHA) Add an IAM policy binding to a bucket. + create (ALPHA) Create buckets for storing objects. @@ -30,9 +33,18 @@ COMMANDS describe (ALPHA) Describes Cloud Storage buckets. + get-iam-policy + (ALPHA) Get the IAM policy for a bucket. + list (ALPHA) Lists Cloud Storage buckets. + remove-iam-policy-binding + (ALPHA) Remove an IAM policy binding from a bucket. + + set-iam-policy + (ALPHA) Set the IAM policy for a bucket. + update (ALPHA) Update bucket settings. diff --git a/gcloud/alpha/storage/buckets/list b/gcloud/alpha/storage/buckets/list index a6540b5e7..46d92f174 100644 --- a/gcloud/alpha/storage/buckets/list +++ b/gcloud/alpha/storage/buckets/list @@ -2,7 +2,8 @@ NAME gcloud alpha storage buckets list - lists Cloud Storage buckets SYNOPSIS - gcloud alpha storage buckets list [URLS ...] [--filter=EXPRESSION] + gcloud alpha storage buckets list [URLS ...] + [--additional-headers=HEADER=VALUE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -26,6 +27,13 @@ POSITIONAL ARGUMENTS [URLS ...] Specifies URL of buckets to List. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/storage/buckets/notifications/create b/gcloud/alpha/storage/buckets/notifications/create index 002ca2f11..c54075ede 100644 --- a/gcloud/alpha/storage/buckets/notifications/create +++ b/gcloud/alpha/storage/buckets/notifications/create @@ -28,8 +28,8 @@ DESCRIPTION the create command uses the Cloud Pub/Sub topic projects/default-project/topics/example-bucket. - In order to enable notifications, your project's [Cloud Storage service - agent] (https://cloud.google.com/storage/docs/projects#service-accounts) + In order to enable notifications, your project's Cloud Storage service + agent (https://cloud.google.com/storage/docs/projects#service-accounts) must have the IAM permission "pubsub.topics.publish". This command checks to see if the destination Cloud Pub/Sub topic grants the service agent this permission. If not, the create command attempts to grant it. diff --git a/gcloud/alpha/iap/gateway/remove-iam-policy-binding b/gcloud/alpha/storage/buckets/remove-iam-policy-binding similarity index 66% rename from gcloud/alpha/iap/gateway/remove-iam-policy-binding rename to gcloud/alpha/storage/buckets/remove-iam-policy-binding index fd64f42b0..6dbb86e58 100644 --- a/gcloud/alpha/iap/gateway/remove-iam-policy-binding +++ b/gcloud/alpha/storage/buckets/remove-iam-policy-binding @@ -1,48 +1,30 @@ NAME - gcloud alpha iap gateway remove-iam-policy-binding - remove IAM policy - binding from an IAP gateway resource + gcloud alpha storage buckets remove-iam-policy-binding - remove an IAM + policy binding from a bucket SYNOPSIS - gcloud alpha iap gateway remove-iam-policy-binding --member=PRINCIPAL - --role=ROLE + gcloud alpha storage buckets remove-iam-policy-binding URL + --member=PRINCIPAL --role=ROLE [--all | --condition=[KEY=VALUE,...] | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Removes a policy binding from the IAM policy of an IAP gateway - resource. One binding consists of a member, a role and an optional - condition. + (ALPHA) Removes a policy binding from the IAM policy of a bucket, given a + bucket URL and the binding. For more information, see Cloud Identity and + Access Management + (https://cloud.google.com/storage/docs/access-control/iam). EXAMPLES - To remove an IAM policy binding for the role of 'roles/editor' for the user - 'test-user@gmail.com', run: + To remove an IAM policy binding from the role of + roles/storage.objectCreator for the user john.doe@example.com on BUCKET: - $ gcloud alpha iap gateway remove-iam-policy-binding \ - --member='user:test-user@gmail.com' --role='roles/editor' + $ gcloud alpha storage buckets remove-iam-policy-binding \ + gs://BUCKET --member=user:john.doe@example.com \ + --role=roles/storage.objectCreator - To remove an IAM policy binding for the role of 'roles/editor' from all - authenticated users,run: - - $ gcloud alpha iap gateway remove-iam-policy-binding \ - --member='allAuthenticatedUsers' --role='roles/editor' - - To remove an IAM policy binding which expires at the end of the year 2018 - for the role of 'roles/browser' for the user 'test-user@gmail.com', run: - - $ gcloud alpha iap gateway remove-iam-policy-binding \ - --member='user:test-user@gmail.com' --role='roles/browser' \ - --condition='expression=request.time < - timestamp("2019-01-01T00:00:00Z"),title=expires_end_of_2018, - description=Expires at midnight on 2018-12-31' - - To remove all IAM policy bindings regardless of the condition for the role - of 'roles/browser' and for the user 'test-user@gmail.com', run: - - $ gcloud alpha iap gateway remove-iam-policy-binding \ - --member='user:test-user@gmail.com' --role='roles/browser' --all - - See https://cloud.google.com/iam/docs/managing-policies for details of - policy role and member types. +POSITIONAL ARGUMENTS + URL + URL of bucket to remove IAM policy binding from. REQUIRED FLAGS --member=PRINCIPAL @@ -120,5 +102,7 @@ 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. + access allowlist. This variant is also available: + + $ gcloud storage buckets remove-iam-policy-binding diff --git a/gcloud/alpha/storage/buckets/set-iam-policy b/gcloud/alpha/storage/buckets/set-iam-policy new file mode 100644 index 000000000..64cda689d --- /dev/null +++ b/gcloud/alpha/storage/buckets/set-iam-policy @@ -0,0 +1,61 @@ +NAME + gcloud alpha storage buckets set-iam-policy - set the IAM policy for a + bucket + +SYNOPSIS + gcloud alpha storage buckets set-iam-policy URLS [URLS ...] POLICY_FILE + [--continue-on-error, -c] [--etag=ETAG, -e ETAG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Set the IAM policy for a bucket. For more information, see Cloud + Identity and Access Management + (https://cloud.google.com/storage/docs/access-control/iam). + +EXAMPLES + To set the IAM policy in POLICY-FILE on BUCKET: + + $ gcloud alpha storage buckets set-iam-policy gs://BUCKET POLICY-FILE + + To set the IAM policy in POLICY-FILE on all buckets beginning with "b": + + $ gcloud alpha storage buckets set-iam-policy gs://b* POLICY-FILE + +POSITIONAL ARGUMENTS + URLS [URLS ...] + URLs for buckets to apply the IAM policy to. Can include wildcards. + + 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 + --continue-on-error, -c + If any operations are unsuccessful, the command will exit with a + non-zero exit status after completing the remaining operations. This + flag takes effect only in sequential execution mode (i.e. processor and + thread count are set to 1). Parallelism is default. + + --etag=ETAG, -e ETAG + Custom etag to set on IAM policy. API will reject etags that do not + match this value, making it useful as a precondition during concurrent + operations. + +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 storage buckets set-iam-policy + diff --git a/gcloud/alpha/storage/buckets/update b/gcloud/alpha/storage/buckets/update index 9387be0c7..672c5c547 100644 --- a/gcloud/alpha/storage/buckets/update +++ b/gcloud/alpha/storage/buckets/update @@ -3,12 +3,19 @@ NAME SYNOPSIS gcloud alpha storage buckets update URL [URL ...] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL] - [--continue-on-error, -c] [--[no-]default-event-based-hold] - [--default-storage-class=DEFAULT_STORAGE_CLASS] - [--[no-]lock-retention-period] [--[no-]requester-pays] - [--[no-]uniform-bucket-level-access] [--[no-]versioning] + [--additional-headers=HEADER=VALUE] [--continue-on-error, -c] + [--[no-]default-event-based-hold] [--[no-]enable-autoclass] + [--lock-retention-period] + [--recovery-point-objective=SETTING, --rpo=SETTING] + [--[no-]requester-pays] [--[no-]uniform-bucket-level-access] + [--[no-]versioning] + [--acl-file=ACL_FILE --add-acl-grant=[ACL_GRANT,...] + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, + -a PREDEFINED_ACL --remove-acl-grant=REMOVE_ACL_GRANT] + [--add-default-object-acl-grant=[DEFAULT_OBJECT_ACL_GRANT,...] + --default-object-acl-file=DEFAULT_OBJECT_ACL_FILE + --predefined-default-object-acl=PREDEFINED_DEFAULT_OBJECT_ACL + --remove-default-object-acl-grant=REMOVE_DEFAULT_OBJECT_ACL_GRANT] [--clear-cors | --cors-file=CORS_FILE] [--clear-default-encryption-key | --default-encryption-key=DEFAULT_ENCRYPTION_KEY] @@ -45,10 +52,11 @@ POSITIONAL ARGUMENTS URLs of the buckets to update. FLAGS - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. --continue-on-error, -c If any operations are unsuccessful, the command will exit with a @@ -63,15 +71,28 @@ FLAGS retroactively). Use --default-event-based-hold to enable and --no-default-event-based-hold to disable. - --default-storage-class=DEFAULT_STORAGE_CLASS - Sets the default storage class for the bucket. + --[no-]enable-autoclass + The Autoclass feature automatically selects the best storage class for + objects based on access patterns. Use --enable-autoclass to enable and + --no-enable-autoclass to disable. - --[no-]lock-retention-period + --lock-retention-period Locks an unlocked retention policy on the buckets. Caution: A locked retention policy cannot be removed from a bucket or reduced in duration. Once locked, deleting the bucket is the only way to "remove" - a retention policy. Use --lock-retention-period to enable and - --no-lock-retention-period to disable. + a retention policy. + + --recovery-point-objective=SETTING, --rpo=SETTING + Sets the recovery point objective + (https://cloud.google.com/architecture/dr-scenarios-planning-guide#basics_of_dr_planning) + of a bucket. This flag can only be used with multi-region and + dual-region buckets. DEFAULT option is valid for multi-region and + dual-regions buckets. ASYNC_TURBO option is only valid for dual-region + buckets. If unspecified when the bucket is created, it defaults to + DEFAULT for dual-region and multi-region buckets. For more information, + see Turbo Replication + (https://cloud.google.com/storage/docs/turbo-replication). SETTING must + be one of: ASYNC_TURBO, DEFAULT. --[no-]requester-pays Allows you to configure a Cloud Storage bucket so that the requester @@ -88,6 +109,42 @@ FLAGS Allows you to configure a Cloud Storage bucket to keep old versions of objects. Use --versioning to enable and --no-versioning to disable. + --acl-file=ACL_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + The output of gcloud storage [buckets|objects] describe + --format="multi(acl:format=json)" is a valid file and can be edited for + more fine-grained control. + + --add-acl-grant=[ACL_GRANT,...] + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud + Storage,--add-acl-grant=entity=user-tim@gmail.com,role=OWNER + + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + + --remove-acl-grant=REMOVE_ACL_GRANT + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud Storage, --remove-acl-grant=ENTITY, where + ENTITY has a valid ACL entity format, such as user-tim@gmail.com, + group-admins, allUsers, etc. + + --add-default-object-acl-grant=[DEFAULT_OBJECT_ACL_GRANT,...] + Adds default object ACL grant. See --add-acl-grant help text for more + details. + + --default-object-acl-file=DEFAULT_OBJECT_ACL_FILE + Sets the default object ACL from file for the bucket. + + --predefined-default-object-acl=PREDEFINED_DEFAULT_OBJECT_ACL + Apply a predefined set of default object access controls tobuckets + + --remove-default-object-acl-grant=REMOVE_DEFAULT_OBJECT_ACL_GRANT + Removes default object ACL grant. See --remove-acl-grant help text for + more details. + At most one of these can be specified: --clear-cors @@ -192,7 +249,7 @@ FLAGS If True, sets public access prevention to "enforced". If False, sets public access prevention to "inherited". For details on how exactly public access is blocked, see: - http://cloud/storage/docs/public-access-prevention. Use + http://cloud.google.com/storage/docs/public-access-prevention. Use --public-access-prevention to enable and --no-public-access-prevention to disable. diff --git a/gcloud/alpha/storage/cat b/gcloud/alpha/storage/cat index 553240bc3..354dda45c 100644 --- a/gcloud/alpha/storage/cat +++ b/gcloud/alpha/storage/cat @@ -3,9 +3,9 @@ NAME stdout SYNOPSIS - gcloud alpha storage cat URL [URL ...] [--display-url, -d] - [--range=RANGE, -r RANGE] [--decryption-keys=[DECRYPTION_KEY,...]] - [GCLOUD_WIDE_FLAG ...] + gcloud alpha storage cat URL [URL ...] [--additional-headers=HEADER=VALUE] + [--display-url, -d] [--range=RANGE, -r RANGE] + [--decryption-keys=[DECRYPTION_KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) The cat command outputs the contents of one or more URLs to stdout. @@ -39,6 +39,12 @@ POSITIONAL ARGUMENTS The url of objects to list. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --display-url, -d Prints the header before each object. diff --git a/gcloud/alpha/storage/cp b/gcloud/alpha/storage/cp index 913d6da21..eaccaa4d0 100644 --- a/gcloud/alpha/storage/cp +++ b/gcloud/alpha/storage/cp @@ -2,7 +2,8 @@ NAME gcloud alpha storage cp - upload, download, and copy Cloud Storage objects SYNOPSIS - gcloud alpha storage cp [SOURCE ...] DESTINATION [--all-versions, -A] + gcloud alpha storage cp [SOURCE ...] DESTINATION + [--additional-headers=HEADER=VALUE] [--all-versions, -A] [--no-clobber, -n] [--continue-on-error, -c] [--daisy-chain, -D] [--do-not-decompress] [--ignore-symlinks] [--manifest-path=MANIFEST_PATH, -L MANIFEST_PATH] @@ -10,9 +11,8 @@ SYNOPSIS [--read-paths-from-stdin, -I] [--recursive, -R, -r] [--skip-unsupported, -U] [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - | --[no-]preserve-acl, -p] + [--canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, + -a PREDEFINED_ACL --[no-]preserve-acl, -p] [--gzip-in-flight=[FILE_EXTENSIONS,...], -j [FILE_EXTENSIONS,...] | --gzip-in-flight-all, -J | --gzip-local=[FILE_EXTENSIONS,...], -z [FILE_EXTENSIONS,...] @@ -76,6 +76,12 @@ POSITIONAL ARGUMENTS The destination path. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -A Copy all source versions from a source bucket or folder. If not set, only the live version of each source object is copied. @@ -171,21 +177,18 @@ FLAGS the default storage class of the destination bucket is used. This option is not valid for copying to non-cloud destinations. - At most one of these can be specified: + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - - --[no-]preserve-acl, -p - Preserves ACLs when copying in the cloud. This option is Google Cloud - Storage-only, and you need OWNER access to all copied objects. If all - objects in the destination bucket should have the same ACL, you can - also set a default object ACL on that bucket instead of using this - flag. Preserving ACLs is the default behavior for updating existing - objects. Use --preserve-acl to enable and --no-preserve-acl to - disable. + --[no-]preserve-acl, -p + Preserves ACLs when copying in the cloud. This option is Google Cloud + Storage-only, and you need OWNER access to all copied objects. If all + objects in the destination bucket should have the same ACL, you can + also set a default object ACL on that bucket instead of using this + flag. Preserving ACLs is the default behavior for updating existing + objects. Use --preserve-acl to enable and --no-preserve-acl to disable. At most one of these can be specified: diff --git a/gcloud/alpha/storage/ls b/gcloud/alpha/storage/ls index 54ab5365f..de0d5c7c1 100644 --- a/gcloud/alpha/storage/ls +++ b/gcloud/alpha/storage/ls @@ -2,9 +2,10 @@ NAME gcloud alpha storage ls - list Cloud Storage buckets and objects SYNOPSIS - gcloud alpha storage ls [PATH ...] [--all-versions, -a] [--buckets, -b] - [--etag, -e] [--format=FORMAT] [--readable-sizes] [--recursive, -R, -r] - [--full, -L | --json, -j | --long, -l] + gcloud alpha storage ls [PATH ...] [--additional-headers=HEADER=VALUE] + [--all-versions, -a] [--buckets, -b] [--etag, -e] + [--fetch-encrypted-object-hashes] [--format=FORMAT] [--readable-sizes] + [--recursive, -R, -r] [--full, -L | --json, -j | --long, -l] [--decryption-keys=[DECRYPTION_KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -74,6 +75,12 @@ POSITIONAL ARGUMENTS gs:// and is allowed to contain wildcard characters. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -a Include non-current object versions in the listing. This flag is typically only useful for buckets with object versioning @@ -90,6 +97,12 @@ FLAGS --etag, -e Include ETag metadata in listings that use the --long flag. + --fetch-encrypted-object-hashes + API requests to the LIST endpoint do not fetch the hashes for encrypted + objects by default. If this flag is set, a GET request is sent for each + encrypted object in order to fetch hashes. This can significantly + increase the cost of the command. + --format=FORMAT Use "gsutil" to get the style of the older gsutil CLI. (e.g. "--format=gsutil"). Other format values (e.g. "json") do not work. See diff --git a/gcloud/alpha/storage/mv b/gcloud/alpha/storage/mv index 3ea3e4a80..0e7c5d3e1 100644 --- a/gcloud/alpha/storage/mv +++ b/gcloud/alpha/storage/mv @@ -2,16 +2,16 @@ NAME gcloud alpha storage mv - moves or renames objects SYNOPSIS - gcloud alpha storage mv [SOURCE ...] DESTINATION [--all-versions, -A] + gcloud alpha storage mv [SOURCE ...] DESTINATION + [--additional-headers=HEADER=VALUE] [--all-versions, -A] [--no-clobber, -n] [--continue-on-error, -c] [--daisy-chain, -D] [--do-not-decompress] [--ignore-symlinks] [--manifest-path=MANIFEST_PATH, -L MANIFEST_PATH] [--preserve-posix, -P] [--print-created-message, -v] [--read-paths-from-stdin, -I] [--skip-unsupported, -U] [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - | --[no-]preserve-acl, -p] + [--canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, + -a PREDEFINED_ACL --[no-]preserve-acl, -p] [--gzip-in-flight=[FILE_EXTENSIONS,...], -j [FILE_EXTENSIONS,...] | --gzip-in-flight-all, -J | --gzip-local=[FILE_EXTENSIONS,...], -z [FILE_EXTENSIONS,...] @@ -87,6 +87,12 @@ POSITIONAL ARGUMENTS The destination path. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -A Copy all source versions from a source bucket or folder. If not set, only the live version of each source object is copied. @@ -178,21 +184,18 @@ FLAGS the default storage class of the destination bucket is used. This option is not valid for copying to non-cloud destinations. - At most one of these can be specified: + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - - --[no-]preserve-acl, -p - Preserves ACLs when copying in the cloud. This option is Google Cloud - Storage-only, and you need OWNER access to all copied objects. If all - objects in the destination bucket should have the same ACL, you can - also set a default object ACL on that bucket instead of using this - flag. Preserving ACLs is the default behavior for updating existing - objects. Use --preserve-acl to enable and --no-preserve-acl to - disable. + --[no-]preserve-acl, -p + Preserves ACLs when copying in the cloud. This option is Google Cloud + Storage-only, and you need OWNER access to all copied objects. If all + objects in the destination bucket should have the same ACL, you can + also set a default object ACL on that bucket instead of using this + flag. Preserving ACLs is the default behavior for updating existing + objects. Use --preserve-acl to enable and --no-preserve-acl to disable. At most one of these can be specified: diff --git a/gcloud/alpha/storage/objects/compose b/gcloud/alpha/storage/objects/compose index c24d958c9..a0a8d3950 100644 --- a/gcloud/alpha/storage/objects/compose +++ b/gcloud/alpha/storage/objects/compose @@ -4,6 +4,7 @@ NAME SYNOPSIS gcloud alpha storage objects compose SOURCE [SOURCE ...] DESTINATION + [--additional-headers=HEADER=VALUE] [--if-generation-match=GENERATION --if-metageneration-match=METAGENERATION] [GCLOUD_WIDE_FLAG ...] @@ -31,6 +32,13 @@ POSITIONAL ARGUMENTS DESTINATION The destination object. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + PRECONDITION FLAGS --if-generation-match=GENERATION Execute only if the generation matches the generation of the requested diff --git a/gcloud/alpha/storage/objects/describe b/gcloud/alpha/storage/objects/describe index 4982ccfc9..9a4441277 100644 --- a/gcloud/alpha/storage/objects/describe +++ b/gcloud/alpha/storage/objects/describe @@ -3,6 +3,7 @@ NAME SYNOPSIS gcloud alpha storage objects describe URL + [--additional-headers=HEADER=VALUE] [--fetch-encrypted-object-hashes] [--decryption-keys=[DECRYPTION_KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -23,6 +24,19 @@ POSITIONAL ARGUMENTS URL Specifies URL of object to describe. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + + --fetch-encrypted-object-hashes + If the initial GET request returns an object encrypted with a + customer-supplied encryption key, the hash fields will be null. If the + matching decryption key is present on the system, this flag retries the + GET request with the key. + ENCRYPTION FLAGS --decryption-keys=[DECRYPTION_KEY,...] A comma-separated list of customer-supplied encryption keys (RFC 4648 diff --git a/gcloud/alpha/storage/objects/list b/gcloud/alpha/storage/objects/list index 5b0d05258..9571438b7 100644 --- a/gcloud/alpha/storage/objects/list +++ b/gcloud/alpha/storage/objects/list @@ -2,8 +2,9 @@ NAME gcloud alpha storage objects list - lists Cloud Storage objects SYNOPSIS - gcloud alpha storage objects list URLS [URLS ...] [--stat] - [--decryption-keys=[DECRYPTION_KEY,...]] [--filter=EXPRESSION] + gcloud alpha storage objects list URLS [URLS ...] + [--additional-headers=HEADER=VALUE] [--fetch-encrypted-object-hashes] + [--stat] [--decryption-keys=[DECRYPTION_KEY,...]] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -33,6 +34,18 @@ POSITIONAL ARGUMENTS Specifies URL of objects to list. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + + --fetch-encrypted-object-hashes + API requests to the LIST endpoint do not fetch the hashes for encrypted + objects by default. If this flag is set, a GET request is sent for each + encrypted object in order to fetch hashes. This can significantly + increase the cost of the command. + --stat Emulates gsutil stat-style behavior. Does not show past object versions and changes output format. diff --git a/gcloud/alpha/storage/objects/update b/gcloud/alpha/storage/objects/update index 0d1ce3ef3..f4feb76de 100644 --- a/gcloud/alpha/storage/objects/update +++ b/gcloud/alpha/storage/objects/update @@ -2,13 +2,16 @@ NAME gcloud alpha storage objects update - update Cloud Storage objects SYNOPSIS - gcloud alpha storage objects update [URL ...] [--continue-on-error, -c] - [--[no-]event-based-hold] [--read-paths-from-stdin, -I] - [--recursive, -R, -r] [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] + gcloud alpha storage objects update [URL ...] + [--additional-headers=HEADER=VALUE] [--all-versions] + [--continue-on-error, -c] [--[no-]event-based-hold] + [--read-paths-from-stdin, -I] [--recursive, -R, -r] + [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] [--[no-]temporary-hold] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - | --[no-]preserve-acl, -p] + [--acl-file=ACL_FILE --add-acl-grant=[ACL_GRANT,...] + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a + PREDEFINED_ACL + --[no-]preserve-acl, -p --remove-acl-grant=REMOVE_ACL_GRANT] [--clear-encryption-key --decryption-keys=[DECRYPTION_KEY,...] --encryption-key=ENCRYPTION_KEY] [--cache-control=CACHE_CONTROL --clear-cache-control @@ -50,6 +53,15 @@ POSITIONAL ARGUMENTS Specifies URLs of objects to update. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + + --all-versions + Perform the operation on all object versions. + --continue-on-error, -c If any operations are unsuccessful, the command will exit with a non-zero exit status after completing the remaining operations. This @@ -77,21 +89,35 @@ FLAGS Enables or disables a temporary hold on objects. Use --temporary-hold to enable and --no-temporary-hold to disable. - At most one of these can be specified: + --acl-file=ACL_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + The output of gcloud storage [buckets|objects] describe + --format="multi(acl:format=json)" is a valid file and can be edited for + more fine-grained control. - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + --add-acl-grant=[ACL_GRANT,...] + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud + Storage,--add-acl-grant=entity=user-tim@gmail.com,role=OWNER - --[no-]preserve-acl, -p - Preserves ACLs when copying in the cloud. This option is Google Cloud - Storage-only, and you need OWNER access to all copied objects. If all - objects in the destination bucket should have the same ACL, you can - also set a default object ACL on that bucket instead of using this - flag. Preserving ACLs is the default behavior for updating existing - objects. Use --preserve-acl to enable and --no-preserve-acl to - disable. + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + + --[no-]preserve-acl, -p + Preserves ACLs when copying in the cloud. This option is Google Cloud + Storage-only, and you need OWNER access to all copied objects. If all + objects in the destination bucket should have the same ACL, you can + also set a default object ACL on that bucket instead of using this + flag. Preserving ACLs is the default behavior for updating existing + objects. Use --preserve-acl to enable and --no-preserve-acl to disable. + + --remove-acl-grant=REMOVE_ACL_GRANT + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud Storage, --remove-acl-grant=ENTITY, where + ENTITY has a valid ACL entity format, such as user-tim@gmail.com, + group-admins, allUsers, etc. ENCRYPTION FLAGS --clear-encryption-key diff --git a/gcloud/alpha/storage/rm b/gcloud/alpha/storage/rm index c1a76df15..830bc6e9d 100644 --- a/gcloud/alpha/storage/rm +++ b/gcloud/alpha/storage/rm @@ -2,9 +2,9 @@ NAME gcloud alpha storage rm - delete objects and buckets SYNOPSIS - gcloud alpha storage rm [URLS ...] [--all-versions, -a] - [--continue-on-error, -c] [--read-paths-from-stdin, -I] - [--recursive, -R, -r] + gcloud alpha storage rm [URLS ...] [--additional-headers=HEADER=VALUE] + [--all-versions, -a] [--continue-on-error, -c] + [--read-paths-from-stdin, -I] [--recursive, -R, -r] [--if-generation-match=GENERATION --if-metageneration-match=METAGENERATION] [GCLOUD_WIDE_FLAG ...] @@ -52,6 +52,12 @@ POSITIONAL ARGUMENTS The URLs of the resources to delete. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -a Delete all versions (https://cloud.google.com/storage/docs/object-versioning) of an object. diff --git a/gcloud/alpha/tasks/queues/create b/gcloud/alpha/tasks/queues/create index e501fc303..a69e338ad 100644 --- a/gcloud/alpha/tasks/queues/create +++ b/gcloud/alpha/tasks/queues/create @@ -47,10 +47,12 @@ FLAGS --http-uri-override=KEY:VALUE,[KEY:VALUE,...] If provided, the specified HTTP target URI override is used for all - tasks in the queue, no matter what is set at the task-level. + tasks in the queue depending on what is set as the mode. Allowed values + for mode are: ALWAYS, IF_NOT_EXISTS. If not set, mode defaults to + ALWAYS. - KEY must be at least one of: [scheme, host, port, path, query]. Any - missing keys will use the default. + KEY must be at least one of: [scheme, host, port, path, query, mode]. + Any missing keys will use the default. --location=LOCATION The location where we want to manage the queue or task. If not diff --git a/gcloud/alpha/tasks/queues/update b/gcloud/alpha/tasks/queues/update index 64fd8fed6..5b9faeb2a 100644 --- a/gcloud/alpha/tasks/queues/update +++ b/gcloud/alpha/tasks/queues/update @@ -3,6 +3,20 @@ NAME SYNOPSIS gcloud alpha tasks queues update QUEUE [--location=LOCATION] + [--clear-http-header-override + | --http-header-override=HEADER_FIELD: HEADER_VALUE] + [--clear-http-method-override + | --http-method-override=HTTP_METHOD_OVERRIDE] + [--clear-http-oauth-service-account-email-override + | --http-oauth-service-account-email-override=HTTP_OAUTH_SERVICE_ACCOUNT_EMAIL_OVERRIDE] + [--clear-http-oauth-token-scope-override + | --http-oauth-token-scope-override=HTTP_OAUTH_TOKEN_SCOPE_OVERRIDE] + [--clear-http-oidc-service-account-email-override + | --http-oidc-service-account-email-override=HTTP_OIDC_SERVICE_ACCOUNT_EMAIL_OVERRIDE] + [--clear-http-oidc-token-audience-override + | --http-oidc-token-audience-override=HTTP_OIDC_TOKEN_AUDIENCE_OVERRIDE] + [--clear-http-uri-override + | --http-uri-override=KEY:VALUE,[KEY:VALUE,...]] [--clear-max-attempts | --max-attempts=MAX_ATTEMPTS] [--clear-max-backoff | --max-backoff=MAX_BACKOFF] [--clear-max-concurrent-tasks @@ -39,6 +53,90 @@ FLAGS specified, uses the location of the current project's App Engine app if there is an associated app. + At most one of these can be specified: + + --clear-http-header-override + Clear the field corresponding to --http-header-override. + + --http-header-override=HEADER_FIELD: HEADER_VALUE + If provided, the specified HTTP headers overrides the existing + headers for all tasks in the queue. If a task has a header with the + same Key as a queue-level header override, then the value of the task + header will be overriden with the value of the queue-level header. + Otherwise, the queue-level header will be added to the task headers. + Header values can contain commas. This flag can be repeated. Repeated + header fields will have their values overridden. + + At most one of these can be specified: + + --clear-http-method-override + Clear the field corresponding to --http-method-override. + + --http-method-override=HTTP_METHOD_OVERRIDE + If provided, the specified HTTP method type override is used for all + tasks in the queue, no matter what is set at the task-level. + + At most one of these can be specified: + + --clear-http-oauth-service-account-email-override + Clear the field corresponding to + --http-oauth-service-account-email-override. + + --http-oauth-service-account-email-override=HTTP_OAUTH_SERVICE_ACCOUNT_EMAIL_OVERRIDE + The service account email to be used for generating an OAuth2 access + token to be included in the request sent to the target when executing + the task. The service account must be within the same project as the + queue. The caller must have 'iam.serviceAccounts.actAs' permission + for the service account. + + At most one of these can be specified: + + --clear-http-oauth-token-scope-override + Clear the field corresponding to --http-oauth-token-scope-override. + + --http-oauth-token-scope-override=HTTP_OAUTH_TOKEN_SCOPE_OVERRIDE + The scope to be used when generating an OAuth2 access token to be + included in the request sent to the target when executing the task. + If not specified, 'https://www.googleapis.com/auth/cloud-platform' + will be used. + + At most one of these can be specified: + + --clear-http-oidc-service-account-email-override + Clear the field corresponding to + --http-oidc-service-account-email-override. + + --http-oidc-service-account-email-override=HTTP_OIDC_SERVICE_ACCOUNT_EMAIL_OVERRIDE + The service account email to be used for generating an OpenID Connect + token to be included in the request sent to the target when executing + the task. The service account must be within the same project as the + queue. The caller must have 'iam.serviceAccounts.actAs' permission + for the service account. + + At most one of these can be specified: + + --clear-http-oidc-token-audience-override + Clear the field corresponding to --http-oidc-token-audience-override. + + --http-oidc-token-audience-override=HTTP_OIDC_TOKEN_AUDIENCE_OVERRIDE + The audience to be used when generating an OpenID Connect token to be + included in the request sent to the target when executing the task. + If not specified, the URI specified in the target will be used. + + At most one of these can be specified: + + --clear-http-uri-override + Clear the field corresponding to --http-uri-override. + + --http-uri-override=KEY:VALUE,[KEY:VALUE,...] + If provided, the specified HTTP target URI override is used for all + tasks in the queue depending on what is set as the mode. Allowed + values for mode are: ALWAYS, IF_NOT_EXISTS. If not set, mode defaults + to ALWAYS. + + KEY must be at least one of: [scheme, host, port, path, query, mode]. + Any missing keys will use the default. + At most one of these can be specified: --clear-max-attempts diff --git a/gcloud/alpha/terraform/vet b/gcloud/alpha/terraform/vet index d99d9bc48..765d50d9d 100644 --- a/gcloud/alpha/terraform/vet +++ b/gcloud/alpha/terraform/vet @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha terraform vet TERRAFORM_PLAN_JSON - --policy-library=POLICY_LIBRARY [GCLOUD_WIDE_FLAG ...] + --policy-library=POLICY_LIBRARY [--region=REGION] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Validate that a terraform plan complies with policies. @@ -25,6 +26,13 @@ REQUIRED FLAGS --policy-library=POLICY_LIBRARY Directory which contains a policy library +OPTIONAL FLAGS + --region=REGION + Default region to use for resources that do not have one set + + --zone=ZONE + Default zone to use for resources that do not have one set + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/topic/help b/gcloud/alpha/topic/help new file mode 100644 index 000000000..c093967fe --- /dev/null +++ b/gcloud/alpha/topic/help @@ -0,0 +1,83 @@ +NAME + gcloud alpha topic - gcloud supplementary help + +DESCRIPTION + (ALPHA) The gcloud alpha topic command group provides supplementary help + for topics not directly associated with individual commands. + + More information on gcloud alpha topic can be found by running: + + $ gcloud topic [TOPIC_NAME] + + For a list of available topics run: + + $ gcloud topic --help + +TOPICS + The supplementary help topics are: + + accessibility + (ALPHA) Reference for Accessibility features. + + arg-files + (ALPHA) Supplementary help for arg-files to be used with gcloud + firebase test. + + cli-trees + (ALPHA) CLI trees supplementary help. + + client-certificate + (ALPHA) Client certificate authorization supplementary help. + + command-conventions + (ALPHA) gcloud command conventions supplementary help. + + configurations + (ALPHA) Supplementary help for named configurations. + + datetimes + (ALPHA) Date/time input format supplementary help. + + endpoint-override + (ALPHA) gcloud endpoint override supplementary help. + + escaping + (ALPHA) List/dictionary-type argument escaping supplementary help. + + filters + (ALPHA) Resource filters supplementary help. + + flags-file + (ALPHA) --flags-file=YAML_FILE supplementary help. + + formats + (ALPHA) Resource formats supplementary help. + + gcloudignore + (ALPHA) Reference for .gcloudignore files. + + offline-help + (ALPHA) Setting up gcloud command offline help. + + projections + (ALPHA) Resource projections supplementary help. + + resource-keys + (ALPHA) Resource keys supplementary help. + + startup + (ALPHA) Supplementary help for gcloud startup options. + + uninstall + (ALPHA) Supplementary help for uninstalling Google Cloud CLI. + +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 topic + + $ gcloud beta topic + diff --git a/gcloud/alpha/transfer/agents/install b/gcloud/alpha/transfer/agents/install index 2e8ed5bba..e88a77c83 100644 --- a/gcloud/alpha/transfer/agents/install +++ b/gcloud/alpha/transfer/agents/install @@ -3,8 +3,10 @@ NAME SYNOPSIS gcloud alpha transfer agents install --pool=POOL [--count=COUNT] - [--creds-file=CREDS_FILE] [--enable-multipart] [--id-prefix=ID_PREFIX] + [--creds-file=CREDS_FILE] [--[no-]enable-multipart] + [--id-prefix=ID_PREFIX] [--logs-directory=LOGS_DIRECTORY; default="/tmp"] + [--max-concurrent-small-file-uploads=MAX_CONCURRENT_SMALL_FILE_UPLOADS] [--memlock-limit=MEMLOCK_LIMIT; default=64000000] [--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY] [--s3-compatible-mode] [GCLOUD_WIDE_FLAG ...] @@ -15,16 +17,22 @@ DESCRIPTION installed locally on your machine and run inside Docker containers. EXAMPLES + To create an agent pool for your agent, see the gcloud transfer agent-pools + create command. + To install an agent that authenticates with your user account credentials and has default agent parameters, run: - $ gcloud alpha transfer agents install + $ gcloud alpha transfer agents install --pool=AGENT_POOL + + You will be prompted to run a command to generate a credentials file if one + does not already exist. To install an agent that authenticates with a service account with credentials stored at '/example/path.json', run: $ gcloud alpha transfer agents install \ - --creds-file=/example/path.json + --creds-file=/example/path.json --pool=AGENT_POOL REQUIRED FLAGS --pool=POOL @@ -49,11 +57,12 @@ OPTIONAL FLAGS Note that the credentials location will be mounted to the agent container. - --enable-multipart + --[no-]enable-multipart Split up files and transfer the resulting chunks in parallel before merging them at the destination. Can be used make transfers of large files faster as long as the network and disk speed are not limiting - factors. + factors. If unset, agent decides when to use the feature. Use + --enable-multipart to enable and --no-enable-multipart to disable. --id-prefix=ID_PREFIX An optional prefix to add to the agent ID to help identify the agent. @@ -63,6 +72,11 @@ OPTIONAL FLAGS logs in. If not specified, gcloud transfer will mount your /tmp directory for logs. + --max-concurrent-small-file-uploads=MAX_CONCURRENT_SMALL_FILE_UPLOADS + Adjust the maximum number of files less than or equal to 32 MiB large + that the agent can upload in parallel. Not recommended for users + unfamiliar with Google Cloud's rate limiting. + --memlock-limit=MEMLOCK_LIMIT; default=64000000 Set the agent container's memlock limit. A value of 64000000 (default) or higher is required to ensure that agent versions 1.14 or later have diff --git a/gcloud/alpha/transfer/jobs/config/export b/gcloud/alpha/transfer/jobs/config/export index f17198ead..9fbd5165e 100644 --- a/gcloud/alpha/transfer/jobs/config/export +++ b/gcloud/alpha/transfer/jobs/config/export @@ -64,7 +64,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/alpha/transfer/jobs/create b/gcloud/alpha/transfer/jobs/create index 297e2e2be..335b3a542 100644 --- a/gcloud/alpha/transfer/jobs/create +++ b/gcloud/alpha/transfer/jobs/create @@ -9,6 +9,9 @@ SYNOPSIS --destination-agent-pool=DESTINATION_AGENT_POOL --intermediate-storage-path=INTERMEDIATE_STORAGE_PATH --manifest-file=MANIFEST_FILE] + [--event-stream-name=EVENT_STREAM_NAME + --event-stream-starts=EVENT_STREAM_STARTS + --event-stream-expires=EVENT_STREAM_EXPIRES] [--do-not-run --schedule-starts=SCHEDULE_STARTS --schedule-repeats-every=SCHEDULE_REPEATS_EVERY --schedule-repeats-until=SCHEDULE_REPEATS_UNTIL] @@ -24,7 +27,7 @@ SYNOPSIS [--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC --notification-event-types=[EVENT_TYPES,...] --notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT] - [--log-actions=[LOG_ACTIONS,...] + [--[no-]enable-posix-transfer-logs --log-actions=[LOG_ACTIONS,...] --log-action-states=[LOG_ACTION_STATES,...]] [--source-endpoint=SOURCE_ENDPOINT --source-signing-region=SOURCE_SIGNING_REGION @@ -154,6 +157,36 @@ FLAGS gs://mybucket/manifest.csv. For manifest file formatting, see https://cloud.google.com/storage-transfer/docs/manifest. + EVENT STREAM + + Configure an event stream to transfer data whenever it is added or changed + at your source, enabling you to act on the data in near real time. This + event-driven transfer execution mode is available for transfers from + Google Cloud Storage and Amazon S3. For formatting information, see + https://cloud.google.com/sdk/gcloud/reference/topic/datetimes. + + --event-stream-name=EVENT_STREAM_NAME + Specify an event stream that Storage Transfer Service can use to + listen for when objects are created or updated. For Google Cloud + Storage sources, specify a Cloud Pub/Sub subscription, using format + "projects/yourproject/subscriptions/yoursubscription". For Amazon S3 + sources, specify the Amazon Resource Name (ARN) of an Amazon Simple + Queue Service (SQS) queue using format + "arn:aws:sqs:region:account_id:queue_name". + + --event-stream-starts=EVENT_STREAM_STARTS + Set when to start listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will start running + and listening for events upon the successful submission of the create + job command. + + --event-stream-expires=EVENT_STREAM_EXPIRES + Set when to stop listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will continue running + and listening for events indefinitely. + SCHEDULE A job's schedule determines when and how often the job will run. For @@ -270,9 +303,20 @@ FLAGS --custom-storage-class=CUSTOM_STORAGE_CLASS Specifies the storage class to set on objects being transferred to - Google Cloud Storage buckets. If unspecified, the behavior is to - match the destination bucket default. The value "preserve" will use - the class from the object's Google Cloud Storage source bucket. + Cloud Storage buckets. If unspecified, the objects' storage class is + set to the destination bucket default. Valid values are: + + ▸ Any of the values listed in the Cloud Storage documentation: + Available storage classes + (https://cloud.google.com/storage/docs/storage-classes#classes). + ▸ preserve - Preserves each object's original storage class. Only + supported for transfers between Cloud Storage buckets. + + Custom storage class settings are ignored if the destination bucket + is Autoclass-enabled + (https://cloud.google.com/storage/docs/autoclass). Objects + transferred into Autoclass-enabled buckets are initially set to the + STANDARD storage class. NOTIFICATION CONFIG @@ -303,6 +347,12 @@ FLAGS are generated for this job. Logs can be viewed by running the following command: gcloud logging read "resource.type=storage_transfer_job" + --[no-]enable-posix-transfer-logs + Sets whether to generate logs for transfers with a POSIX filesystem + source. This setting will later be merged with other log + configurations. Use --enable-posix-transfer-logs to enable and + --no-enable-posix-transfer-logs to disable. + --log-actions=[LOG_ACTIONS,...] Define the transfer operation actions to report in logs. Separate multiple actions with commas, omitting spaces after the commas (e.g., diff --git a/gcloud/alpha/transfer/jobs/update b/gcloud/alpha/transfer/jobs/update index ab6602f8a..3d1cfd6a4 100644 --- a/gcloud/alpha/transfer/jobs/update +++ b/gcloud/alpha/transfer/jobs/update @@ -12,6 +12,9 @@ SYNOPSIS --destination-agent-pool=DESTINATION_AGENT_POOL --intermediate-storage-path=INTERMEDIATE_STORAGE_PATH --manifest-file=MANIFEST_FILE] + [--event-stream-name=EVENT_STREAM_NAME + --event-stream-starts=EVENT_STREAM_STARTS + --event-stream-expires=EVENT_STREAM_EXPIRES --clear-event-stream] [--clear-schedule --schedule-starts=SCHEDULE_STARTS --schedule-repeats-every=SCHEDULE_REPEATS_EVERY --schedule-repeats-until=SCHEDULE_REPEATS_UNTIL] @@ -34,7 +37,8 @@ SYNOPSIS --notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC --notification-event-types=[EVENT_TYPES,...] --notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT] - [--clear-log-config --log-actions=[LOG_ACTIONS,...] + [--clear-log-config --[no-]enable-posix-transfer-logs + --log-actions=[LOG_ACTIONS,...] --log-action-states=[LOG_ACTION_STATES,...]] [--source-endpoint=SOURCE_ENDPOINT --source-signing-region=SOURCE_SIGNING_REGION @@ -176,6 +180,41 @@ FLAGS gs://mybucket/manifest.csv. For manifest file formatting, see https://cloud.google.com/storage-transfer/docs/manifest. + EVENT STREAM + + Configure an event stream to transfer data whenever it is added or changed + at your source, enabling you to act on the data in near real time. This + event-driven transfer execution mode is available for transfers from + Google Cloud Storage and Amazon S3. For formatting information, see + https://cloud.google.com/sdk/gcloud/reference/topic/datetimes. + + --event-stream-name=EVENT_STREAM_NAME + Specify an event stream that Storage Transfer Service can use to + listen for when objects are created or updated. For Google Cloud + Storage sources, specify a Cloud Pub/Sub subscription, using format + "projects/yourproject/subscriptions/yoursubscription". For Amazon S3 + sources, specify the Amazon Resource Name (ARN) of an Amazon Simple + Queue Service (SQS) queue using format + "arn:aws:sqs:region:account_id:queue_name". + + --event-stream-starts=EVENT_STREAM_STARTS + Set when to start listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will start running + and listening for events upon the successful submission of the create + job command. + + --event-stream-expires=EVENT_STREAM_EXPIRES + Set when to stop listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will continue running + and listening for events indefinitely. + + --clear-event-stream + Remove the job's entire event stream configuration by clearing all + scheduling all event stream flags. The job will no longer listen for + events unless a new configuratin is specified. + SCHEDULE A job's schedule determines when and how often the job will run. For @@ -325,9 +364,20 @@ FLAGS --custom-storage-class=CUSTOM_STORAGE_CLASS Specifies the storage class to set on objects being transferred to - Google Cloud Storage buckets. If unspecified, the behavior is to - match the destination bucket default. The value "preserve" will use - the class from the object's Google Cloud Storage source bucket. + Cloud Storage buckets. If unspecified, the objects' storage class is + set to the destination bucket default. Valid values are: + + ▸ Any of the values listed in the Cloud Storage documentation: + Available storage classes + (https://cloud.google.com/storage/docs/storage-classes#classes). + ▸ preserve - Preserves each object's original storage class. Only + supported for transfers between Cloud Storage buckets. + + Custom storage class settings are ignored if the destination bucket + is Autoclass-enabled + (https://cloud.google.com/storage/docs/autoclass). Objects + transferred into Autoclass-enabled buckets are initially set to the + STANDARD storage class. NOTIFICATION CONFIG @@ -368,6 +418,12 @@ FLAGS --clear-log-config Remove the job's full logging config. + --[no-]enable-posix-transfer-logs + Sets whether to generate logs for transfers with a POSIX filesystem + source. This setting will later be merged with other log + configurations. Use --enable-posix-transfer-logs to enable and + --no-enable-posix-transfer-logs to disable. + --log-actions=[LOG_ACTIONS,...] Define the transfer operation actions to report in logs. Separate multiple actions with commas, omitting spaces after the commas (e.g., diff --git a/gcloud/alpha/workstations/clusters/create b/gcloud/alpha/workstations/clusters/create new file mode 100644 index 000000000..a48c703d9 --- /dev/null +++ b/gcloud/alpha/workstations/clusters/create @@ -0,0 +1,91 @@ +NAME + gcloud alpha workstations clusters create - create a workstation cluster + +SYNOPSIS + gcloud alpha workstations clusters create (CLUSTER : --region=REGION) + [--async] [--enable-private-endpoint] [--network=NETWORK] + [--subnetwork=SUBNETWORK] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a workstation cluster. + +EXAMPLES + To create a public cluster my-cluster in region us-central1, run: + + $ gcloud alpha workstations clusters create my-cluster \ + --region=us-central1 + + To create a private cluster 'my-private-cluster' associated with network + 'my-network' and subnetwork 'my-subnetwork'. run: + + $ gcloud alpha workstations clusters create my-private-cluster \ + --region=us-central1 --enable-private-endpoint \ + --network='my-network' --subnetwork='my-subnetwork' + +POSITIONAL ARGUMENTS + Cluster resource - Arguments and flags that specify the cluster to create. + 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --enable-private-endpoint + Default is false. If specified, the cluster will be assigned an + internal IP address to the Cluster Gateway. This isolates the cluster's + workstations from public networks, but requires additional + configuration. Learn more: https://cloud.google.com/workstations/docs. + + --network=NETWORK + The network that instances created under the cluster will be associated + with. + + --subnetwork=SUBNETWORK + The subnetwork that instances created under the cluster will be + associated with. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations clusters create + diff --git a/gcloud/alpha/workstations/clusters/delete b/gcloud/alpha/workstations/clusters/delete new file mode 100644 index 000000000..d4e38457a --- /dev/null +++ b/gcloud/alpha/workstations/clusters/delete @@ -0,0 +1,68 @@ +NAME + gcloud alpha workstations clusters delete - delete a workstation cluster + +SYNOPSIS + gcloud alpha workstations clusters delete (CLUSTER : --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a workstation cluster. + +EXAMPLES + To delete a cluster, run: + + $ gcloud alpha workstations clusters delete WORKSTATION + +POSITIONAL ARGUMENTS + Cluster resource - The name of the cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations clusters delete + diff --git a/gcloud/alpha/workstations/clusters/describe b/gcloud/alpha/workstations/clusters/describe new file mode 100644 index 000000000..fc2b3d61f --- /dev/null +++ b/gcloud/alpha/workstations/clusters/describe @@ -0,0 +1,63 @@ +NAME + gcloud alpha workstations clusters describe - describe a cluster + +SYNOPSIS + gcloud alpha workstations clusters describe (CLUSTER : --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a cluster. + +EXAMPLES + To describe a cluster, run: + + $ gcloud alpha workstations clusters describe CLUSTER + +POSITIONAL ARGUMENTS + Cluster resource - The name of the cluster to display. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --region 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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations clusters describe + diff --git a/gcloud/alpha/workstations/clusters/help b/gcloud/alpha/workstations/clusters/help index eb4cf4a11..744404da5 100644 --- a/gcloud/alpha/workstations/clusters/help +++ b/gcloud/alpha/workstations/clusters/help @@ -16,6 +16,15 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + create + (ALPHA) Create a workstation cluster. + + delete + (ALPHA) Delete a workstation cluster. + + describe + (ALPHA) Describe a cluster. + list (ALPHA) List workstation clusters. diff --git a/gcloud/alpha/workstations/configs/create b/gcloud/alpha/workstations/configs/create new file mode 100644 index 000000000..e05136916 --- /dev/null +++ b/gcloud/alpha/workstations/configs/create @@ -0,0 +1,242 @@ +NAME + gcloud alpha workstations configs create - create a workstation + configuration + +SYNOPSIS + gcloud alpha workstations configs create + (CONFIG : --cluster=CLUSTER --region=REGION) [--async] + [--boot-disk-size=BOOT_DISK_SIZE; default=50] + [--container-args=[CONTAINER_ARGS,...]] + [--container-command=[CONTAINER_COMMAND,...]] + [--container-env=[CONTAINER_ENV,...]] + [--container-run-as-user=CONTAINER_RUN_AS_USER] + [--container-working-dir=CONTAINER_WORKING_DIR] + [--disable-public-ip-addresses] [--enable-confidential-compute] + [--idle-timeout=IDLE_TIMEOUT; default=7200] + [--machine-type=MACHINE_TYPE; default="e2-standard-4"] + [--network-tags=[NETWORK_TAGS,...]] + [--pd-disk-size=PD_DISK_SIZE; default=200] + [--pd-disk-type=PD_DISK_TYPE; default="pd-standard"] + [--pd-reclaim-policy=PD_RECLAIM_POLICY; default="delete"] + [--pool-size=POOL_SIZE] + [--running-timeout=RUNNING_TIMEOUT; default=7200] + [--service-account=SERVICE_ACCOUNT] [--shielded-integrity-monitoring] + [--shielded-secure-boot] [--shielded-vtpm] + [--container-custom-image=CONTAINER_CUSTOM_IMAGE + | --container-predefined-image=CONTAINER_PREDEFINED_IMAGE; + default="codeoss"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a workstation configuration. + +EXAMPLES + To create a configuration with the 'e2-standard-8' machine type and a + IntelliJ image, run: + + $ gcloud alpha workstations configs create CONFIG \ + --machine-type=e2-standard-8 \ + --container-predefined-image=intellij + + To create a configuration with a Shielded VM instance that enables Secure + Boot, virtual trusted platform module (vTPM) and integrity monitoring, run: + + $ gcloud alpha workstations configs create CONFIG \ + --machine-type=e2-standard-4 --shielded-secure-boot \ + --shielded-vtpm --shielded-integrity-monitoring + + To create a configuration with a non-default persistent disk containing + 10GB of PD SSD storage, run: $ gcloud alpha workstations configs create CONFIG \ + --machine-type=e2-standard-4 --pd-disk-type=pd-ssd \ + --pd-disk-size=10 + +POSITIONAL ARGUMENTS + Config resource - The group of arguments defining a config 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 config 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. + + CONFIG + ID of the config or fully qualified identifier for the config. To set + the config attribute: + ▸ provide the argument config on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The cluster for the config. To set the cluster attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + The location for the config. To set the region attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --boot-disk-size=BOOT_DISK_SIZE; default=50 + Size of the boot disk in GB. + + --container-args=[CONTAINER_ARGS,...] + Arguments passed to the entrypoint. + + Example: + + $ gcloud alpha workstations configs create \ + --container-args=arg_1,arg_2 + + --container-command=[CONTAINER_COMMAND,...] + If set, overrides the default ENTRYPOINT specified by the image. + + Example: + + $ gcloud alpha workstations configs create \ + --container-command=executable,parameter_1,parameter_2 + + --container-env=[CONTAINER_ENV,...] + Environment variables passed to the container. + + Example: + + $ gcloud alpha workstations configs create \ + --container-env=key1=value1,key2=value2 + + --container-run-as-user=CONTAINER_RUN_AS_USER + If set, overrides the USER specified in the image with the given uid. + + --container-working-dir=CONTAINER_WORKING_DIR + If set, overrides the default DIR specified by the image. + + --disable-public-ip-addresses + Default value is false. If set, instances will have no public IP + address. + + --enable-confidential-compute + Default value is false. If set, instances will have confidential + compute enabled. + + --idle-timeout=IDLE_TIMEOUT; default=7200 + How long (in seconds) to wait before automatically stopping an instance + that hasn't received any user traffic. A value of 0 indicates that this + instance should never time out due to idleness. + + --machine-type=MACHINE_TYPE; default="e2-standard-4" + Machine type determines the specifications of the Compute Engine + machines that the workstations created under this configuration will + run on. MACHINE_TYPE must be one of: e2-standard-2, e2-standard-4, + e2-standard-8, e2-standard-16, e2-standard-32, n2-standard-8, + n1-standard-4, t2d-standard-6, n2d-standard-2, n2d-standard-4, + n2d-standard-8, n2d-standard-16, n2d-standard-32. + + --network-tags=[NETWORK_TAGS,...] + Network tags to add to the Google Compute Engine machines backing the + Workstations. + + Example: + + $ gcloud alpha workstations configs create --network-tags=tag_1,tag_2 + + --pd-disk-size=PD_DISK_SIZE; default=200 + Size of the persistent directory in GB. PD_DISK_SIZE must be one of: + 10, 50, 100, 200, 500, 1000. + + --pd-disk-type=PD_DISK_TYPE; default="pd-standard" + Type of the persistent directory. PD_DISK_TYPE must be one of: + pd-standard, pd-balanced, pd-ssd. + + --pd-reclaim-policy=PD_RECLAIM_POLICY; default="delete" + What should happen to the disk after the Workstation is deleted. + PD_RECLAIM_POLICY must be one of: + + delete + The persistent disk will be deleted with the Workstation. + retain + The persistent disk will be remain after the workstation is deleted + and the administrator must manually delete the disk. + + --pool-size=POOL_SIZE + Number of instances to pool for faster Workstation starup. + + --running-timeout=RUNNING_TIMEOUT; default=7200 + How long (in seconds) to wait before automatically stopping a + workstation after it started. A value of 0 indicates that workstations + using this config should never time out. + + --service-account=SERVICE_ACCOUNT + Email address of the service account that will be used on VM instances + used to support this config. This service account must have permission + to pull the specified container image. If not set, VMs will run without + a service account, in which case the image must be publicly accessible. + + --shielded-integrity-monitoring + Default value is false. If set, instances will have integrity + monitoring enabled. + + --shielded-secure-boot + Default value is false. If set, instances will have Secure Boot + enabled. + + --shielded-vtpm + Default value is false. If set, instances will have vTPM enabled. + + At most one of these can be specified: + + --container-custom-image=CONTAINER_CUSTOM_IMAGE + A docker image for the workstation. This image must be accessible by + the service account configured in this configuration + (--service-account). If no service account is defined, this image + must be public. + + --container-predefined-image=CONTAINER_PREDEFINED_IMAGE; default="codeoss" + Code editor on base images. CONTAINER_PREDEFINED_IMAGE must be one + of: + + base-image + Base image - no IDE + clion + CLion + codeoss + Code OSS + goland + GoLand + intellij + IntelliJ IDEA Ultimate + phpstorm + PhpStorm + pycharm + PyCharm Professional + rider + Rider + rubymine + RubyMine + webstorm + WebStorm + +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 workstations configs create + diff --git a/gcloud/alpha/workstations/configs/delete b/gcloud/alpha/workstations/configs/delete new file mode 100644 index 000000000..ca6045308 --- /dev/null +++ b/gcloud/alpha/workstations/configs/delete @@ -0,0 +1,78 @@ +NAME + gcloud alpha workstations configs delete - delete a workstation + configuration + +SYNOPSIS + gcloud alpha workstations configs delete + (CONFIG : --cluster=CLUSTER --region=REGION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a workstation configuration. + +EXAMPLES + To delete a configuration, run: + + $ gcloud alpha workstations configs delete WORKSTATION + +POSITIONAL ARGUMENTS + Config resource - The name of the configuration 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 config 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. + + CONFIG + ID of the config or fully qualified identifier for the config. To set + the config attribute: + ▸ provide the argument config on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the config. + + To set the cluster attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + The name of the region of the config. + + To set the region attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations configs delete + diff --git a/gcloud/alpha/workstations/configs/describe b/gcloud/alpha/workstations/configs/describe new file mode 100644 index 000000000..1c5ee3051 --- /dev/null +++ b/gcloud/alpha/workstations/configs/describe @@ -0,0 +1,71 @@ +NAME + gcloud alpha workstations configs describe - describe a config + +SYNOPSIS + gcloud alpha workstations configs describe + (CONFIG : --cluster=CLUSTER --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a config. + +EXAMPLES + To describe a config, run: + + $ gcloud alpha workstations configs describe CONFIG + +POSITIONAL ARGUMENTS + Config resource - The name of the config to display. 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 config 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. + + CONFIG + ID of the config or fully qualified identifier for the config. To set + the config attribute: + ▸ provide the argument config on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the config. + + To set the cluster attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + The name of the region of the config. + + To set the region attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --region 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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations configs describe + diff --git a/gcloud/alpha/workstations/configs/help b/gcloud/alpha/workstations/configs/help new file mode 100644 index 000000000..4320bface --- /dev/null +++ b/gcloud/alpha/workstations/configs/help @@ -0,0 +1,38 @@ +NAME + gcloud alpha workstations configs - manage Cloud Workstations configuration + resources + +SYNOPSIS + gcloud alpha workstations configs COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Cloud Workstations configuration resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create a workstation configuration. + + delete + (ALPHA) Delete a workstation configuration. + + describe + (ALPHA) Describe a config. + + list + (ALPHA) List workstation configurations. + +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 workstations configs + diff --git a/gcloud/alpha/workstations/configs/list b/gcloud/alpha/workstations/configs/list new file mode 100644 index 000000000..c5f090eb9 --- /dev/null +++ b/gcloud/alpha/workstations/configs/list @@ -0,0 +1,91 @@ +NAME + gcloud alpha workstations configs list - list workstation configurations + +SYNOPSIS + gcloud alpha workstations configs list + (--cluster=CLUSTER : --region=REGION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List all workstation configurations under the specified cluster. + +EXAMPLES + To list workstation configurations, run: + + $ gcloud alpha workstations configs list + +REQUIRED FLAGS + Cluster resource - The cluster of the configurations to display. 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 --cluster 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. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument --cluster on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument --cluster on the command line with a fully + specified name; + ▸ provide the argument --region 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. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations configs list + diff --git a/gcloud/alpha/workstations/create b/gcloud/alpha/workstations/create new file mode 100644 index 000000000..9be0c8e97 --- /dev/null +++ b/gcloud/alpha/workstations/create @@ -0,0 +1,85 @@ +NAME + gcloud alpha workstations create - create a workstation + +SYNOPSIS + gcloud alpha workstations create + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a workstation. + +EXAMPLES + To create a workstation, run: + + $ gcloud alpha workstations create WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - Arguments and flags that specify the workstation to + create. 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the workstation. + + To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The name of the config containing the workstation. + + To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The name of the region of the workstation. + + To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations create + diff --git a/gcloud/alpha/workstations/delete b/gcloud/alpha/workstations/delete new file mode 100644 index 000000000..1c47c135e --- /dev/null +++ b/gcloud/alpha/workstations/delete @@ -0,0 +1,85 @@ +NAME + gcloud alpha workstations delete - delete a workstation + +SYNOPSIS + gcloud alpha workstations delete + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a workstation. + +EXAMPLES + To delete a workstation, run: + + $ gcloud alpha workstations delete WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The name of the workstation 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the workstation. + + To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The name of the config containing the workstation. + + To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The name of the region of the workstation. + + To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations delete + diff --git a/gcloud/alpha/workstations/describe b/gcloud/alpha/workstations/describe new file mode 100644 index 000000000..b288cd3ba --- /dev/null +++ b/gcloud/alpha/workstations/describe @@ -0,0 +1,80 @@ +NAME + gcloud alpha workstations describe - describe a workstation + +SYNOPSIS + gcloud alpha workstations describe + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describe a workstation. + +EXAMPLES + To describe a workstation, run: + + $ gcloud alpha workstations describe WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The name of the workstation to display. 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the workstation. + + To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The name of the config containing the workstation. + + To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The name of the region of the workstation. + + To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region 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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +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 workstations describe + diff --git a/gcloud/alpha/workstations/help b/gcloud/alpha/workstations/help index b381b63db..a9bff6e2d 100644 --- a/gcloud/alpha/workstations/help +++ b/gcloud/alpha/workstations/help @@ -18,16 +18,34 @@ GROUPS clusters (ALPHA) Manage Cloud Workstations cluster resources. + configs + (ALPHA) Manage Cloud Workstations configuration resources. + COMMANDS COMMAND is one of the following: + create + (ALPHA) Create a workstation. + + delete + (ALPHA) Delete a workstation. + + describe + (ALPHA) Describe a workstation. + list (ALPHA) List workstations. + start + (ALPHA) Start a workstation. + start-tcp-tunnel - (ALPHA) Starts a tunnel through which a local process can forward TCP + (ALPHA) Start a tunnel through which a local process can forward TCP traffic to the workstation. + stop + (ALPHA) Stop a workstation. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/workstations/list b/gcloud/alpha/workstations/list index b1252a766..96a2950ca 100644 --- a/gcloud/alpha/workstations/list +++ b/gcloud/alpha/workstations/list @@ -8,7 +8,7 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List all workstations under the specified config. + (ALPHA) List all workstations under the specified configuration. EXAMPLES To list workstations, run: @@ -16,10 +16,10 @@ EXAMPLES $ gcloud alpha workstations list REQUIRED FLAGS - Config resource - The config of the workstations to display. 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: + Config resource - The configuration of the workstations to display. 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 --config on the command line with a fully specified name; ◆ provide the argument --project on the command line; diff --git a/gcloud/alpha/workstations/start b/gcloud/alpha/workstations/start new file mode 100644 index 000000000..c651945b3 --- /dev/null +++ b/gcloud/alpha/workstations/start @@ -0,0 +1,75 @@ +NAME + gcloud alpha workstations start - start a workstation + +SYNOPSIS + gcloud alpha workstations start + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Start a workstation. + +EXAMPLES + To start a workstation, run + + $ gcloud alpha workstations start WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The group of arguments defining a workstation 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The cluster for the workstation. To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The config for the workstation. To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The location for the workstation. To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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. + +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 workstations start + diff --git a/gcloud/alpha/workstations/start-tcp-tunnel b/gcloud/alpha/workstations/start-tcp-tunnel index 228807618..7c6504833 100644 --- a/gcloud/alpha/workstations/start-tcp-tunnel +++ b/gcloud/alpha/workstations/start-tcp-tunnel @@ -1,6 +1,6 @@ NAME - gcloud alpha workstations start-tcp-tunnel - starts a tunnel through which - a local process can forward TCP traffic to the workstation + gcloud alpha workstations start-tcp-tunnel - start a tunnel through which a + local process can forward TCP traffic to the workstation SYNOPSIS gcloud alpha workstations start-tcp-tunnel @@ -10,7 +10,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Starts a tunnel through which a local process can forward TCP + (ALPHA) Start a tunnel through which a local process can forward TCP traffic to the workstation. EXAMPLES @@ -21,8 +21,8 @@ EXAMPLES my-workstation 22 POSITIONAL ARGUMENTS - Workstation resource - The workstation to which traffic should be sent. - The arguments in this group can be used to specify the attributes of this + Workstation resource - The group of arguments defining a workstation 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 workstation on the command line with a fully @@ -53,7 +53,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --config on the command line. --region=REGION - The region for the workstation. To set the region attribute: + The location for the workstation. To set the region attribute: ▸ provide the argument workstation on the command line with a fully specified name; ▸ provide the argument --region on the command line. diff --git a/gcloud/alpha/workstations/stop b/gcloud/alpha/workstations/stop new file mode 100644 index 000000000..669b2b5fe --- /dev/null +++ b/gcloud/alpha/workstations/stop @@ -0,0 +1,75 @@ +NAME + gcloud alpha workstations stop - stop a workstation + +SYNOPSIS + gcloud alpha workstations stop + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Stop a workstation. + +EXAMPLES + To stop a workstation, run + + $ gcloud alpha workstations stop WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The group of arguments defining a workstation 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The cluster for the workstation. To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The config for the workstation. To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The location for the workstation. To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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. + +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 workstations stop + diff --git a/gcloud/anthos/config/controller/create b/gcloud/anthos/config/controller/create index 9099f47f7..efd5d10d9 100644 --- a/gcloud/anthos/config/controller/create +++ b/gcloud/anthos/config/controller/create @@ -5,8 +5,8 @@ NAME SYNOPSIS gcloud anthos config controller create (NAME : --location=LOCATION) [--async] [--cluster-ipv4-cidr-block=CLUSTER_IPV4_CIDR_BLOCK] - [--cluster-named-range=CLUSTER_NAMED_RANGE] [--man-block=MAN_BLOCK] - [--man-blocks=[BLOCK,...]] + [--cluster-named-range=CLUSTER_NAMED_RANGE] [--full-management] + [--man-block=MAN_BLOCK] [--man-blocks=[BLOCK,...]] [--master-ipv4-cidr-block=MASTER_IPV4_CIDR_BLOCK] [--network=NETWORK] [--services-ipv4-cidr-block=SERVICES_IPV4_CIDR_BLOCK] [--services-named-range=SERVICES_NAMED_RANGE] [--subnet=SUBNET] @@ -67,6 +67,9 @@ FLAGS use for pod IP addresses. Alternatively, --cluster_cidr_block can be used to automatically create a GKE-managed one. + --full-management + Enable full cluster management type. This is a preview feature. + --man-block=MAN_BLOCK (DEPRECATED) Master Authorized Network. Allows access to the Kubernetes control plane from this block. Defaults to 0.0.0.0/0 if flag is not diff --git a/gcloud/app/create b/gcloud/app/create index 3a4768a73..d4c319fd5 100644 --- a/gcloud/app/create +++ b/gcloud/app/create @@ -3,7 +3,8 @@ NAME Cloud Project SYNOPSIS - gcloud app create [--region=REGION] [GCLOUD_WIDE_FLAG ...] + gcloud app create [--region=REGION] [--service-account=SERVICE_ACCOUNT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create an App Engine app within the current Google Cloud Project. @@ -17,11 +18,25 @@ EXAMPLES $ gcloud app create --region=us-central + To create an app that with a user-managed service account, run: + + $ gcloud app create --service-account=SERVICE_ACCOUNT + FLAGS --region=REGION The region to create the app within. Use gcloud app regions list to list available regions. If not provided, select region interactively. + --service-account=SERVICE_ACCOUNT + The app-level default service account to create the app with. Note that + you can specify a distinct service account for each App Engine version + with gcloud app deploy --service-account. However if you do not specify + a version-level service account, this default will be used. If this + parameter is not provided for app creation, the app-level default will + be set to be the out-of-box App Engine Default Service Account, + https://cloud.google.com/appengine/docs/standard/python3/service-account + outlines the limitation of that service account. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/app/update b/gcloud/app/update index a4ff186d3..f3c0ca3f4 100644 --- a/gcloud/app/update +++ b/gcloud/app/update @@ -2,7 +2,8 @@ NAME gcloud app update - updates an App Engine application SYNOPSIS - gcloud app update [--[no-]split-health-checks] [GCLOUD_WIDE_FLAG ...] + gcloud app update [--service-account=SERVICE_ACCOUNT] + [--[no-]split-health-checks] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command is used to update settings on an app engine application. @@ -12,7 +13,14 @@ EXAMPLES $ gcloud app update --split-health-checks + To update the app-level service account on an application: + + $ gcloud app update --service-account=SERVICE_ACCOUNT + FLAGS + --service-account=SERVICE_ACCOUNT + The app-level default service account to update the app with. + --[no-]split-health-checks Enables/disables split health checks by default on new deployments. Use --split-health-checks to enable and --no-split-health-checks to diff --git a/gcloud/asset/help b/gcloud/asset/help index a3b79dc23..bde57d7a8 100644 --- a/gcloud/asset/help +++ b/gcloud/asset/help @@ -50,6 +50,9 @@ COMMANDS list List the Cloud assets. + query + Query the Cloud assets. + search-all-iam-policies Searches all IAM policies within the specified accessible scope, such as a project, folder or organization. diff --git a/gcloud/asset/query b/gcloud/asset/query new file mode 100644 index 000000000..167b5ac38 --- /dev/null +++ b/gcloud/asset/query @@ -0,0 +1,160 @@ +NAME + gcloud asset query - query the Cloud assets + +SYNOPSIS + gcloud asset query + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) + (--job-reference=JOB_REFERENCE | --statement=STATEMENT) + [--page-size=PAGE_SIZE] [--page-token=PAGE_TOKEN] [--timeout=TIMEOUT] + [--snapshot-time=SNAPSHOT_TIME + | [--start-time=START_TIME : --end-time=END_TIME]] + [--write-disposition=WRITE_DISPOSITION [--bigquery-table=BIGQUERY_TABLE + : --bigquery-dataset=BIGQUERY_DATASET]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Issue an analytical query on Cloud assets using a BigQuery Standard SQL + compatible statement. + +EXAMPLES + To count the number of compute instances, run: + + $ gcloud asset query --project='test-project' \ + --statement='SELECT * FROM compute_googleapis_com_Instance' + + To see the query result of the previous job, pass the job-reference from + the previous response: + + $ gcloud asset query --project='test-project' \ + --job-reference= + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + The ID of the folder which is the root asset. + + --organization=ORGANIZATION_ID + The ID of the organization which is the root asset. + + --project=PROJECT_ID + The project which is the root asset. + + The Google Cloud project ID to use for this invocation. If omitted, + then the current project is assumed; the current project can be + listed using gcloud config list --format='text(core.project)' and can + be set using gcloud config set project PROJECTID. + + --project and its fallback core/project property play two roles in + the invocation. It specifies the project of the resource to operate + on. It also specifies the project for API enablement check, quota, + and billing. To specify a different project for quota and billing, + use --billing-project or billing/quota_project property. + + The query or job reference of the query request. + + Exactly one of these must be specified: + + --job-reference=JOB_REFERENCE + Reference to the query job, which is from the previous call. + + --statement=STATEMENT + A BigQuery Standard SQL compatible statement. If the query execution + finishes within timeout and there is no pagination, the full query + results will be returned. Otherwise, pass job_reference from previous + call as --job-referrence to obtain the full results. + +OPTIONAL FLAGS + --page-size=PAGE_SIZE + The maximum number of rows to return in the results. One page is also + limited to 10 MB. + + --page-token=PAGE_TOKEN + A page token received from previous call. + + --timeout=TIMEOUT + Maximum amount of time that the client will wait for the query to + complete. + + Specifies what time period or point in time to query asset metadata at. + + At most one of these can be specified: + + --snapshot-time=SNAPSHOT_TIME + Timestamp to take a snapshot on assets. This can only be a current or + past time. If not specified, the current time will be used. Due to + delays in resource data collection and indexing, there is a volatile + window during which running the same query at different times may + return different results. See $ gcloud topic datetimes for + information on time formats. + + Specifies what time period or point in time to query asset metadata at. + + --start-time=START_TIME + Start time of the time window (inclusive) for the asset history. + Must be after the current time minus 35 days. See $ gcloud topic + datetimes for information on time formats. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --end-time=END_TIME + End time of the time window (exclusive) for the asset history. + Defaults to current time if not specified. See $ gcloud topic + datetimes for information on time formats. + + The BigQuery destination for query system. + + --write-disposition=WRITE_DISPOSITION + Specifies the action that occurs if the destination table or + partition already exists. WRITE_DISPOSITION must be one of: + + write-append + If the table or partition already exists, BigQuery appends the + data to the table or the latest partition. + write-empty + If the table already exists and contains data, an error is + returned. + write-truncate + If the table or partition already exists, BigQuery overwrites the + entire table or all the partition's data. + + Table resource - The bigquery-table for the export. 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 --bigquery-table on the command line with a + fully specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + + --bigquery-table=BIGQUERY_TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▫ provide the argument --bigquery-table on the command line. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --bigquery-dataset=BIGQUERY_DATASET + The id of the BigQuery dataset. To set the bigquery-dataset + attribute: + ▫ provide the argument --bigquery-table on the command line with + a fully specified name; + ▫ provide the argument --bigquery-dataset 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 + These variants are also available: + + $ gcloud alpha asset query + + $ gcloud beta asset query + diff --git a/gcloud/assured/workloads/create b/gcloud/assured/workloads/create index dbc102ff4..6d0a26897 100644 --- a/gcloud/assured/workloads/create +++ b/gcloud/assured/workloads/create @@ -83,8 +83,8 @@ OPTIONAL FLAGS --partner=PARTNER The partner choice when creating a workload managed by local trusted - partners. PARTNER must be (currently only one value is supported): - LOCAL_CONTROLS_BY_S3NS. + partners. PARTNER must be one of: LOCAL_CONTROLS_BY_S3NS, + SOVEREIGN_CONTROLS_BY_T_SYSTEMS. --provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT The parent of the provisioned projects, for example, diff --git a/gcloud/beta/ai/custom-jobs/create b/gcloud/beta/ai/custom-jobs/create index 9a70ffcaf..bf24b193e 100644 --- a/gcloud/beta/ai/custom-jobs/create +++ b/gcloud/beta/ai/custom-jobs/create @@ -85,6 +85,9 @@ REQUIRED FLAGS field in WorkerPoolSpec API message. executor-image-uri The URI of a container image that will run the provided package. + output-image-uri + The URI of a custom container image to be built for autopackaged + custom jobs. python-module The Python module name to run within the provided package. local-package-path @@ -136,7 +139,15 @@ REQUIRED FLAGS Example: --worker-pool-spec=machine-type=e2-standard-4,executor-image-uri=us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-4:latest,python-module=trainer.task - local-package-path, executor-image-uri, python-module|script + output-image-uri + Specify this field to push the output custom container training + image to a specific path in Container Registry or Artifact + Registry for an autopackaged custom job. + + Example: + --worker-pool-spec=machine-type=e2-standard-4,executor-image-uri=us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-4:latest,output-image-uri='eu.gcr.io/projectName/imageName',python-module=trainer.task + + local-package-path, executor-image-uri, output-image-uri, python-module|script Specify these fields, optionally with requirements, extra-packages, or extra-dirs, to train using a pre-built container and Python code from a local path. In this case, the diff --git a/gcloud/beta/ai/models/copy b/gcloud/beta/ai/models/copy new file mode 100644 index 000000000..cc96fe133 --- /dev/null +++ b/gcloud/beta/ai/models/copy @@ -0,0 +1,77 @@ +NAME + gcloud beta ai models copy - copy a model + +SYNOPSIS + gcloud beta ai models copy --source-model=SOURCE_MODEL + [--kms-key-name=KMS_KEY_NAME] [--region=REGION] + [--destination-model-id=DESTINATION_MODEL_ID + | --destination-parent-model=DESTINATION_PARENT_MODEL] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To copy a model 123 of project example from region us-central1 to region + europe-west4, run: + + $ gcloud beta ai models copy \ + --source-model=projects/example/locations/us-central1/models/\ + 123 --region=projects/example/locations/europe-west4 + +REQUIRED FLAGS + --source-model=SOURCE_MODEL + The resource name of the Model to copy. That Model must be in the same + Project. Format: + projects/{project}/locations/{location}/models/{model}. + +OPTIONAL FLAGS + --kms-key-name=KMS_KEY_NAME + The Cloud KMS resource identifier of the customer managed encryption + key used to protect the resource. Has the form: + projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. + The key needs to be in the same region as where the compute resource is + created. + + Region resource - Cloud region to copy the model into. 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 ai/region with a fully specified name; + ◆ choose one from the prompted list of available regions with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --region=REGION + ID of the region or fully qualified identifier for the region. To set + the region attribute: + ▸ provide the argument --region on the command line; + ▸ set the property ai/region; + ▸ choose one from the prompted list of available regions. + + At most one of these can be specified: + + --destination-model-id=DESTINATION_MODEL_ID + Copy source_model into a new Model with this ID. The ID will become + the final component of the model resource name. This value may be up + to 63 characters, and valid characters are [a-z0-9-]. The first + character cannot be a number or hyphen. + + --destination-parent-model=DESTINATION_PARENT_MODEL + Specify this field to copy source_model into this existing Model as a + new version. Format: + projects/{project}/locations/{location}/models/{model}. + +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. This + variant is also available: + + $ gcloud alpha ai models copy + diff --git a/gcloud/beta/ai/models/help b/gcloud/beta/ai/models/help index b54cfd059..902b2a82e 100644 --- a/gcloud/beta/ai/models/help +++ b/gcloud/beta/ai/models/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + copy + (BETA) Copy a model. + delete (BETA) Delete an existing Vertex AI model. diff --git a/gcloud/beta/ai/models/upload b/gcloud/beta/ai/models/upload index b7a31d8cb..555250a8b 100644 --- a/gcloud/beta/ai/models/upload +++ b/gcloud/beta/ai/models/upload @@ -12,14 +12,20 @@ SYNOPSIS [--description=DESCRIPTION] [--explanation-metadata-file=EXPLANATION_METADATA_FILE] [--explanation-method=EXPLANATION_METHOD] + [--explanation-modality=EXPLANATION_MODALITY; + default="MODALITY_UNSPECIFIED"] + [--explanation-nearest-neighbor-search-config-file=EXPLANATION_NEAREST_NEIGHBOR_SEARCH_CONFIG_FILE] + [--explanation-neighbor-count=EXPLANATION_NEIGHBOR_COUNT] [--explanation-path-count=EXPLANATION_PATH_COUNT] + [--explanation-query=EXPLANATION_QUERY; default="PRECISE"] [--explanation-step-count=EXPLANATION_STEP_COUNT] [--labels=[KEY=VALUE,...]] [--model-id=MODEL_ID] [--parent-model=PARENT_MODEL] [--region=REGION] [--smooth-grad-noise-sigma=SMOOTH_GRAD_NOISE_SIGMA] [--smooth-grad-noise-sigma-by-feature=[KEY=VALUE,...]] [--smooth-grad-noisy-sample-count=SMOOTH_GRAD_NOISY_SAMPLE_COUNT] - [--version-aliases=[VERSION_ALIASES,...]] [GCLOUD_WIDE_FLAG ...] + [--uris=[URIS,...]] [--version-aliases=[VERSION_ALIASES,...]] + [--version-description=VERSION_DESCRIPTION] [GCLOUD_WIDE_FLAG ...] EXAMPLES To upload a model under project example in region us-central1, run: @@ -76,10 +82,51 @@ OPTIONAL FLAGS Method used for explanation. Accepted values are integrated-gradients, xrai and sampled-shapley. + --explanation-modality=EXPLANATION_MODALITY; default="MODALITY_UNSPECIFIED" + Preset option specifying the modality of the uploaded model, which + automatically configures the distance measurement and feature + normalization for the underlying example index and queries. Accepted + values are IMAGE, TEXT and TABULAR. Should be used only when the + explanation method is examples. + + --explanation-nearest-neighbor-search-config-file=EXPLANATION_NEAREST_NEIGHBOR_SEARCH_CONFIG_FILE + Path to a local JSON file that contains the configuration for the + generated index, the semantics are the same as metadata and should + match NearestNeighborSearchConfig. If you specify this parameter, no + need to use explanation-modality and explanation-query for preset. + Should be used only when the explanation method is examples. + + An example of a JSON config file: + + { + "contentsDeltaUri": "", + "config": { + "dimensions": 50, + "approximateNeighborsCount": 10, + "distanceMeasureType": "SQUARED_L2_DISTANCE", + "featureNormType": "NONE", + "algorithmConfig": { + "treeAhConfig": { + "leafNodeEmbeddingCount": 1000, + "leafNodesToSearchPercent": 100 + } + } + } + } + + --explanation-neighbor-count=EXPLANATION_NEIGHBOR_COUNT + The number of items to return when querying for examples. Should be + used only when the explanation method is examples. + --explanation-path-count=EXPLANATION_PATH_COUNT Number of feature permutations to consider when approximating the Shapley values for explanation. + --explanation-query=EXPLANATION_QUERY; default="PRECISE" + Preset option controlling parameters for query speed-precision + trade-off. Accepted values are PRECISE and FAST. Should be used only + when the explanation method is examples. + --explanation-step-count=EXPLANATION_STEP_COUNT Number of steps to approximate the path integral for explanation. @@ -133,11 +180,18 @@ OPTIONAL FLAGS Number of gradient samples used for approximation at explanation. Only applicable to explanation method integrated-gradients or xrai. + --uris=[URIS,...] + Cloud Storage bucket paths where training data is stored. Should be + used only when the explanation method is examples. + --version-aliases=[VERSION_ALIASES,...] Aliases used to reference a model version instead of auto-generated version ID. The aliases mentioned in the flag will replace the aliases set in the model. + --version-description=VERSION_DESCRIPTION + Description of the model version. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/alloydb/backups/create b/gcloud/beta/alloydb/backups/create index 27835a5b4..f55719692 100644 --- a/gcloud/beta/alloydb/backups/create +++ b/gcloud/beta/alloydb/backups/create @@ -77,8 +77,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb backups create $ gcloud alpha alloydb backups create diff --git a/gcloud/beta/alloydb/backups/delete b/gcloud/beta/alloydb/backups/delete index e8734e8a8..76c649132 100644 --- a/gcloud/beta/alloydb/backups/delete +++ b/gcloud/beta/alloydb/backups/delete @@ -37,8 +37,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb backups delete $ gcloud alpha alloydb backups delete diff --git a/gcloud/beta/alloydb/backups/describe b/gcloud/beta/alloydb/backups/describe index f7f0864a6..38fe6f83a 100644 --- a/gcloud/beta/alloydb/backups/describe +++ b/gcloud/beta/alloydb/backups/describe @@ -32,8 +32,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb backups describe $ gcloud alpha alloydb backups describe diff --git a/gcloud/beta/alloydb/backups/help b/gcloud/beta/alloydb/backups/help index 9fa6ab76f..7e15cb960 100644 --- a/gcloud/beta/alloydb/backups/help +++ b/gcloud/beta/alloydb/backups/help @@ -29,8 +29,10 @@ COMMANDS (BETA) Lists AlloyDB backups in a given project. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb backups $ gcloud alpha alloydb backups diff --git a/gcloud/beta/alloydb/backups/list b/gcloud/beta/alloydb/backups/list index 97eb5af4e..a07a64865 100644 --- a/gcloud/beta/alloydb/backups/list +++ b/gcloud/beta/alloydb/backups/list @@ -68,8 +68,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb backups list $ gcloud alpha alloydb backups list diff --git a/gcloud/beta/alloydb/clusters/create b/gcloud/beta/alloydb/clusters/create index bb7db0111..0b02221e9 100644 --- a/gcloud/beta/alloydb/clusters/create +++ b/gcloud/beta/alloydb/clusters/create @@ -1,6 +1,6 @@ NAME - gcloud beta alloydb clusters create - creates a new AlloyDB cluster within - a given project + gcloud beta alloydb clusters create - create a new AlloyDB cluster within a + given project SYNOPSIS gcloud beta alloydb clusters create CLUSTER --password=PASSWORD @@ -11,13 +11,12 @@ SYNOPSIS : --automated-backup-window=TIMEOUT_PERIOD [--automated-backup-encryption-key=AUTOMATED_BACKUP_ENCRYPTION_KEY : --automated-backup-encryption-key-keyring=AUTOMATED_BACKUP_ENCRYPTION_KEY_KEYRING --automated-backup-encryption-key-location=AUTOMATED_BACKUP_ENCRYPTION_KEY_LOCATION --automated-backup-encryption-key-project=AUTOMATED_BACKUP_ENCRYPTION_KEY_PROJECT] --automated-backup-retention-count=RETENTION_COUNT | --automated-backup-retention-period=RETENTION_PERIOD]] - [--disable-pitr | --pitr-log-retention-window=RETENTION_PERIOD] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Creates a new AlloyDB cluster within a given project. + (BETA) Create a new AlloyDB cluster within a given project. EXAMPLES To create a new cluster, run: @@ -134,17 +133,6 @@ OPTIONAL FLAGS Retention period of the backup relative to creation time. See $ gcloud topic datetimes for information on duration formats. - PITR configuration. - - At most one of these can be specified: - - --disable-pitr - Disables PITR on the cluster. - - --pitr-log-retention-window=RETENTION_PERIOD - Retention window of the log files saved to support PITR. See $ gcloud - topic datetimes for information on absolute duration formats. - Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the cluster. The 'AlloyDB Service Agent' service account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. @@ -187,8 +175,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters create $ gcloud alpha alloydb clusters create diff --git a/gcloud/beta/alloydb/clusters/create-secondary b/gcloud/beta/alloydb/clusters/create-secondary new file mode 100644 index 000000000..e4d5518a8 --- /dev/null +++ b/gcloud/beta/alloydb/clusters/create-secondary @@ -0,0 +1,86 @@ +NAME + gcloud beta alloydb clusters create-secondary - create a new AlloyDB + SECONDARY cluster within a given project + +SYNOPSIS + gcloud beta alloydb clusters create-secondary CLUSTER + --primary-cluster=PRIMARY_CLUSTER --region=REGION [--async] + [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING + --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a new AlloyDB SECONDARY cluster within a given project. + +EXAMPLES + To create a new cluster, run: + + $ gcloud beta alloydb clusters create-secondary my-cluster \ + --region=us-central1 \ + --primary-cluster=projects/12345/locations/us-central1/\ + clusters/cluster1 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --primary-cluster=PRIMARY_CLUSTER + AlloyDB primary cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Key resource - The Cloud KMS (Key Management Service) cryptokey that will + be used to protect the cluster. The 'AlloyDB Service Agent' service + account must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. + The arguments in this group can be used to specify the attributes of this + resource. + + --kms-key=KMS_KEY + ID of the key or fully qualified identifier for the key. To set the + kms-key attribute: + ▸ provide the argument --kms-key on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kms-keyring=KMS_KEYRING + The KMS keyring of the key. To set the kms-keyring attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-keyring on the command line. + + --kms-location=KMS_LOCATION + The Cloud location for the key. To set the kms-location attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-location on the command line. + + --kms-project=KMS_PROJECT + The Cloud project for the key. To set the kms-project attribute: + ▸ provide the argument --kms-key on the command line with a fully + specified name; + ▸ provide the argument --kms-project on the command line; + ▸ set the property core/project. + +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. This + variant is also available: + + $ gcloud alpha alloydb clusters create-secondary + diff --git a/gcloud/beta/alloydb/clusters/delete b/gcloud/beta/alloydb/clusters/delete index f1ab48dba..22a86cc5a 100644 --- a/gcloud/beta/alloydb/clusters/delete +++ b/gcloud/beta/alloydb/clusters/delete @@ -1,5 +1,5 @@ NAME - gcloud beta alloydb clusters delete - deletes an AlloyDB cluster in a given + gcloud beta alloydb clusters delete - delete an AlloyDB cluster in a given region SYNOPSIS @@ -7,7 +7,7 @@ SYNOPSIS [--force] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Deletes an AlloyDB cluster in a given region. + (BETA) Delete an AlloyDB cluster in a given region. EXAMPLES To delete a cluster, run: @@ -46,8 +46,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters delete $ gcloud alpha alloydb clusters delete diff --git a/gcloud/beta/alloydb/clusters/describe b/gcloud/beta/alloydb/clusters/describe index 26cad0a5a..2fab17168 100644 --- a/gcloud/beta/alloydb/clusters/describe +++ b/gcloud/beta/alloydb/clusters/describe @@ -1,5 +1,5 @@ NAME - gcloud beta alloydb clusters describe - describes an AlloyDB cluster in a + gcloud beta alloydb clusters describe - describe an AlloyDB cluster in a given project and region SYNOPSIS @@ -7,7 +7,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Describes an AlloyDB cluster in a given project and region. + (BETA) Describe an AlloyDB cluster in a given project and region. EXAMPLES To describe a cluster, run: @@ -33,8 +33,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters describe $ gcloud alpha alloydb clusters describe diff --git a/gcloud/beta/alloydb/clusters/help b/gcloud/beta/alloydb/clusters/help index bd18d378e..ec25d1919 100644 --- a/gcloud/beta/alloydb/clusters/help +++ b/gcloud/beta/alloydb/clusters/help @@ -18,26 +18,35 @@ COMMANDS COMMAND is one of the following: create - (BETA) Creates a new AlloyDB cluster within a given project. + (BETA) Create a new AlloyDB cluster within a given project. + + create-secondary + (BETA) Create a new AlloyDB SECONDARY cluster within a given project. delete - (BETA) Deletes an AlloyDB cluster in a given region. + (BETA) Delete an AlloyDB cluster in a given region. describe - (BETA) Describes an AlloyDB cluster in a given project and region. + (BETA) Describe an AlloyDB cluster in a given project and region. list - (BETA) Lists AlloyDB clusters in a given project and region. + (BETA) List AlloyDB clusters in a given project and region. + + promote + (BETA) Promote an AlloyDB SECONDARY cluster in a given project and + region. restore - (BETA) Restores an AlloyDB cluster from a given backup. + (BETA) Restore an AlloyDB cluster from a given backup. update - (BETA) Updates an AlloyDB cluster within a given project and region. + (BETA) Update an AlloyDB cluster within a given project and region. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters $ gcloud alpha alloydb clusters diff --git a/gcloud/beta/alloydb/clusters/list b/gcloud/beta/alloydb/clusters/list index 2444a9f9e..25a26ce1a 100644 --- a/gcloud/beta/alloydb/clusters/list +++ b/gcloud/beta/alloydb/clusters/list @@ -1,5 +1,5 @@ NAME - gcloud beta alloydb clusters list - lists AlloyDB clusters in a given + gcloud beta alloydb clusters list - list AlloyDB clusters in a given project and region SYNOPSIS @@ -8,8 +8,8 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Lists AlloyDB clusters in a given project in the alphabetical order - of the cluster name. + (BETA) List AlloyDB clusters in a given project in alphabetical order based + on the cluster name. EXAMPLES To list clusters, run: @@ -63,8 +63,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters list $ gcloud alpha alloydb clusters list diff --git a/gcloud/beta/alloydb/clusters/promote b/gcloud/beta/alloydb/clusters/promote new file mode 100644 index 000000000..71ac27a52 --- /dev/null +++ b/gcloud/beta/alloydb/clusters/promote @@ -0,0 +1,45 @@ +NAME + gcloud beta alloydb clusters promote - promote an AlloyDB SECONDARY cluster + in a given project and region + +SYNOPSIS + gcloud beta alloydb clusters promote CLUSTER --region=REGION [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Promote an AlloyDB SECONDARY cluster in a given project and region. + +EXAMPLES + To promote a cluster, run: + + $ gcloud beta alloydb clusters promote my-cluster \ + --region=us-central1 + +POSITIONAL ARGUMENTS + CLUSTER + AlloyDB cluster ID + +REQUIRED FLAGS + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha alloydb clusters promote + diff --git a/gcloud/beta/alloydb/clusters/restore b/gcloud/beta/alloydb/clusters/restore index 95391959b..45ceeb288 100644 --- a/gcloud/beta/alloydb/clusters/restore +++ b/gcloud/beta/alloydb/clusters/restore @@ -1,5 +1,5 @@ NAME - gcloud beta alloydb clusters restore - restores an AlloyDB cluster from a + gcloud beta alloydb clusters restore - restore an AlloyDB cluster from a given backup SYNOPSIS @@ -10,7 +10,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Restores an AlloyDB cluster from a given backup. + (BETA) Restore an AlloyDB cluster from a given backup. EXAMPLES To restore a cluster from a backup, run: @@ -90,8 +90,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters restore $ gcloud alpha alloydb clusters restore diff --git a/gcloud/beta/alloydb/clusters/update b/gcloud/beta/alloydb/clusters/update index fa34c0fff..6058146b9 100644 --- a/gcloud/beta/alloydb/clusters/update +++ b/gcloud/beta/alloydb/clusters/update @@ -1,5 +1,5 @@ NAME - gcloud beta alloydb clusters update - updates an AlloyDB cluster within a + gcloud beta alloydb clusters update - update an AlloyDB cluster within a given project and region SYNOPSIS @@ -13,7 +13,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Updates an AlloyDB cluster within a given project and region. + (BETA) Update an AlloyDB cluster within a given project and region. EXAMPLES To update a cluster, run: @@ -135,8 +135,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb clusters update $ gcloud alpha alloydb clusters update diff --git a/gcloud/beta/alloydb/help b/gcloud/beta/alloydb/help index 2abb406a7..2e6923769 100644 --- a/gcloud/beta/alloydb/help +++ b/gcloud/beta/alloydb/help @@ -11,7 +11,8 @@ DESCRIPTION AlloyDB is a fully-managed database service that makes it easy to set up, maintain, manage, and administer your Alloydb databases in the cloud. - More information on AlloyDB can be found here at go/alloydb + More information on AlloyDB can be found at + https://cloud.google.com/alloydb GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -34,8 +35,10 @@ GROUPS (BETA) Provide commands for managing AlloyDB operations. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb $ gcloud alpha alloydb diff --git a/gcloud/beta/alloydb/instances/create b/gcloud/beta/alloydb/instances/create index 9330afcde..f76566835 100644 --- a/gcloud/beta/alloydb/instances/create +++ b/gcloud/beta/alloydb/instances/create @@ -89,8 +89,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances create $ gcloud alpha alloydb instances create diff --git a/gcloud/beta/alloydb/instances/create-secondary b/gcloud/beta/alloydb/instances/create-secondary new file mode 100644 index 000000000..853989f51 --- /dev/null +++ b/gcloud/beta/alloydb/instances/create-secondary @@ -0,0 +1,48 @@ +NAME + gcloud beta alloydb instances create-secondary - creates a new AlloyDB + SECONDARY instance within a given cluster + +SYNOPSIS + gcloud beta alloydb instances create-secondary INSTANCE --cluster=CLUSTER + --region=REGION [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Creates a new AlloyDB SECONDARY instance within a given cluster. + +EXAMPLES + To create a new secondary instance, run: + + $ gcloud beta alloydb instances create-secondary my-instance \ + --cluster=my-cluster --region=us-central1 + +POSITIONAL ARGUMENTS + INSTANCE + AlloyDB instance ID + +REQUIRED FLAGS + --cluster=CLUSTER + AlloyDB cluster ID + + --region=REGION + Regional location (e.g. asia-east1, us-east1). See the full list of + regions at https://cloud.google.com/sql/docs/instance-locations. + +OPTIONAL 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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha alloydb instances create-secondary + diff --git a/gcloud/beta/alloydb/instances/delete b/gcloud/beta/alloydb/instances/delete index 0f313e873..f91fc2621 100644 --- a/gcloud/beta/alloydb/instances/delete +++ b/gcloud/beta/alloydb/instances/delete @@ -41,8 +41,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances delete $ gcloud alpha alloydb instances delete diff --git a/gcloud/beta/alloydb/instances/describe b/gcloud/beta/alloydb/instances/describe index 4febb2ec9..3d14ed978 100644 --- a/gcloud/beta/alloydb/instances/describe +++ b/gcloud/beta/alloydb/instances/describe @@ -40,8 +40,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances describe $ gcloud alpha alloydb instances describe diff --git a/gcloud/beta/alloydb/instances/failover b/gcloud/beta/alloydb/instances/failover index 54e816d82..02a8ffd8d 100644 --- a/gcloud/beta/alloydb/instances/failover +++ b/gcloud/beta/alloydb/instances/failover @@ -41,8 +41,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances failover $ gcloud alpha alloydb instances failover diff --git a/gcloud/beta/alloydb/instances/help b/gcloud/beta/alloydb/instances/help index d7f5ce672..bf7cedf56 100644 --- a/gcloud/beta/alloydb/instances/help +++ b/gcloud/beta/alloydb/instances/help @@ -20,6 +20,9 @@ COMMANDS create (BETA) Creates a new AlloyDB instance within a given cluster. + create-secondary + (BETA) Creates a new AlloyDB SECONDARY instance within a given cluster. + delete (BETA) Deletes an AlloyDB instance within a given cluster. @@ -39,8 +42,10 @@ COMMANDS (BETA) Updates an AlloyDB instance within a given cluster. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances $ gcloud alpha alloydb instances diff --git a/gcloud/beta/alloydb/instances/list b/gcloud/beta/alloydb/instances/list index 200c81c69..adf716849 100644 --- a/gcloud/beta/alloydb/instances/list +++ b/gcloud/beta/alloydb/instances/list @@ -75,8 +75,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances list $ gcloud alpha alloydb instances list diff --git a/gcloud/beta/alloydb/instances/restart b/gcloud/beta/alloydb/instances/restart index aa78774e3..212c7b3ba 100644 --- a/gcloud/beta/alloydb/instances/restart +++ b/gcloud/beta/alloydb/instances/restart @@ -41,8 +41,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances restart $ gcloud alpha alloydb instances restart diff --git a/gcloud/beta/alloydb/instances/update b/gcloud/beta/alloydb/instances/update index 941cc2926..8e6efb52f 100644 --- a/gcloud/beta/alloydb/instances/update +++ b/gcloud/beta/alloydb/instances/update @@ -70,8 +70,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb instances update $ gcloud alpha alloydb instances update diff --git a/gcloud/beta/alloydb/operations/cancel b/gcloud/beta/alloydb/operations/cancel index 653247b33..319ad7331 100644 --- a/gcloud/beta/alloydb/operations/cancel +++ b/gcloud/beta/alloydb/operations/cancel @@ -32,8 +32,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb operations cancel $ gcloud alpha alloydb operations cancel diff --git a/gcloud/beta/alloydb/operations/delete b/gcloud/beta/alloydb/operations/delete index 2cd73ae11..af82d15c3 100644 --- a/gcloud/beta/alloydb/operations/delete +++ b/gcloud/beta/alloydb/operations/delete @@ -32,8 +32,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb operations delete $ gcloud alpha alloydb operations delete diff --git a/gcloud/beta/alloydb/operations/describe b/gcloud/beta/alloydb/operations/describe index 080885b61..bbe16569f 100644 --- a/gcloud/beta/alloydb/operations/describe +++ b/gcloud/beta/alloydb/operations/describe @@ -1,12 +1,12 @@ NAME - gcloud beta alloydb operations describe - describe an AlloyDB operation + gcloud beta alloydb operations describe - describes an AlloyDB operation SYNOPSIS gcloud beta alloydb operations describe OPERATION --region=REGION [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Describe an AlloyDB operation. + (BETA) Describes an AlloyDB operation. EXAMPLES To describe an operation, run: @@ -32,8 +32,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb operations describe $ gcloud alpha alloydb operations describe diff --git a/gcloud/beta/alloydb/operations/help b/gcloud/beta/alloydb/operations/help index d0be562c6..dd4cd7fce 100644 --- a/gcloud/beta/alloydb/operations/help +++ b/gcloud/beta/alloydb/operations/help @@ -24,14 +24,16 @@ COMMANDS (BETA) Deletes an AlloyDB operation. describe - (BETA) Describe an AlloyDB operation. + (BETA) Describes an AlloyDB operation. list (BETA) Lists AlloyDB operations. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb operations $ gcloud alpha alloydb operations diff --git a/gcloud/beta/alloydb/operations/list b/gcloud/beta/alloydb/operations/list index 5cc4a0337..10ba3c5a1 100644 --- a/gcloud/beta/alloydb/operations/list +++ b/gcloud/beta/alloydb/operations/list @@ -65,8 +65,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud alloydb operations list $ gcloud alpha alloydb operations list diff --git a/gcloud/beta/app/create b/gcloud/beta/app/create index 7221251a2..a6ae1b703 100644 --- a/gcloud/beta/app/create +++ b/gcloud/beta/app/create @@ -3,7 +3,8 @@ NAME Cloud Project SYNOPSIS - gcloud beta app create [--region=REGION] [GCLOUD_WIDE_FLAG ...] + gcloud beta app create [--region=REGION] + [--service-account=SERVICE_ACCOUNT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create an App Engine app within the current Google Cloud Project. @@ -17,11 +18,25 @@ EXAMPLES $ gcloud beta app create --region=us-central + To create an app that with a user-managed service account, run: + + $ gcloud beta app create --service-account=SERVICE_ACCOUNT + FLAGS --region=REGION The region to create the app within. Use gcloud app regions list to list available regions. If not provided, select region interactively. + --service-account=SERVICE_ACCOUNT + The app-level default service account to create the app with. Note that + you can specify a distinct service account for each App Engine version + with gcloud app deploy --service-account. However if you do not specify + a version-level service account, this default will be used. If this + parameter is not provided for app creation, the app-level default will + be set to be the out-of-box App Engine Default Service Account, + https://cloud.google.com/appengine/docs/standard/python3/service-account + outlines the limitation of that service account. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/app/instances/ssh b/gcloud/beta/app/instances/ssh index e99fc06f3..0eda194ee 100644 --- a/gcloud/beta/app/instances/ssh +++ b/gcloud/beta/app/instances/ssh @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud beta app instances ssh INSTANCE [--container=CONTAINER] - [--service=SERVICE, -s SERVICE] [--version=VERSION, -v VERSION] - [GCLOUD_WIDE_FLAG ...] [-- COMMAND ...] + [--service=SERVICE, -s SERVICE] [--tunnel-through-iap] + [--version=VERSION, -v VERSION] [GCLOUD_WIDE_FLAG ...] [-- COMMAND ...] DESCRIPTION (BETA) gcloud beta app instances ssh lets you remotely log in to your @@ -59,6 +59,13 @@ FLAGS --service=SERVICE, -s SERVICE The service ID. + --tunnel-through-iap + Tunnel the ssh connection through Cloud Identity-Aware Proxy for TCP + forwarding. + + To learn more, see the IAP for TCP forwarding documentation + (https://cloud.google.com/iap/docs/tcp-forwarding-overview). + --version=VERSION, -v VERSION The version ID. diff --git a/gcloud/beta/app/update b/gcloud/beta/app/update index fc6d796f2..4b5d280bf 100644 --- a/gcloud/beta/app/update +++ b/gcloud/beta/app/update @@ -2,7 +2,8 @@ NAME gcloud beta app update - updates an App Engine application SYNOPSIS - gcloud beta app update [--[no-]split-health-checks] [GCLOUD_WIDE_FLAG ...] + gcloud beta app update [--service-account=SERVICE_ACCOUNT] + [--[no-]split-health-checks] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command is used to update settings on an app engine @@ -13,7 +14,14 @@ EXAMPLES $ gcloud beta app update --split-health-checks + To update the app-level service account on an application: + + $ gcloud beta app update --service-account=SERVICE_ACCOUNT + FLAGS + --service-account=SERVICE_ACCOUNT + The app-level default service account to update the app with. + --[no-]split-health-checks Enables/disables split health checks by default on new deployments. Use --split-health-checks to enable and --no-split-health-checks to diff --git a/gcloud/beta/asset/analyze-org-policies b/gcloud/beta/asset/analyze-org-policies new file mode 100644 index 000000000..dc5d660c8 --- /dev/null +++ b/gcloud/beta/asset/analyze-org-policies @@ -0,0 +1,80 @@ +NAME + gcloud beta asset analyze-org-policies - analyze organization policies + under a scope + +SYNOPSIS + gcloud beta asset analyze-org-policies --constraint=CONSTRAINT + --scope=SCOPE [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Analyze organization policies under a scope. + +EXAMPLES + To list 10 org policies of a constraint in an organization, run: + + $ gcloud beta asset analyze-org-policies \ + --scope=organizations/YOUR_ORG_ID \ + --constraint=YOUR_CONSTRAINT_NAME --limit=10 + +REQUIRED FLAGS + --constraint=CONSTRAINT + The name of the constraint to analyze organization policies for. The + response only contains analyzed organization policies for the provided + constraint. + + Examples: + + ◆ ``organizations/{ORGANIZATION_NUMBER}/customConstraints/{CUSTOM_CONSTRAINT_NAME} + for a user-defined custom constraint. + + --scope=SCOPE + Scope can only be an organization for now. The analysis is limited to + the Cloud org policies within this scope. The caller must be granted + the cloudasset.assets.searchAllResources permission on the desired + scope. + + The allowed values are: + + ◆ organizations/{ORGANIZATION_NUMBER} (e.g. organizations/123456) + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha asset analyze-org-policies + diff --git a/gcloud/beta/asset/analyze-org-policy-governed-containers b/gcloud/beta/asset/analyze-org-policy-governed-containers new file mode 100644 index 000000000..ac67c0680 --- /dev/null +++ b/gcloud/beta/asset/analyze-org-policy-governed-containers @@ -0,0 +1,81 @@ +NAME + gcloud beta asset analyze-org-policy-governed-containers - analyze + organization policies governed containers under a scope + +SYNOPSIS + gcloud beta asset analyze-org-policy-governed-containers + --constraint=CONSTRAINT --scope=SCOPE [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Analyze organization policies governed containers under a scope. + +EXAMPLES + To list 10 containers governed by a constraint in an organization, run: + + $ gcloud beta asset analyze-org-policy-governed-containers \ + --scope=organizations/YOUR_ORG_ID \ + --constraint=YOUR_CONSTRAINT_NAME --limit=10 + +REQUIRED FLAGS + --constraint=CONSTRAINT + The name of the constraint to analyze organization policies for. The + response only contains analyzed organization policies for the provided + constraint. + + Examples: + + ◆ ``organizations/{ORGANIZATION_NUMBER}/customConstraints/{CUSTOM_CONSTRAINT_NAME} + for a user-defined custom constraint. + + --scope=SCOPE + Scope can only be an organization for now. The analysis is limited to + the Cloud org policies and containers within this scope. The caller + must be granted the cloudasset.assets.searchAllResources permission on + the desired scope. + + The allowed values are: + + ◆ organizations/{ORGANIZATION_NUMBER} (e.g. organizations/123456) + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha asset analyze-org-policy-governed-containers + diff --git a/gcloud/beta/asset/help b/gcloud/beta/asset/help index eb9fff466..ccebb5c42 100644 --- a/gcloud/beta/asset/help +++ b/gcloud/beta/asset/help @@ -27,9 +27,15 @@ GROUPS COMMANDS COMMAND is one of the following: + analyze-org-policies + (BETA) Analyze organization policies under a scope. + analyze-org-policy-governed-assets (BETA) Analyze organization policies governed assets under a scope. + analyze-org-policy-governed-containers + (BETA) Analyze organization policies governed containers under a scope. + export (BETA) Export the cloud assets to Google Cloud Storage/BigQuery. diff --git a/gcloud/beta/asset/query b/gcloud/beta/asset/query index 062133222..8aaa2c544 100644 --- a/gcloud/beta/asset/query +++ b/gcloud/beta/asset/query @@ -13,17 +13,17 @@ SYNOPSIS : --bigquery-dataset=BIGQUERY_DATASET]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Issue an analytical query on Cloud assets using BigQuery Standard + (BETA) Issue an analytical query on Cloud assets using a BigQuery Standard SQL compatible statement. EXAMPLES - To count the number of compute instance, run: + To count the number of compute instances, run: $ gcloud beta asset query --project='test-project' \ --statement='SELECT * FROM compute_googleapis_com_Instance' - To see the query result of previous job, pass the job-reference from - previous response: + To see the query result of the previous job, pass the job-reference from + the previous response: $ gcloud beta asset query --project='test-project' \ --job-reference= @@ -152,8 +152,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud asset query $ gcloud alpha asset query diff --git a/gcloud/beta/assured/workloads/create b/gcloud/beta/assured/workloads/create index b1a4b8935..ea60d09c4 100644 --- a/gcloud/beta/assured/workloads/create +++ b/gcloud/beta/assured/workloads/create @@ -83,8 +83,8 @@ OPTIONAL FLAGS --partner=PARTNER The partner choice when creating a workload managed by local trusted - partners. PARTNER must be (currently only one value is supported): - LOCAL_CONTROLS_BY_S3NS. + partners. PARTNER must be one of: LOCAL_CONTROLS_BY_S3NS, + SOVEREIGN_CONTROLS_BY_T_SYSTEMS. --provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT The parent of the provisioned projects, for example, diff --git a/gcloud/beta/bigtable/instances/tables/create b/gcloud/beta/bigtable/instances/tables/create new file mode 100644 index 000000000..b3b2a7e3a --- /dev/null +++ b/gcloud/beta/bigtable/instances/tables/create @@ -0,0 +1,112 @@ +NAME + gcloud beta bigtable instances tables create - create a new Cloud Bigtable + table + +SYNOPSIS + gcloud beta bigtable instances tables create (TABLE : --instance=INSTANCE) + --column-families=[COLUMN_FAMILIES,...] [--deletion-protection] + [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a new Cloud Bigtable table. + +EXAMPLES + To create a table my-table in instance my-instance with a column family + my-family, run: + + $ gcloud beta bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" + + To create a table that has a column family named my-instance, a garbage + collection policy that lets data expire after 864,000 seconds, and initial + table splits on row keys car and key, run: + + $ gcloud beta bigtable instances tables create my-table \ + --instance=my-instance \ + --column-families="my-family:maxage=864000s" --splits=car,key + + To create a table my-table in instance my-instance that lets data in column + family my-family1 expire after 10 days and keeps a maximum of 5 cells per + column in column family my-family-2 if the data is less than 5 days old, + run: + + $ gcloud beta bigtable instances tables create my-table \ + --instance=my-instance \ + --column-families="my-family-1:maxage=10d,my-family-2:maxversion\ + s=5||maxage=5d" + + To create a deletion-protected table my-table in instance my-instance with + a column family my-family, run: + + $ gcloud beta bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --deletion-protection + + To create a table my-table without deletion protection in instance + my-instance with a column family my-family, run: + + $ gcloud beta bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --no-deletion-protection + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to create. 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --column-families=[COLUMN_FAMILIES,...] + A double-quote (") wrapped list of family name and corresponding + garbage collection rules concatenated by :, where the rules are + optional. For example: \ + "family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5" + +OPTIONAL FLAGS + --deletion-protection + Once specified, the table is deletion protected. + + --splits=[SPLITS,...] + Row keys where the table should initially be split. For example: + car,key + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable instances tables create + + $ gcloud alpha bigtable instances tables create + diff --git a/gcloud/beta/bigtable/instances/tables/delete b/gcloud/beta/bigtable/instances/tables/delete new file mode 100644 index 000000000..06cef2afe --- /dev/null +++ b/gcloud/beta/bigtable/instances/tables/delete @@ -0,0 +1,63 @@ +NAME + gcloud beta bigtable instances tables delete - delete a Cloud Bigtable + table + +SYNOPSIS + gcloud beta bigtable instances tables delete (TABLE : --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Cloud Bigtable table. + +EXAMPLES + To delete the table my-table in instance my-instance, run: + + $ gcloud beta bigtable instances tables delete my-table \ + --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance 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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable instances tables delete + + $ gcloud alpha bigtable instances tables delete + diff --git a/gcloud/beta/bigtable/instances/tables/describe b/gcloud/beta/bigtable/instances/tables/describe index 0acebdac9..81ce81539 100644 --- a/gcloud/beta/bigtable/instances/tables/describe +++ b/gcloud/beta/bigtable/instances/tables/describe @@ -58,6 +58,9 @@ FLAGS Only populates name and fields related to the table's replication. schema Only populates name and fields related to the table's schema. + stats + Only populates name and fields related to the table's statistics + (e.g. TableStats and ColumnFamilyStats). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/bigtable/instances/tables/help b/gcloud/beta/bigtable/instances/tables/help index cea34b570..81ad2c9e1 100644 --- a/gcloud/beta/bigtable/instances/tables/help +++ b/gcloud/beta/bigtable/instances/tables/help @@ -18,6 +18,12 @@ COMMANDS add-iam-policy-binding (BETA) Add an IAM policy binding to a Cloud Bigtable table. + create + (BETA) Create a new Cloud Bigtable table. + + delete + (BETA) Delete a Cloud Bigtable table. + describe (BETA) Retrieve information about a table. @@ -39,6 +45,9 @@ COMMANDS undelete (BETA) Undelete a previously deleted Cloud Bigtable table. + update + (BETA) Update an existing Cloud Bigtable table. + NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/bigtable/instances/tables/restore b/gcloud/beta/bigtable/instances/tables/restore index 5abea434b..74e98f8b7 100644 --- a/gcloud/beta/bigtable/instances/tables/restore +++ b/gcloud/beta/bigtable/instances/tables/restore @@ -21,12 +21,13 @@ EXAMPLES --source=backup1 --destination-instance=instance1 \ --destination=table2 - To restore table 'table2' from backup 'backup1' using relative names, run: + To restore table 'table2' from backup 'backup1' in a different project, + run: $ gcloud beta bigtable instances tables restore \ --source=projects/project1/instances/instance1/clusters/\ cluster1/backups/backup1 \ - --destination=projects/project1/instances/instance1/tables/\ + --destination=projects/project2/instances/instance2/tables/\ table2 REQUIRED FLAGS diff --git a/gcloud/beta/bigtable/instances/tables/update b/gcloud/beta/bigtable/instances/tables/update new file mode 100644 index 000000000..61e89f88b --- /dev/null +++ b/gcloud/beta/bigtable/instances/tables/update @@ -0,0 +1,77 @@ +NAME + gcloud beta bigtable instances tables update - update an existing Cloud + Bigtable table + +SYNOPSIS + gcloud beta bigtable instances tables update (TABLE : --instance=INSTANCE) + [--async] [--deletion-protection] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update an existing new Cloud Bigtable table with the specified + configuration. + +EXAMPLES + To enable deletion protection, run: + + $ gcloud beta bigtable instances tables update my-table \ + --instance=my-instance --deletion-protection + + To disable deletion protection, run: + + $ gcloud beta bigtable instances tables update my-table \ + --instance=my-instance --no-deletion-protection + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to update. 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deletion-protection + Once specified, the table is deletion protected. + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable instances tables update + + $ gcloud alpha bigtable instances tables update + diff --git a/gcloud/beta/builds/cancel b/gcloud/beta/builds/cancel index e7684360e..d1c3f3044 100644 --- a/gcloud/beta/builds/cancel +++ b/gcloud/beta/builds/cancel @@ -24,8 +24,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/builds/describe b/gcloud/beta/builds/describe index ee22d76b4..134727c0f 100644 --- a/gcloud/beta/builds/describe +++ b/gcloud/beta/builds/describe @@ -20,8 +20,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/builds/list b/gcloud/beta/builds/list index 37b5be390..f9d4fd585 100644 --- a/gcloud/beta/builds/list +++ b/gcloud/beta/builds/list @@ -24,18 +24,17 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. 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. - With the exception of regex matching, this flag interacts with other - flags that are applied in this order: --flatten, --sort-by, --filter, - --limit. Any regex operations specified by --filter are applied - client-side, after --limit. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. --limit=LIMIT; default=50 Maximum number of resources to list. The default is 50. This flag diff --git a/gcloud/beta/builds/log b/gcloud/beta/builds/log index ecbfa3787..e2b1dc2c4 100644 --- a/gcloud/beta/builds/log +++ b/gcloud/beta/builds/log @@ -26,8 +26,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --stream If a build is ongoing, stream the logs to stdout until the build diff --git a/gcloud/beta/builds/submit b/gcloud/beta/builds/submit index 498f02c78..efa898163 100644 --- a/gcloud/beta/builds/submit +++ b/gcloud/beta/builds/submit @@ -94,8 +94,9 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --substitutions=[KEY=VALUE,...] Parameters to be substituted in the build specification. @@ -168,9 +169,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - You can also run a build locally using the separate component: gcloud - components install cloud-build-local. - This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/builds/triggers/create/bitbucketserver b/gcloud/beta/builds/triggers/create/bitbucketserver index 3c2380997..ae8a02d0e 100644 --- a/gcloud/beta/builds/triggers/create/bitbucketserver +++ b/gcloud/beta/builds/triggers/create/bitbucketserver @@ -7,10 +7,11 @@ SYNOPSIS (--trigger-config=PATH | [--bitbucket-server-config-resource=BITBUCKET_SERVER_CONFIG_RESOURCE --project-key=PROJECT_KEY --repo-slug=REPO_SLUG (--branch-pattern=REGEX | --tag-pattern=REGEX | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, 1)]) (--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) : --description=DESCRIPTION --ignored-files=[GLOB,...] - --included-files=[GLOB,...] --name=NAME --require-approval + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -84,6 +85,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -163,20 +171,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -188,6 +192,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -213,8 +220,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create bitbucketserver $ gcloud alpha builds triggers create bitbucketserver diff --git a/gcloud/beta/builds/triggers/create/cloud-source-repositories b/gcloud/beta/builds/triggers/create/cloud-source-repositories index 6b15adfdf..768499208 100644 --- a/gcloud/beta/builds/triggers/create/cloud-source-repositories +++ b/gcloud/beta/builds/triggers/create/cloud-source-repositories @@ -6,10 +6,11 @@ SYNOPSIS gcloud beta builds triggers create cloud-source-repositories (--trigger-config=PATH | [--repo=REPO (--branch-pattern=REGEX | --tag-pattern=REGEX) (--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) : --description=DESCRIPTION --ignored-files=[GLOB,...] - --included-files=[GLOB,...] --name=NAME --require-approval + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -63,6 +64,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -120,20 +128,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -145,6 +149,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -170,8 +177,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create cloud-source-repositories $ gcloud alpha builds triggers create cloud-source-repositories diff --git a/gcloud/beta/builds/triggers/create/github b/gcloud/beta/builds/triggers/create/github index 78813e456..45326b860 100644 --- a/gcloud/beta/builds/triggers/create/github +++ b/gcloud/beta/builds/triggers/create/github @@ -4,15 +4,16 @@ NAME SYNOPSIS gcloud beta builds triggers create github - (--trigger-config=PATH | [--repo-name=REPO_NAME - --repo-owner=REPO_OWNER (--branch-pattern=REGEX | --tag-pattern=REGEX + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED"]) (--build-config=PATH - | --inline-config=PATH | --dockerfile=DOCKERFILE - --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --ignored-files=[GLOB,...] - --include-logs-with-status --included-files=[GLOB,...] --name=NAME + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; default="/" + --dockerfile-image=DOCKERFILE_IMAGE]) (--repository=REPOSITORY + | [--repo-name=REPO_NAME --repo-owner=REPO_OWNER + : --enterprise-config=ENTERPRISE_CONFIG]) : --description=DESCRIPTION + --ignored-files=[GLOB,...] --include-logs-with-status + --included-files=[GLOB,...] --name=NAME --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -21,7 +22,7 @@ DESCRIPTION (BETA) Create a build trigger for a GitHub repository. EXAMPLES - To create a push trigger for all branches: + To create a push trigger with a 1st-gen repository for all branches: $ gcloud beta builds triggers create github --name="my-trigger" \ --service-account="projects/my-project/serviceAccounts/my-byosa@\ @@ -30,7 +31,7 @@ EXAMPLES --repo-name="cloud-builders" --branch-pattern=".*" \ --build-config="cloudbuild.yaml" - To create a pull request trigger for master: + To create a pull request trigger with a 1st-gen repository for master: $ gcloud beta builds triggers create github --name="my-trigger" \ --service-account="projects/my-project/serviceAccounts/my-byosa@\ @@ -39,6 +40,14 @@ EXAMPLES --repo-name="cloud-builders" --pull-request-pattern="^master$" \ --build-config="cloudbuild.yaml" + To create a pull request trigger with a 2nd gen repository for master: + + $ gcloud beta builds triggers create github --name="my-trigger" \ + --repository=projects/my-project/locations/us-central1/\ + connections/my-conn/repositories/my-repo \ + --pull-request-pattern="^master$" \ + --build-config="cloudbuild.yaml" + REQUIRED FLAGS Exactly one of these must be specified: @@ -49,18 +58,6 @@ REQUIRED FLAGS Flag based trigger configuration - --repo-name=REPO_NAME - Name of the GitHub Repository. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --repo-owner=REPO_OWNER - Owner of the GitHub Repository. - - This flag argument must be specified if any of the other arguments - in this group are specified. - --description=DESCRIPTION Build trigger description. @@ -79,6 +76,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -170,20 +174,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -195,6 +195,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -211,6 +214,33 @@ REQUIRED FLAGS Use a build configuration (cloudbuild.yaml) file for building multiple images in a single trigger. + Exactly one of these must be specified: + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + 1st-gen repository settings. + + --repo-name=REPO_NAME + Name of the GitHub Repository (1st gen). + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --repo-owner=REPO_OWNER + Owner of the GitHub Repository (1st gen). + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --enterprise-config=ENTERPRISE_CONFIG + Resource name of the GitHub Enterprise config that should be + applied to this installation. + + For example: + "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id} + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -220,8 +250,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create github $ gcloud alpha builds triggers create github diff --git a/gcloud/beta/builds/triggers/create/gitlab-enterprise b/gcloud/beta/builds/triggers/create/gitlab-enterprise index 4ffd04254..0dc68251b 100644 --- a/gcloud/beta/builds/triggers/create/gitlab-enterprise +++ b/gcloud/beta/builds/triggers/create/gitlab-enterprise @@ -6,15 +6,16 @@ SYNOPSIS gcloud beta builds triggers create gitlab-enterprise (--trigger-config=PATH | [--gitlab-config-resource=GITLAB_CONFIG_RESOURCE - --project-namespace=PROJECT_NAMESPACE - --region=REGION (--branch-pattern=REGEX | --tag-pattern=REGEX - | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + --project-namespace=PROJECT_NAMESPACE (--branch-pattern=REGEX + | --tag-pattern=REGEX | [--pull-request-pattern=REGEX + : --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, 1)]) (--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) : --description=DESCRIPTION --ignored-files=[GLOB,...] - --included-files=[GLOB,...] --name=NAME --require-approval + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) [GCLOUD_WIDE_FLAG ...] @@ -65,14 +66,6 @@ REQUIRED FLAGS This flag argument must be specified if any of the other arguments in this group are specified. - --region=REGION - The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region - is used. If builds/region is unset,region is set to "global". - - This flag argument must be specified if any of the other arguments - in this group are specified. - --description=DESCRIPTION Build trigger description. @@ -87,6 +80,13 @@ REQUIRED FLAGS --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -187,6 +187,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -212,8 +215,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create gitlab-enterprise $ gcloud alpha builds triggers create gitlab-enterprise diff --git a/gcloud/beta/builds/triggers/create/help b/gcloud/beta/builds/triggers/create/help index 01a9550e3..8930c2ffd 100644 --- a/gcloud/beta/builds/triggers/create/help +++ b/gcloud/beta/builds/triggers/create/help @@ -38,8 +38,10 @@ COMMANDS (BETA) Create a build trigger with a Webhook trigger event. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create $ gcloud alpha builds triggers create diff --git a/gcloud/beta/builds/triggers/create/manual b/gcloud/beta/builds/triggers/create/manual index dc04896d3..111ebe229 100644 --- a/gcloud/beta/builds/triggers/create/manual +++ b/gcloud/beta/builds/triggers/create/manual @@ -5,11 +5,11 @@ NAME SYNOPSIS gcloud beta builds triggers create manual (--trigger-config=PATH | [(--build-config=PATH | --inline-config=PATH - | --dockerfile=DOCKERFILE --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --name=NAME --require-approval - --service-account=SERVICE_ACCOUNT - --subscription-filter=SUBSCRIPTION_FILTER + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...] --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) [GCLOUD_WIDE_FLAG ...] @@ -39,9 +39,22 @@ REQUIRED FLAGS --description=DESCRIPTION Build trigger description. + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -53,11 +66,6 @@ REQUIRED FLAGS used instead. Format: projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. - --subscription-filter=SUBSCRIPTION_FILTER - CEL filter expression for the trigger. See - https://cloud.google.com/build/docs/filter-build-events-using-cel - for more details. - --substitutions=[KEY=VALUE,...] Parameters to be substituted in the build specification. @@ -80,20 +88,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -105,6 +109,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -154,8 +161,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create manual $ gcloud alpha builds triggers create manual diff --git a/gcloud/beta/builds/triggers/create/pubsub b/gcloud/beta/builds/triggers/create/pubsub index 3edcd65ea..8b0c834df 100644 --- a/gcloud/beta/builds/triggers/create/pubsub +++ b/gcloud/beta/builds/triggers/create/pubsub @@ -5,11 +5,12 @@ NAME SYNOPSIS gcloud beta builds triggers create pubsub (--trigger-config=PATH | [--topic=TOPIC (--build-config=PATH - | --inline-config=PATH | --dockerfile=DOCKERFILE - --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --name=NAME --require-approval - --service-account=SERVICE_ACCOUNT + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --subscription-filter=SUBSCRIPTION_FILTER --substitutions=[KEY=VALUE,...] --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) @@ -49,9 +50,22 @@ REQUIRED FLAGS --description=DESCRIPTION Build trigger description. + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -90,20 +104,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -115,6 +125,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -164,8 +177,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create pubsub $ gcloud alpha builds triggers create pubsub diff --git a/gcloud/beta/builds/triggers/create/webhook b/gcloud/beta/builds/triggers/create/webhook index d5a413afe..5d30f9f2b 100644 --- a/gcloud/beta/builds/triggers/create/webhook +++ b/gcloud/beta/builds/triggers/create/webhook @@ -5,11 +5,12 @@ NAME SYNOPSIS gcloud beta builds triggers create webhook (--trigger-config=PATH | [--secret=SECRET (--build-config=PATH - | --inline-config=PATH | --dockerfile=DOCKERFILE - --dockerfile-dir=DOCKERFILE_DIR; - default="/" --dockerfile-image=DOCKERFILE_IMAGE) - : --description=DESCRIPTION --name=NAME --require-approval - --service-account=SERVICE_ACCOUNT + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT --subscription-filter=SUBSCRIPTION_FILTER --substitutions=[KEY=VALUE,...] --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) @@ -52,9 +53,22 @@ REQUIRED FLAGS --description=DESCRIPTION Build trigger description. + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + --name=NAME Build trigger name. + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + --require-approval Require manual approval for triggered builds. @@ -93,20 +107,16 @@ REQUIRED FLAGS Exactly one of these must be specified: - Build file configuration flags + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. - --build-config=PATH - Path to a YAML or JSON file containing the build configuration - in the repository. + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config - For more details, see: - https://cloud.google.com/cloud-build/docs/build-config - - Build configuration file - - --inline-config=PATH - Local path to a YAML or JSON file containing a build - configuration. + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. Dockerfile build configuration flags @@ -118,6 +128,9 @@ REQUIRED FLAGS The filename is relative to the Dockerfile directory. + This flag argument must be specified if any of the other + arguments in this group are specified. + --dockerfile-dir=DOCKERFILE_DIR; default="/" Location of the directory containing the Dockerfile in the repository. @@ -167,8 +180,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers create webhook $ gcloud alpha builds triggers create webhook diff --git a/gcloud/beta/builds/triggers/delete b/gcloud/beta/builds/triggers/delete index 597a3cc96..1d4e614a8 100644 --- a/gcloud/beta/builds/triggers/delete +++ b/gcloud/beta/builds/triggers/delete @@ -49,8 +49,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers delete $ gcloud alpha builds triggers delete diff --git a/gcloud/beta/builds/triggers/describe b/gcloud/beta/builds/triggers/describe index 69cb115e4..3e00e006f 100644 --- a/gcloud/beta/builds/triggers/describe +++ b/gcloud/beta/builds/triggers/describe @@ -50,8 +50,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers describe $ gcloud alpha builds triggers describe diff --git a/gcloud/beta/builds/triggers/help b/gcloud/beta/builds/triggers/help index 83ee14c24..3d32ef067 100644 --- a/gcloud/beta/builds/triggers/help +++ b/gcloud/beta/builds/triggers/help @@ -41,8 +41,10 @@ COMMANDS (BETA) Run a build trigger. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers $ gcloud alpha builds triggers diff --git a/gcloud/beta/builds/triggers/import b/gcloud/beta/builds/triggers/import index d0c12567f..0919728db 100644 --- a/gcloud/beta/builds/triggers/import +++ b/gcloud/beta/builds/triggers/import @@ -22,8 +22,9 @@ REQUIRED FLAGS OPTIONAL FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -34,8 +35,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers import $ gcloud alpha builds triggers import diff --git a/gcloud/beta/builds/triggers/list b/gcloud/beta/builds/triggers/list index cb74cde02..5f155cb13 100644 --- a/gcloud/beta/builds/triggers/list +++ b/gcloud/beta/builds/triggers/list @@ -18,8 +18,9 @@ EXAMPLES FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. LIST COMMAND FLAGS --filter=EXPRESSION @@ -62,8 +63,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers list $ gcloud alpha builds triggers list diff --git a/gcloud/beta/builds/triggers/run b/gcloud/beta/builds/triggers/run index 631eecaae..764c061c2 100644 --- a/gcloud/beta/builds/triggers/run +++ b/gcloud/beta/builds/triggers/run @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud beta builds triggers run (TRIGGER : --region=REGION) - [--branch=BRANCH | --sha=SHA | --tag=TAG] [GCLOUD_WIDE_FLAG ...] + (--branch=BRANCH | --sha=SHA | --tag=TAG) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Run a build trigger. @@ -40,8 +40,8 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property builds/region. -FLAGS - At most one of these can be specified: +REQUIRED FLAGS + Exactly one of these must be specified: --branch=BRANCH Branch to run. @@ -61,8 +61,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds triggers run $ gcloud alpha builds triggers run diff --git a/gcloud/beta/builds/worker-pools/create b/gcloud/beta/builds/worker-pools/create index 58e34241b..17e299078 100644 --- a/gcloud/beta/builds/worker-pools/create +++ b/gcloud/beta/builds/worker-pools/create @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud beta builds worker-pools create WORKER_POOL --region=REGION [--config-from-file=CONFIG_FROM_FILE | --peered-network=PEERED_NETWORK - --no-public-egress --worker-disk-size=WORKER_DISK_SIZE + --peered-network-ip-range=PEERED_NETWORK_IP_RANGE --no-public-egress + --worker-disk-size=WORKER_DISK_SIZE --worker-machine-type=WORKER_MACHINE_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -18,11 +19,13 @@ EXAMPLES To create a worker pool in project p1 in region us-central1 where workers are of machine type e2-standard-2 and are peered to the VPC network - projects/123/global/networks/default and have a disk size of 64GB, run: + projects/123/global/networks/default within the IP range 192.168.0.0/28 and + have a disk size of 64GB, run: $ gcloud beta builds worker-pools create wp1 --project=p1 \ --region=us-central1 \ --peered-network=projects/123/global/networks/default \ + --peered-network-ip-range=192.168.0.0/28 \ --worker-machine-type=e2-standard-2 --worker-disk-size=64GB POSITIONAL ARGUMENTS @@ -53,6 +56,19 @@ OPTIONAL FLAGS If not specified, the workers are not peered to any network. + --peered-network-ip-range=PEERED_NETWORK_IP_RANGE + An IP range for your peered network. Specify the IP range using + Classless Inter-Domain Routing (CIDR) notation with a slash and the + subnet prefix size, such as '/29'. + + Your subnet prefix size must be between 1 and 29. Optional: you can + specify an IP address before the subnet prefix value - for example + 192.168.0.1/24. + + If no IP address is specified, your VPC automatically determines + the starting IP for the range. If no IP range is specified, Cloud + Build uses '/24' as the default network IP range. + --no-public-egress If set, workers in the worker pool are created without an external IP address. diff --git a/gcloud/beta/composer/environments/check-upgrade b/gcloud/beta/composer/environments/check-upgrade index 7febef6fa..fa1a76ae9 100644 --- a/gcloud/beta/composer/environments/check-upgrade +++ b/gcloud/beta/composer/environments/check-upgrade @@ -61,6 +61,7 @@ FLAGS Upgrade the environment to a later Apache Airflow version in-place. Must be of the form X[.Y[.Z]], where [] denotes optional fragments. + Examples: 2, 2.3, 2.3.4. The Apache Airflow version is a semantic version or an alias in the form of major or major.minor version numbers, resolved to the latest @@ -76,6 +77,9 @@ FLAGS composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional fragments. + Examples: composer-2-airflow-2, composer-2-airflow-2.2, + composer-2.1.2-airflow-2.3.4. + The Cloud Composer portion of the image version is a semantic version or an alias in the form of major version number or latest, resolved to the current Cloud Composer version. The Apache Airflow portion of diff --git a/gcloud/beta/composer/environments/create b/gcloud/beta/composer/environments/create index 2458c7f1a..117dd6907 100644 --- a/gcloud/beta/composer/environments/create +++ b/gcloud/beta/composer/environments/create @@ -6,7 +6,8 @@ SYNOPSIS gcloud beta composer environments create (ENVIRONMENT : --location=LOCATION) [--airflow-configs=[KEY=VALUE,...]] [--async] [--cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE] - [--disk-size=DISK_SIZE] [--env-variables=[NAME=VALUE,...]] + [--disk-size=DISK_SIZE] [--enable-cloud-data-lineage-integration] + [--env-variables=[NAME=VALUE,...]] [--environment-size=ENVIRONMENT_SIZE] [--labels=[KEY=VALUE,...]] [--machine-type=MACHINE_TYPE] [--node-count=NODE_COUNT] [--oauth-scopes=[SCOPE,...]] [--python-version=PYTHON_VERSION] @@ -16,8 +17,8 @@ SYNOPSIS [--cloud-sql-ipv4-cidr=CLOUD_SQL_IPV4_CIDR --composer-network-ipv4-cidr=COMPOSER_NETWORK_IPV4_CIDR --connection-subnetwork=CONNECTION_SUBNETWORK - --enable-private-endpoint --enable-private-environment - --enable-privately-used-public-ips + --connection-type=CONNECTION_TYPE --enable-private-endpoint + --enable-private-environment --enable-privately-used-public-ips --master-ipv4-cidr=MASTER_IPV4_CIDR --web-server-ipv4-cidr=WEB_SERVER_IPV4_CIDR] [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR @@ -28,6 +29,12 @@ SYNOPSIS --services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME] [--enable-master-authorized-networks --master-authorized-networks=[NETWORK,...]] + [--enable-scheduled-snapshot-creation + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + --snapshot-location=SNAPSHOT_LOCATION + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE] + [--enable-triggerer + --triggerer-cpu=TRIGGERER_CPU --triggerer-memory=TRIGGERER_MEMORY] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [--maintenance-window-end=MAINTENANCE_WINDOW_END @@ -103,7 +110,9 @@ FLAGS complete. --cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE - Cloud SQL machine type used by the Airflow database. + Cloud SQL machine type used by the Airflow database. The list of + available machine types is available here: + https://cloud.google.com/composer/pricing#db-machine-types. --disk-size=DISK_SIZE The disk size for each VM node in the environment. The minimum size is @@ -111,6 +120,12 @@ FLAGS multiple of gigabytes. Cannot be updated after the environment has been created. If units are not provided, defaults to GB. + Group of arguments for setting Cloud Data Lineage integration + configuration in Composer 2. + + --enable-cloud-data-lineage-integration + Enable Cloud Data Lineage integration. + --env-variables=[NAME=VALUE,...] A comma-delimited list of environment variable NAME=VALUE pairs to provide to the Airflow scheduler, worker, and webserver processes. NAME @@ -180,6 +195,7 @@ FLAGS Version of Apache Airflow to run in the environment. Must be of the form `X[.Y[.Z]]`, where `[]` denotes optional fragments. + Examples: `2`, `2.3`, `2.3.4`. The current Cloud Composer version will be used within the created environment. The Apache Airflow version is a semantic version or an alias @@ -196,6 +212,9 @@ FLAGS `composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]]`, where `[]` denotes optional fragments. + Examples: `composer-2-airflow-2`, `composer-2-airflow-2.2`, + `composer-2.1.2-airflow-2.3.4`. + The Cloud Composer portion of the image version is a semantic version or an alias in the form of major version number or `latest`, resolved to the current Cloud Composer version. The Apache Airflow portion of the image @@ -229,6 +248,17 @@ FLAGS Can be specified for Composer 2.X or greater. Cannot be specified unless --enable-private-environment is also specified. + --connection-type=CONNECTION_TYPE + Mode of internal communication within the Composer environment. Must + be one of VPC_PEERING or PRIVATE_SERVICE_CONNECT. + + Can be specified for Composer 2.X or greater. Cannot be specified + unless --enable-private-environment is also specified. Cannot be set + to VPC_PEERING if --connection-subnetwork is also specified. + + CONNECTION_TYPE must be one of: connection-type-unspecified, + private-service-connect, vpc-peering. + --enable-private-endpoint Environment cluster is managed using the private IP address of the master API endpoint. Therefore access to the master endpoint must be @@ -246,7 +276,8 @@ FLAGS If not specified, cluster nodes will be assigned public IP addresses. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --enable-privately-used-public-ips When enabled GKE pods and services may use public(non-RFC1918) IP @@ -276,14 +307,16 @@ FLAGS IP address range for the pods in this cluster in CIDR notation (e.g. 10.0.0.0/14). - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --cluster-secondary-range-name=CLUSTER_SECONDARY_RANGE_NAME Secondary range to be used as the source for pod IPs. Alias ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --enable-ip-alias Enable use of alias IPs @@ -299,7 +332,8 @@ FLAGS node's IP address. This is done when sending traffic to destinations outside the cluster's pod CIDR range. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --max-pods-per-node=MAX_PODS_PER_NODE Maximum number of pods that can be assigned to a single node, can be @@ -318,13 +352,15 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. --services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME Secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Cannot be specified unless --enable-ip-alias is also specified. + When used with Composer 1.x, cannot be specified unless + --enable-ip-alias is also specified. Master Authorized Networks configuration @@ -340,6 +376,55 @@ FLAGS Cannot be specified unless --enable-master-authorized-networks is also specified. + Group of arguments for setting scheduled snapshots settings in Composer + 2.0.32 or greater. + + --enable-scheduled-snapshot-creation + When specified, snapshots of the environment will be created + according to a schedule. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + Cron expression specifying when snapshots of the environment should + be created. Can be specified for Composer 2.0.32 or greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --snapshot-location=SNAPSHOT_LOCATION + The Cloud Storage location for storing automatically created + snapshots. Can be specified for Composer 2.0.32 or greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE + Timezone that sets the context to interpret + snapshot_creation_schedule. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Group of arguments for setting triggerer settings in Composer 2.0.31 or + greater. + + --enable-triggerer + Enable use of a triggerer, supported in the Environments with + Composer 2.0.31 and Airflow 2.2.5 and greater. + + --triggerer-cpu=TRIGGERER_CPU + CPU allocated to Airflow triggerer. Supported in the Environments + with Composer 2.0.31 and Airflow 2.2.5 and greater. + + --triggerer-memory=TRIGGERER_MEMORY + Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If units + are not provided, defaults to GB. Supported in the Environments with + Composer 2.0.31 and Airflow 2.2.5 and greater. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the environment. The 'Cloud Composer Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/beta/composer/environments/help b/gcloud/beta/composer/environments/help index 6e207a233..12e1a16a8 100644 --- a/gcloud/beta/composer/environments/help +++ b/gcloud/beta/composer/environments/help @@ -22,7 +22,7 @@ GROUPS GROUP is one of the following: snapshots - (BETA) Saves and loads snapshots of environment. + (BETA) Save and load snapshots of environment. storage (BETA) Manage Cloud Storage objects stored as part of Cloud Composer diff --git a/gcloud/beta/composer/environments/run b/gcloud/beta/composer/environments/run index d3d044279..8072a8b77 100644 --- a/gcloud/beta/composer/environments/run +++ b/gcloud/beta/composer/environments/run @@ -64,16 +64,16 @@ POSITIONAL ARGUMENTS The Airflow CLI subcommand to run. Available subcommands include (listed with Airflow versions that support): backfill [**, 2.0.0), clear [**, 2.0.0), connections [**, 3.0.0), dag_state [**, 2.0.0), dags - [1.10.14, 3.0.0), delete_dag [1.10.1, 2.0.0), kerberos [**, 3.0.0), - kubernetes [2.1.4, 3.0.0), list_dag_runs [1.10.2, 2.0.0), list_dags - [**, 2.0.0), list_tasks [**, 2.0.0), next_execution [1.10.2, 2.0.0), - pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14, 3.0.0), render - [**, 2.0.0), roles [2.0.0, 3.0.0), run [**, 2.0.0), sync-perm [1.10.14, - 3.0.0), sync_perm [1.10.2, 2.0.0), task_failed_deps [**, 2.0.0), - task_state [**, 2.0.0), tasks [1.10.14, 3.0.0), test [**, 2.0.0), - trigger_dag [**, 2.0.0), unpause [**, 2.0.0), upgrade_check [1.10.15, - 2.0.0), users [1.10.14, 3.0.0), variables [**, 3.0.0), version [**, - 3.0.0) (see + [1.10.14, 3.0.0), db [2.3.0, 3.0.0), delete_dag [1.10.1, 2.0.0), + kerberos [**, 3.0.0), kubernetes [2.1.4, 3.0.0), list_dag_runs [1.10.2, + 2.0.0), list_dags [**, 2.0.0), list_tasks [**, 2.0.0), next_execution + [1.10.2, 2.0.0), pause [**, 2.0.0), pool [**, 2.0.0), pools [1.10.14, + 3.0.0), render [**, 2.0.0), roles [2.0.0, 3.0.0), run [**, 2.0.0), + sync-perm [1.10.14, 3.0.0), sync_perm [1.10.2, 2.0.0), task_failed_deps + [**, 2.0.0), task_state [**, 2.0.0), tasks [1.10.14, 3.0.0), test [**, + 2.0.0), trigger_dag [**, 2.0.0), unpause [**, 2.0.0), upgrade_check + [1.10.15, 2.0.0), users [1.10.14, 3.0.0), variables [**, 3.0.0), + version [**, 3.0.0) (see https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html for more info). diff --git a/gcloud/beta/composer/environments/snapshots/help b/gcloud/beta/composer/environments/snapshots/help index 5f066e34b..9baffc5a0 100644 --- a/gcloud/beta/composer/environments/snapshots/help +++ b/gcloud/beta/composer/environments/snapshots/help @@ -1,5 +1,5 @@ NAME - gcloud beta composer environments snapshots - saves and loads snapshots of + gcloud beta composer environments snapshots - save and load snapshots of environment SYNOPSIS @@ -24,8 +24,10 @@ COMMANDS (BETA) Save a snapshot of the environment. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud composer environments snapshots $ gcloud alpha composer environments snapshots diff --git a/gcloud/beta/composer/environments/snapshots/load b/gcloud/beta/composer/environments/snapshots/load index 4b706a981..6a4b26196 100644 --- a/gcloud/beta/composer/environments/snapshots/load +++ b/gcloud/beta/composer/environments/snapshots/load @@ -5,7 +5,9 @@ NAME SYNOPSIS gcloud beta composer environments snapshots load (ENVIRONMENT : --location=LOCATION) --snapshot-path=SNAPSHOT_PATH - [--async] [--skip-pypi-packages-installation] [GCLOUD_WIDE_FLAG ...] + [--async] [--skip-airflow-overrides-setting] + [--skip-environment-variables-setting] [--skip-gcs-data-copying] + [--skip-pypi-packages-installation] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Load a snapshot into the environment. @@ -55,6 +57,16 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --skip-airflow-overrides-setting + When specified, skips setting Airflow overrides from the snapshot. + + --skip-environment-variables-setting + When specified, skips setting environment variables from the snapshot. + + --skip-gcs-data-copying + When specified, skips copying dags, plugins and data folders from the + snapshot. + --skip-pypi-packages-installation When specified, skips the installation of custom PyPI packages from the snapshot. @@ -68,8 +80,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud composer environments snapshots load $ gcloud alpha composer environments snapshots load diff --git a/gcloud/beta/composer/environments/snapshots/save b/gcloud/beta/composer/environments/snapshots/save index 75b883d02..a30edab9d 100644 --- a/gcloud/beta/composer/environments/snapshots/save +++ b/gcloud/beta/composer/environments/snapshots/save @@ -62,8 +62,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud composer environments snapshots save $ gcloud alpha composer environments snapshots save diff --git a/gcloud/beta/composer/environments/update b/gcloud/beta/composer/environments/update index 6246e17d1..7a9d9fa5a 100644 --- a/gcloud/beta/composer/environments/update +++ b/gcloud/beta/composer/environments/update @@ -9,9 +9,16 @@ SYNOPSIS | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE | --airflow-version=AIRFLOW_VERSION | --image-version=IMAGE_VERSION + | --disable-cloud-data-lineage-integration + | --enable-cloud-data-lineage-integration | --disable-master-authorized-networks --enable-master-authorized-networks --master-authorized-networks=[NETWORK,...] + | --disable-scheduled-snapshot-creation + | --enable-scheduled-snapshot-creation + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + --snapshot-location=SNAPSHOT_LOCATION + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE | --maintenance-window-end=MAINTENANCE_WINDOW_END --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE --maintenance-window-start=MAINTENANCE_WINDOW_START @@ -21,7 +28,10 @@ SYNOPSIS --scheduler-storage=SCHEDULER_STORAGE --web-server-cpu=WEB_SERVER_CPU --web-server-memory=WEB_SERVER_MEMORY --web-server-storage=WEB_SERVER_STORAGE --worker-cpu=WORKER_CPU - --worker-memory=WORKER_MEMORY --worker-storage=WORKER_STORAGE + --worker-memory=WORKER_MEMORY + --worker-storage=WORKER_STORAGE --disable-triggerer + | --enable-triggerer + --triggerer-cpu=TRIGGERER_CPU --triggerer-memory=TRIGGERER_MEMORY | --update-airflow-configs=[KEY=VALUE,...] --clear-airflow-configs | --remove-airflow-configs=[KEY,...] | --update-env-variables=[NAME=VALUE,...] --clear-env-variables @@ -79,7 +89,9 @@ REQUIRED FLAGS Exactly one of these must be specified: --cloud-sql-machine-type=CLOUD_SQL_MACHINE_TYPE - Cloud SQL machine type used by the Airflow database. + Cloud SQL machine type used by the Airflow database. The list of + available machine types is available here: + https://cloud.google.com/composer/pricing#db-machine-types. --environment-size=ENVIRONMENT_SIZE Size of the environment. Unspecified means that the default option @@ -102,6 +114,7 @@ REQUIRED FLAGS Upgrade the environment to a later Apache Airflow version in-place. Must be of the form X[.Y[.Z]], where [] denotes optional fragments. + Examples: 2, 2.3, 2.3.4. The Apache Airflow version is a semantic version or an alias in the form of major or major.minor version numbers, resolved to the @@ -117,6 +130,9 @@ REQUIRED FLAGS composer-A[.B.C[-D.E]]-airflow-X[.Y[.Z]], where [] denotes optional fragments. + Examples: composer-2-airflow-2, composer-2-airflow-2.2, + composer-2.1.2-airflow-2.3.4. + The Cloud Composer portion of the image version is a semantic version or an alias in the form of major version number or latest, resolved to the current Cloud Composer version. The Apache Airflow @@ -126,6 +142,17 @@ REQUIRED FLAGS Composer version. The resolved versions are stored in the upgraded environment. + Group of arguments for setting Cloud Data Lineage integration + configuration in Composer 2. + + At most one of these can be specified: + + --disable-cloud-data-lineage-integration + Disable Cloud Data Lineage integration. + + --enable-cloud-data-lineage-integration + Enable Cloud Data Lineage integration. + Group of arguments for setting master authorized networks configuration. --disable-master-authorized-networks @@ -145,6 +172,49 @@ REQUIRED FLAGS Cannot be specified unless --enable-master-authorized-networks is also specified. + Group of arguments used during update of scheduled snapshots settings in + Composer 2.0.32 or greater. + + At most one of these can be specified: + + --disable-scheduled-snapshot-creation + Disables automated snapshots creation. Can be specified for + Composer 2.0.32 or greater. + + Group of arguments for setting scheduled snapshots settings in + Composer 2.0.32 or greater. + + --enable-scheduled-snapshot-creation + When specified, snapshots of the environment will be created + according to a schedule. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE + Cron expression specifying when snapshots of the environment + should be created. Can be specified for Composer 2.0.32 or + greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --snapshot-location=SNAPSHOT_LOCATION + The Cloud Storage location for storing automatically created + snapshots. Can be specified for Composer 2.0.32 or greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE + Timezone that sets the context to interpret + snapshot_creation_schedule. Can be specified for Composer 2.0.32 + or greater. + + This flag argument must be specified if any of the other + arguments in this group are specified. + Group of arguments for setting the maintenance window value. --maintenance-window-end=MAINTENANCE_WINDOW_END @@ -223,6 +293,33 @@ REQUIRED FLAGS Storage allocated to Airflow worker, ex. 600MB, 3GB, 2. If units are not provided, defaults to GB. + Group of arguments for setting triggerer settings in Composer 2.0.31 + or greater. + + At most one of these can be specified: + + --disable-triggerer + Disable a triggerer, supported in the Environments with Composer + 2.0.31 and Airflow 2.2.5 and greater. + + Group of arguments for setting triggerer settings during update in + Composer 2.0.31 or greater. + + --enable-triggerer + Enable use of a triggerer, supported in the Environments with + Composer 2.0.31 and Airflow 2.2.5 and greater. + + --triggerer-cpu=TRIGGERER_CPU + CPU allocated to Airflow triggerer. Supported in the + Environments with Composer 2.0.31 and Airflow 2.2.5 and + greater. + + --triggerer-memory=TRIGGERER_MEMORY + Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If + units are not provided, defaults to GB. Supported in the + Environments with Composer 2.0.31 and Airflow 2.2.5 and + greater. + Group of arguments for modifying the Airflow configuration. --update-airflow-configs=[KEY=VALUE,...] diff --git a/gcloud/beta/compute/addresses/create b/gcloud/beta/compute/addresses/create index 98358c9be..626bf5367 100644 --- a/gcloud/beta/compute/addresses/create +++ b/gcloud/beta/compute/addresses/create @@ -3,8 +3,9 @@ NAME SYNOPSIS gcloud beta compute addresses create [NAME ...] [--description=DESCRIPTION] - [--network=NETWORK] [--network-tier=NETWORK_TIER] - [--prefix-length=PREFIX_LENGTH] [--purpose=PURPOSE] [--subnet=SUBNET] + [--endpoint-type=ENDPOINT_TYPE] [--network=NETWORK] + [--network-tier=NETWORK_TIER] [--prefix-length=PREFIX_LENGTH] + [--purpose=PURPOSE] [--subnet=SUBNET] [--addresses=ADDRESS,[ADDRESS,...] | --ip-version=IP_VERSION] [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] @@ -71,6 +72,10 @@ FLAGS --description=DESCRIPTION An optional textual description for the addresses. + --endpoint-type=ENDPOINT_TYPE + The endpoint type of the external IPv6 address to be reserved. + ENDPOINT_TYPE must be one of: VM, NETLB. + --network=NETWORK If specified, the network resource in which the address(es) should be reserved. diff --git a/gcloud/beta/compute/backend-buckets/add-iam-policy-binding b/gcloud/beta/compute/backend-buckets/add-iam-policy-binding new file mode 100644 index 000000000..c528d659a --- /dev/null +++ b/gcloud/beta/compute/backend-buckets/add-iam-policy-binding @@ -0,0 +1,79 @@ +NAME + gcloud beta compute backend-buckets add-iam-policy-binding - add an IAM + policy binding to a Compute Engine backend bucket + +SYNOPSIS + gcloud beta compute backend-buckets add-iam-policy-binding BACKEND_BUCKET + --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Add an IAM policy binding to a Compute Engine backend bucket. + +EXAMPLES + To add an IAM policy binding for the role of + 'compute.loadBalancerServiceUser' for the user 'test-user@gmail.com' with + backend bucket 'my-backend-bucket' run: + + $ gcloud beta compute backend-buckets add-iam-policy-binding \ + my-backend-bucket --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket for which to add the IAM + policy 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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. + +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 compute/beta API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha compute backend-buckets add-iam-policy-binding + diff --git a/gcloud/beta/compute/backend-buckets/get-iam-policy b/gcloud/beta/compute/backend-buckets/get-iam-policy new file mode 100644 index 000000000..5abbe7af3 --- /dev/null +++ b/gcloud/beta/compute/backend-buckets/get-iam-policy @@ -0,0 +1,84 @@ +NAME + gcloud beta compute backend-buckets get-iam-policy - get the IAM policy for + a Compute Engine backend bucket + +SYNOPSIS + gcloud beta compute backend-buckets get-iam-policy BACKEND_BUCKET + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta compute backend-buckets get-iam-policy displays the IAM + policy associated with a Compute Engine backend bucket in a project. 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 $ {parent} + set-iam-policy for additional details. + +EXAMPLES + To print the IAM policy for a given backend bucket, run: + + $ gcloud beta compute backend-buckets get-iam-policy \ + my-backend-bucket + +POSITIONAL ARGUMENTS + Backend bucket resource - The network to display the IAM policy for. 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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. + +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 compute/beta API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha compute backend-buckets get-iam-policy + diff --git a/gcloud/beta/compute/backend-buckets/help b/gcloud/beta/compute/backend-buckets/help index abf4728dd..0bc01d30f 100644 --- a/gcloud/beta/compute/backend-buckets/help +++ b/gcloud/beta/compute/backend-buckets/help @@ -24,6 +24,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + add-iam-policy-binding + (BETA) Add an IAM policy binding to a Compute Engine backend bucket. + add-signed-url-key (BETA) Add Cloud CDN Signed URL key to a backend bucket. @@ -39,9 +42,19 @@ COMMANDS describe (BETA) Describe a backend bucket. + get-iam-policy + (BETA) Get the IAM policy for a Compute Engine backend bucket. + list (BETA) List Google Compute Engine backend buckets. + remove-iam-policy-binding + (BETA) Remove an IAM policy binding from a Compute Engine backend + bucket. + + set-iam-policy + (BETA) Set the IAM policy binding for a Compute Engine backend bucket. + update (BETA) Update a backend bucket. diff --git a/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding b/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding new file mode 100644 index 000000000..c3b3d8863 --- /dev/null +++ b/gcloud/beta/compute/backend-buckets/remove-iam-policy-binding @@ -0,0 +1,80 @@ +NAME + gcloud beta compute backend-buckets remove-iam-policy-binding - remove an + IAM policy binding from a Compute Engine backend bucket + +SYNOPSIS + gcloud beta compute backend-buckets remove-iam-policy-binding + BACKEND_BUCKET --member=PRINCIPAL --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Remove an IAM policy binding from a Compute Engine backend bucket. + +EXAMPLES + To remove an IAM policy binding for the role of + 'roles/compute.loadBalancerServiceUser' for the user 'test-user@gmail.com' + with backend bucket 'my-backend-bucket' run: + + $ gcloud beta compute backend-buckets remove-iam-policy-binding \ + my-backend-bucket --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket for which to remove the IAM + policy from. 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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. + +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 compute/beta API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha compute backend-buckets remove-iam-policy-binding + diff --git a/gcloud/beta/compute/backend-buckets/set-iam-policy b/gcloud/beta/compute/backend-buckets/set-iam-policy new file mode 100644 index 000000000..f90e9560e --- /dev/null +++ b/gcloud/beta/compute/backend-buckets/set-iam-policy @@ -0,0 +1,65 @@ +NAME + gcloud beta compute backend-buckets set-iam-policy - set the IAM policy + binding for a Compute Engine backend bucket + +SYNOPSIS + gcloud beta compute backend-buckets set-iam-policy BACKEND_BUCKET + POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Sets the IAM policy for the given backend bucket as defined in a + JSON or YAML file. + +EXAMPLES + The following command reads an IAM policy defined in a JSON file called + 'policy.json' and sets it for the backend bucket called + 'my-backend-bucket': + + $ gcloud beta compute backend-buckets set-iam-policy \ + my-backend-bucket policy.json + + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +POSITIONAL ARGUMENTS + Backend bucket resource - The backend bucket to set the IAM policy for. + 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 backend_bucket on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKEND_BUCKET + ID of the backend bucket or fully qualified identifier for the + backend bucket. To set the backend_bucket attribute: + ▸ provide the argument backend_bucket 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). + +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 compute/beta API. The full documentation for this API + can be found at: https://cloud.google.com/compute/ + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha compute backend-buckets set-iam-policy + diff --git a/gcloud/beta/compute/backend-services/add-iam-policy-binding b/gcloud/beta/compute/backend-services/add-iam-policy-binding index 45361be33..b3591024d 100644 --- a/gcloud/beta/compute/backend-services/add-iam-policy-binding +++ b/gcloud/beta/compute/backend-services/add-iam-policy-binding @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud beta compute backend-services add-iam-policy-binding - (BACKEND_SERVICE : --region=REGION) --member=PRINCIPAL --role=ROLE - [GCLOUD_WIDE_FLAG ...] + BACKEND_SERVICE_NAME --member=PRINCIPAL --role=ROLE + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Add an IAM policy binding to a Compute Engine backend service. @@ -16,41 +16,21 @@ EXAMPLES backend service 'my-backend-service' and region 'REGION', run: $ gcloud beta compute backend-services add-iam-policy-binding \ - my-backend-service --region=REGION \ - --member='user:test-user@gmail.com' \ - --role='roles/compute.loadBalancerServiceUser' + my-backend-service --region=REGION \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + $ gcloud beta compute backend-services add-iam-policy-binding \ + my-backend-service --global \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' See https://cloud.google.com/iam/docs/managing-policies for details of policy role and member types. POSITIONAL ARGUMENTS - Backend service resource - The backend service for which to add the IAM - policy to. 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. REQUIRED FLAGS --member=PRINCIPAL @@ -73,6 +53,16 @@ REQUIRED FLAGS for a custom role, such as organizations/{ORGANIZATION_ID}/roles/logging.viewer. +OPTIONAL FLAGS + At most one of these can be specified: + + --global + If set, the backend service is global. + + --region=REGION + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -81,10 +71,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/beta API. The full documentation for this API - can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/compute/backend-services/get-iam-policy b/gcloud/beta/compute/backend-services/get-iam-policy index 4258dec0d..41501fb5c 100644 --- a/gcloud/beta/compute/backend-services/get-iam-policy +++ b/gcloud/beta/compute/backend-services/get-iam-policy @@ -3,9 +3,9 @@ NAME for a Compute Engine backend service SYNOPSIS - gcloud beta compute backend-services get-iam-policy - (BACKEND_SERVICE : --region=REGION) [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + gcloud beta compute backend-services get-iam-policy BACKEND_SERVICE_NAME + [--global | --region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -22,33 +22,22 @@ EXAMPLES $ gcloud beta compute backend-services get-iam-policy \ my-backend-service --region=REGION + $ gcloud beta compute backend-services get-iam-policy \ + my-backend-service --global + POSITIONAL ARGUMENTS - Backend service resource - The network to display the IAM policy for. 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. - This must be specified. +FLAGS + At most one of these can be specified: - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. + --global + If set, the backend service is global. --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. LIST COMMAND FLAGS --filter=EXPRESSION @@ -76,6 +65,12 @@ LIST COMMAND FLAGS 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, @@ -84,10 +79,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/beta API. The full documentation for this API - can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/compute/backend-services/remove-iam-policy-binding b/gcloud/beta/compute/backend-services/remove-iam-policy-binding index d7962d0e2..2f6cda7d8 100644 --- a/gcloud/beta/compute/backend-services/remove-iam-policy-binding +++ b/gcloud/beta/compute/backend-services/remove-iam-policy-binding @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud beta compute backend-services remove-iam-policy-binding - (BACKEND_SERVICE : --region=REGION) --member=PRINCIPAL --role=ROLE - [GCLOUD_WIDE_FLAG ...] + BACKEND_SERVICE_NAME --member=PRINCIPAL --role=ROLE + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Remove an IAM policy binding from a Compute Engine backend service. @@ -16,41 +16,21 @@ EXAMPLES with backend service 'my-backend-service' and region 'REGION', run: $ gcloud beta compute backend-services remove-iam-policy-binding \ - my-backend-service --region=REGION \ - --member='user:test-user@gmail.com' \ - --role='roles/compute.loadBalancerServiceUser' + my-backend-service --region=REGION \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' + + $ gcloud beta compute backend-services remove-iam-policy-binding \ + my-backend-service --global \ + --member='user:test-user@gmail.com' \ + --role='roles/compute.loadBalancerServiceUser' See https://cloud.google.com/iam/docs/managing-policies for details of policy role and member types. POSITIONAL ARGUMENTS - Backend service resource - The backend service for which to remove the IAM - policy from. 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. REQUIRED FLAGS --member=PRINCIPAL @@ -74,6 +54,16 @@ REQUIRED FLAGS --role=ROLE The role to remove the principal from. +OPTIONAL FLAGS + At most one of these can be specified: + + --global + If set, the backend service is global. + + --region=REGION + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -82,10 +72,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/beta API. The full documentation for this API - can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/compute/backend-services/set-iam-policy b/gcloud/beta/compute/backend-services/set-iam-policy index 5afe403fb..48d9244a2 100644 --- a/gcloud/beta/compute/backend-services/set-iam-policy +++ b/gcloud/beta/compute/backend-services/set-iam-policy @@ -3,50 +3,29 @@ NAME binding for a Compute Engine backend service SYNOPSIS - gcloud beta compute backend-services set-iam-policy - (BACKEND_SERVICE : --region=REGION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] + gcloud beta compute backend-services set-iam-policy BACKEND_SERVICE_NAME + POLICY_FILE [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Sets the IAM policy for the given backend service as defined in a JSON or YAML file. EXAMPLES - The following command will read am IAM policy defined in a JSON file + The following command will read an IAM policy defined in a JSON file 'policy.json' and set it for the backend service my-backend-service: $ gcloud beta compute backend-services set-iam-policy \ my-backend-service policy.json --region=REGION + $ gcloud beta compute backend-services set-iam-policy \ + my-backend-service policy.json --global + See https://cloud.google.com/iam/docs/managing-policies for details of the policy file format and contents. POSITIONAL ARGUMENTS - Backend service resource - The backend service to set the IAM policy for. - 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 backend_service on the command line with a fully - specified name; - ◆ set the property core/project; - ◆ provide the argument --project on the command line. - - This must be specified. - - BACKEND_SERVICE - ID of the backend service or fully qualified identifier for the - backend service. To set the backend_service attribute: - ▸ provide the argument backend_service on the command line. - - This positional argument must be specified if any of the other - arguments in this group are specified. - - --region=REGION - The name of the Google Compute Engine region. To set the region - attribute: - ▸ provide the argument backend_service on the command line with a - fully specified name; - ▸ provide the argument --region on the command line; - ▸ set the property compute/region. + BACKEND_SERVICE_NAME + Name of the backend service to operate on. POLICY_FILE Path to a local JSON or YAML formatted file containing a valid policy. @@ -55,6 +34,16 @@ POSITIONAL ARGUMENTS JSON or YAML file conforming to the structure of a Policy (https://cloud.google.com/iam/reference/rest/v1/Policy). +FLAGS + At most one of these can be specified: + + --global + If set, the backend service is global. + + --region=REGION + Region of the backend service to operate on. Overrides the default + compute/region property value for this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, @@ -63,10 +52,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the compute/beta API. The full documentation for this API - can be found at: https://cloud.google.com/compute/ - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/compute/commitments/create b/gcloud/beta/compute/commitments/create index 30218d1d9..922abb77d 100644 --- a/gcloud/beta/compute/commitments/create +++ b/gcloud/beta/compute/commitments/create @@ -5,7 +5,9 @@ SYNOPSIS gcloud beta compute commitments create COMMITMENT --plan=PLAN (--resources=[local-ssd=LOCAL-SSD],[memory=MEMORY],[vcpu=VCPU] --resources-accelerator=[count=COUNT],[type=TYPE]) [--auto-renew] - [--region=REGION] [--type=TYPE; default="general-purpose"] + [--merge-source-commitments=MERGE_SOURCE_COMMITMENTS] [--region=REGION] + [--split-source-commitment=SPLIT_SOURCE_COMMITMENT] + [--type=TYPE; default="general-purpose"] [--reservations-from-file=RESERVATIONS_FROM_FILE | [--reservation=RESERVATION : --reservation-zone=RESERVATION_ZONE --accelerator=[count=COUNT],[type=TYPE] @@ -65,6 +67,10 @@ OPTIONAL FLAGS --auto-renew Enable auto renewal for the commitment. + --merge-source-commitments=MERGE_SOURCE_COMMITMENTS + Creates the new commitment by merging the specified source commitments + and combining their resources. + --region=REGION Region of the commitment to create. If not specified, you might be prompted to select a region (interactive mode only). @@ -85,6 +91,10 @@ OPTIONAL FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + --split-source-commitment=SPLIT_SOURCE_COMMITMENT + Creates the new commitment by splitting the specified source commitment + and redistributing the specified resources. + --type=TYPE; default="general-purpose" Type of commitment. memory-optimized indicates that the commitment is for memory-optimized VMs. TYPE must be one of: accelerator-optimized, diff --git a/gcloud/beta/compute/disks/create b/gcloud/beta/compute/disks/create index 25aced666..2bdd06b56 100644 --- a/gcloud/beta/compute/disks/create +++ b/gcloud/beta/compute/disks/create @@ -77,12 +77,11 @@ FLAGS https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot#--guest-flush --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - one of: GVNIC, MULTI_IP_SUBNET, SEV_CAPABLE, UEFI_COMPATIBLE, - VIRTIO_SCSI_MULTIQUEUE, WINDOWS. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be one of: GVNIC, MULTI_IP_SUBNET, SEV_CAPABLE, + SEV_SNP_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS. --interface=INTERFACE Specifies the disk interface to use for attaching this disk. Valid diff --git a/gcloud/beta/compute/firewall-policies/rules/create b/gcloud/beta/compute/firewall-policies/rules/create index d7b3dd0ad..1e25c06f4 100644 --- a/gcloud/beta/compute/firewall-policies/rules/create +++ b/gcloud/beta/compute/firewall-policies/rules/create @@ -57,8 +57,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if @@ -98,8 +97,7 @@ OPTIONAL FLAGS is ingress. --src-ip-ranges=[SRC_IP_RANGE,...] - Source IP ranges to match for this rule. Can only be specified if - DIRECTION is ingress. + Source IP ranges to match for this rule. --src-region-codes=[SOURCE_REGION_CODES,...] Source Region Code to match for this rule. Can only be specified if diff --git a/gcloud/beta/compute/firewall-policies/rules/update b/gcloud/beta/compute/firewall-policies/rules/update index 0c7806e9b..000faa7af 100644 --- a/gcloud/beta/compute/firewall-policies/rules/update +++ b/gcloud/beta/compute/firewall-policies/rules/update @@ -60,8 +60,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if @@ -104,8 +103,7 @@ OPTIONAL FLAGS is ingress. --src-ip-ranges=[SRC_IP_RANGE,...] - Source IP ranges to match for this rule. Can only be specified if - DIRECTION is ingress. + Source IP ranges to match for this rule. --src-region-codes=[SOURCE_REGION_CODES,...] Source Region Code to match for this rule. Can only be specified if diff --git a/gcloud/beta/compute/firewall-rules/create b/gcloud/beta/compute/firewall-rules/create index 0c3674a79..7f8434bb8 100644 --- a/gcloud/beta/compute/firewall-rules/create +++ b/gcloud/beta/compute/firewall-rules/create @@ -24,7 +24,7 @@ DESCRIPTION EXAMPLES To create a firewall rule allowing incoming TCP traffic on port 8080, run: - $ gcloud beta compute firewall-rules create FooService \ + $ gcloud beta compute firewall-rules create example-service \ --allow=tcp:8080 \ --description="Allow incoming traffic on TCP port 8080" \ --direction=INGRESS @@ -33,7 +33,7 @@ EXAMPLES determines a list of specific IP address blocks that are allowed to make inbound connections, run: - $ gcloud beta compute firewall-rules create "tcp-rule" \ + $ gcloud beta compute firewall-rules create tcp-rule \ --allow=tcp:80 --source-ranges="10.0.0.0/22,10.0.0.0/14" \ --description="Narrowing TCP traffic" diff --git a/gcloud/beta/compute/forwarding-rules/create b/gcloud/beta/compute/forwarding-rules/create index 63922dcf5..9e5b3590c 100644 --- a/gcloud/beta/compute/forwarding-rules/create +++ b/gcloud/beta/compute/forwarding-rules/create @@ -13,9 +13,10 @@ SYNOPSIS | --target-service-attachment=TARGET_SERVICE_ATTACHMENT | --target-ssl-proxy=TARGET_SSL_PROXY | --target-tcp-proxy=TARGET_TCP_PROXY - | --target-vpn-gateway=TARGET_VPN_GATEWAY) [--allow-global-access] - [--description=DESCRIPTION] [--disable-automate-dns-zone] - [--ip-protocol=IP_PROTOCOL] [--is-mirroring-collector] + | --target-vpn-gateway=TARGET_VPN_GATEWAY) [--address=ADDRESS] + [--allow-global-access] [--description=DESCRIPTION] + [--disable-automate-dns-zone] [--ip-protocol=IP_PROTOCOL] + [--ip-version=IP_VERSION] [--is-mirroring-collector] [--load-balancing-scheme=LOAD_BALANCING_SCHEME] [--network=NETWORK] [--network-tier=NETWORK_TIER] [--service-directory-registration=SERVICE_DIRECTORY_REGISTRATION] @@ -26,7 +27,6 @@ SYNOPSIS [--target-pool-region=TARGET_POOL_REGION] [--target-service-attachment-region=TARGET_SERVICE_ATTACHMENT_REGION] [--target-vpn-gateway-region=TARGET_VPN_GATEWAY_REGION] - [--address=ADDRESS | --ip-version=IP_VERSION] [--address-region=ADDRESS_REGION | --global-address] [--backend-service-region=BACKEND_SERVICE_REGION | --global-backend-service] [--global | --region=REGION] @@ -167,11 +167,37 @@ REQUIRED FLAGS forwarded traffic. Acceptable values for --ports flag are: 500, 4500. OPTIONAL FLAGS + --address=ADDRESS + The IP address that the forwarding rule serves. When a client sends + traffic to this IP address, the forwarding rule directs the traffic to + the target that you specify in the forwarding rule. + + If you don't specify a reserved IP address, an ephemeral IP address is + assigned. You can specify the IP address as a literal IP address or as + a reference to an existing Address resource. The following examples are + all valid: + ◆ 100.1.2.3 + ◆ 2600:1901::/96 + ◆ https://compute.googleapis.com/compute/v1/projects/project-1/regions/us-central1/addresses/address-1 + ◆ projects/project-1/regions/us-central1/addresses/address-1 + ◆ regions/us-central1/addresses/address-1 + ◆ global/addresses/address-1 + ◆ address-1 + + The load-balancing-scheme (EXTERNAL, EXTERNAL_MANAGED, INTERNAL, + INTERNAL_SELF_MANAGED, INTERNAL_MANAGED) and the target of the + forwarding rule determine the type of IP address that you can use. The + address type must be external for load-balancing-scheme EXTERNAL or + EXTERNAL_MANAGED. For other load-balancing-schemes, the address type + must be internal. For detailed information, refer to + https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications. + --allow-global-access If True, then clients from all regions can access this internal forwarding rule. This can only be specified for forwarding rules with - the LOAD_BALANCING_SCHEME set to INTERNAL and the target must be either - a backend service or a target instance. + the LOAD_BALANCING_SCHEME set to INTERNAL or INTERNAL_MANAGED. For + forwarding rules of type INTERNAL, the target must be either a backend + service or a target instance. --description=DESCRIPTION Optional textual description for the forwarding rule. @@ -194,6 +220,10 @@ OPTIONAL FLAGS IP_PROTOCOL must be one of: AH, ESP, ICMP, SCTP, TCP, UDP, L3_DEFAULT. + --ip-version=IP_VERSION + Version of the IP address to be allocated or assigned. The default is + IPv4. IP_VERSION must be one of: IPV4, IPV6. + --is-mirroring-collector If set, this forwarding rule can be used as a collector for packet mirroring. This can only be specified for forwarding rules with the @@ -302,36 +332,6 @@ OPTIONAL FLAGS is set to the region of the forwarding rule. Overrides the default compute/region property value for this command invocation. - At most one of these can be specified: - - --address=ADDRESS - IP address that the forwarding rule serves. When a client sends - traffic to this IP address, the forwarding rule directs the traffic - to the target that you specify in the forwarding rule. - - If you don't specify a reserved IP address, an ephemeral IP address - is assigned. You can specify the IP address as a literal IP address - or a reference to an existing Address resource. The following - examples are all valid: - ▸ 100.1.2.3 - ▸ https://compute.googleapis.com/compute/v1/projects/project-1/regions/us-central1/addresses/address-1 - ▸ projects/project-1/regions/us-central1/addresses/address-1 - ▸ regions/us-central1/addresses/address-1 - ▸ global/addresses/address-1 - ▸ address-1 - - The load-balancing-scheme (EXTERNAL, EXTERNAL_MANAGED, INTERNAL, - INTERNAL_SELF_MANAGED, INTERNAL_MANAGED) and the forwarding rule's - target determine the type of IP address that you can use. The address - type must be external for load-balancing-scheme EXTERNAL or - EXTERNAL_MANAGED, and for the other load-balancing-schemes the - address must be internal. For detailed information, refer to - https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications. - - --ip-version=IP_VERSION - Version of the IP address to be allocated if no --address is given. - The default is IPv4. IP_VERSION must be one of: IPV4, IPV6. - At most one of these can be specified: --address-region=ADDRESS_REGION diff --git a/gcloud/beta/compute/forwarding-rules/update b/gcloud/beta/compute/forwarding-rules/update index 392b4c32f..29d0ad3ff 100644 --- a/gcloud/beta/compute/forwarding-rules/update +++ b/gcloud/beta/compute/forwarding-rules/update @@ -43,8 +43,9 @@ FLAGS --allow-global-access If True, then clients from all regions can access this internal forwarding rule. This can only be specified for forwarding rules with - the LOAD_BALANCING_SCHEME set to INTERNAL and the target must be either - a backend service or a target instance. + the LOAD_BALANCING_SCHEME set to INTERNAL or INTERNAL_MANAGED. For + forwarding rules of type INTERNAL, the target must be either a backend + service or a target instance. --source-ip-ranges=SOURCE_IP_RANGE,[...] List of comma-separated IP addresses or IP ranges. If not empty, this diff --git a/gcloud/beta/compute/images/create b/gcloud/beta/compute/images/create index 0b95ffdb7..0a2b9f85c 100644 --- a/gcloud/beta/compute/images/create +++ b/gcloud/beta/compute/images/create @@ -148,12 +148,11 @@ OPTIONAL FLAGS Flag force-create is deprecated. Use --force instead. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - one of: GVNIC, MULTI_IP_SUBNET, SEV_CAPABLE, UEFI_COMPATIBLE, - VIRTIO_SCSI_MULTIQUEUE, WINDOWS. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be one of: GVNIC, MULTI_IP_SUBNET, SEV_CAPABLE, + SEV_SNP_CAPABLE, UEFI_COMPATIBLE, VIRTIO_SCSI_MULTIQUEUE, WINDOWS. --key-exchange-key-file=[KEK_VALUE,...] Comma-separated list of file paths that point to X.509 certificates in diff --git a/gcloud/beta/compute/images/import b/gcloud/beta/compute/images/import index efc40bb9b..9f41e2d1d 100644 --- a/gcloud/beta/compute/images/import +++ b/gcloud/beta/compute/images/import @@ -178,11 +178,11 @@ OPTIONAL FLAGS by default, use --no-guest-environment to disable. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - (currently only one value is supported): UEFI_COMPATIBLE. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be (currently only one value is supported): + UEFI_COMPATIBLE. --log-location=LOG_LOCATION Directory in Cloud Storage to hold build logs. If not set, @@ -255,15 +255,15 @@ OPTIONAL FLAGS Specifies the OS of the disk image being imported. OS must be one of: centos-7, debian-10, debian-11, debian-8, debian-9, opensuse-15, rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, - rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, - sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, - windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, - windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, - windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, - windows-2019, windows-2019-byol, windows-2022, windows-2022-byol, - windows-7-x64-byol, windows-7-x86-byol, windows-8-x64-byol, - windows-8-x86-byol. + rhel-9, rhel-9-byol, rocky-8, sles-12, sles-12-byol, sles-15, + sles-15-byol, sles-sap-12, sles-sap-12-byol, sles-sap-15, + sles-sap-15-byol, ubuntu-1404, ubuntu-1604, ubuntu-1804, ubuntu-2004, + ubuntu-2204, windows-10-x64-byol, windows-10-x86-byol, + windows-11-x64-byol, windows-2008r2, windows-2008r2-byol, + windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, + windows-2016, windows-2016-byol, windows-2019, windows-2019-byol, + windows-2022, windows-2022-byol, windows-7-x64-byol, + windows-7-x86-byol, windows-8-x64-byol, windows-8-x86-byol. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/compute/instance-groups/managed/abandon-instances b/gcloud/beta/compute/instance-groups/managed/abandon-instances index 5085d502a..fa86c5654 100644 --- a/gcloud/beta/compute/instance-groups/managed/abandon-instances +++ b/gcloud/beta/compute/instance-groups/managed/abandon-instances @@ -25,8 +25,8 @@ DESCRIPTION the zone from the instance name. For a more detailed overview of how abandoning instances from a managed - instance group works, refer to this section: - https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances#abandoning_instances + instance group works, see Abandoning instances from a MIG + (https://cloud.google.com/compute/docs/instance-groups/add-remove-vms-in-mig#abandoning_instances). POSITIONAL ARGUMENTS NAME diff --git a/gcloud/beta/compute/instance-groups/managed/create b/gcloud/beta/compute/instance-groups/managed/create index e20c48dd9..85edda580 100644 --- a/gcloud/beta/compute/instance-groups/managed/create +++ b/gcloud/beta/compute/instance-groups/managed/create @@ -5,8 +5,8 @@ NAME SYNOPSIS gcloud beta compute instance-groups managed create NAME --size=SIZE --template=TEMPLATE [--base-instance-name=BASE_INSTANCE_NAME] - [--description=DESCRIPTION] [--initial-delay=INITIAL_DELAY] - [--instance-redistribution-type=TYPE] + [--description=DESCRIPTION] [--[no-]force-update-on-repair] + [--initial-delay=INITIAL_DELAY] [--instance-redistribution-type=TYPE] [--list-managed-instances-results=MODE] [--stateful-disk=[auto-delete=AUTO-DELETE],[device-name=DEVICE-NAME]] [--stateful-external-ip=[enabled], @@ -52,6 +52,16 @@ OPTIONAL FLAGS --description=DESCRIPTION An optional description for this group. + --[no-]force-update-on-repair + Specifies whether to apply the group's latest configuration when + repairing a VM. If you updated the group's instance template or + per-instance configurations after the VM was created, then these + changes are applied when VM is repaired. If this flag is disabled with + -no-force-update-on-repair, then updates are applied in accordance with + the group's update policy type. By default, this flag is disabled. Use + --force-update-on-repair to enable and --no-force-update-on-repair to + disable. + --initial-delay=INITIAL_DELAY Specifies the length of time during which the instance is known to be initializing and should not be autohealed even if unhealthy. This value @@ -190,6 +200,13 @@ OPTIONAL FLAGS requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability. + any-single-zone + The group schedules all instances within a single zone. The zone is + chosen based on hardware support, current resources availability, + and matching reservations. The group might not be able to create + the requested number of VMs in case of zonal resource availability + constraints. Recommended for workloads requiring extensive + communication between VMs. balanced The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as diff --git a/gcloud/beta/compute/instance-groups/managed/update b/gcloud/beta/compute/instance-groups/managed/update index 3dc95cc9b..b352f0cea 100644 --- a/gcloud/beta/compute/instance-groups/managed/update +++ b/gcloud/beta/compute/instance-groups/managed/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta compute instance-groups managed update NAME - [--description=DESCRIPTION] [--instance-redistribution-type=TYPE] + [--description=DESCRIPTION] [--[no-]force-update-on-repair] + [--instance-redistribution-type=TYPE] [--list-managed-instances-results=MODE] [--remove-stateful-disks=DEVICE_NAME,[DEVICE_NAME,...]] [--remove-stateful-external-ips=INTERFACE_NAME,[...]] @@ -51,6 +52,16 @@ FLAGS An optional description for this group. To clear the description, set the value to an empty string. + --[no-]force-update-on-repair + Specifies whether to apply the group's latest configuration when + repairing a VM. If you updated the group's instance template or + per-instance configurations after the VM was created, then these + changes are applied when VM is repaired. If this flag is disabled with + -no-force-update-on-repair, then updates are applied in accordance with + the group's update policy type. By default, this flag is disabled. Use + --force-update-on-repair to enable and --no-force-update-on-repair to + disable. + --instance-redistribution-type=TYPE Specifies the type of the instance redistribution policy. An instance redistribution type lets you enable or disable automatic instance @@ -207,6 +218,13 @@ FLAGS requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability. + any-single-zone + The group schedules all instances within a single zone. The zone is + chosen based on hardware support, current resources availability, + and matching reservations. The group might not be able to create + the requested number of VMs in case of zonal resource availability + constraints. Recommended for workloads requiring extensive + communication between VMs. balanced The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as diff --git a/gcloud/beta/compute/instance-groups/managed/wait-until b/gcloud/beta/compute/instance-groups/managed/wait-until index d53fe759a..f82a71bda 100644 --- a/gcloud/beta/compute/instance-groups/managed/wait-until +++ b/gcloud/beta/compute/instance-groups/managed/wait-until @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta compute instance-groups managed wait-until NAME - (--stable | --version-target-reached) [--timeout=TIMEOUT] + (--all-instances-config-effective | --stable + | --version-target-reached) [--timeout=TIMEOUT] [--region=REGION | --zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -23,6 +24,10 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS Exactly one of these must be specified: + --all-instances-config-effective + Wait until the group's all-instances configuration is applied to all + VMs in the group. + --stable Wait until the group is stable. diff --git a/gcloud/beta/compute/instance-templates/create b/gcloud/beta/compute/instance-templates/create index 4c74d6d52..f02dbf2c7 100644 --- a/gcloud/beta/compute/instance-templates/create +++ b/gcloud/beta/compute/instance-templates/create @@ -14,12 +14,15 @@ SYNOPSIS [--disk=[auto-delete=AUTO-DELETE], [boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME]] [--[no-]enable-nested-virtualization] [--[no-]enable-uefi-networking] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] [--ipv6-network-tier=IPV6_NETWORK_TIER] [--key-revocation-action-type=POLICY] [--labels=[KEY=VALUE,...]] [--local-ssd=[device-name=DEVICE-NAME],[interface=INTERFACE]] [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] + [--max-run-duration=MAX_RUN_DURATION] [--mesh=[gke-cluster=GKE-CLUSTER],[workload=WORKLOAD]] [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--metadata-from-file=KEY=LOCAL_FILE_PATH,[...]] @@ -37,6 +40,7 @@ SYNOPSIS [--shielded-vtpm] [--source-instance=SOURCE_INSTANCE] [--source-instance-zone=SOURCE_INSTANCE_ZONE] [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--termination-time=TERMINATION_TIME] [--threads-per-core=THREADS_PER_CORE] [--visible-core-count=VISIBLE_CORE_COUNT] [--address=ADDRESS | --no-address] @@ -354,13 +358,25 @@ FLAGS --enable-uefi-networking to enable and --no-enable-uefi-networking to disable. + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS The timeout in seconds for host error detection. The value must be set with 30 second increments, with a range of 90 to 330 seconds. If unset, the default behavior of the host error recovery is used. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -427,6 +443,26 @@ FLAGS TERMINATE The instances should be terminated. + --max-run-duration=MAX_RUN_DURATION + Limits how long this VM instance can run, specified as a duration + relative to the VM instance's most-recent start time. Format the + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. + + If neither --max-run-duration nor --termination-time is specified + (default), the VM instance runs until prompted by a user action or + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. + --mesh=[gke-cluster=GKE-CLUSTER],[workload=WORKLOAD] Controls whether the Anthos Service Mesh service proxy (Envoy) and agent are installed and configured on the VM. "cloud-platform" scope is @@ -506,8 +542,10 @@ FLAGS Adds a network interface to the instance. Mutually exclusive with any of these flags: --address, --network, --network-tier, --subnet, --private-network-ip, --stack-type, --ipv6-network-tier, - --ipv6-public-ptr-domain. This flag can be repeated to specify multiple - network interfaces. + --ipv6-public-ptr-domain, --internal-ipv6-address, + --internal-ipv6-prefix-length, --ipv6-address, --ipv6-prefix-length, + --external-ipv6-address, --external-ipv6-prefix-length. This flag can + be repeated to specify multiple network interfaces. The following keys are allowed: address @@ -567,14 +605,18 @@ FLAGS --aliases="10.128.1.0/24;range1:/32" - Each IP alias range consists of a range name and an CIDR netmask - (e.g. `/24`) separated by a colon, or just the netmask. + Each IP alias range consists of a range name and a CIDR netmask + (e.g. `/24`) separated by a colon or just the netmask. The range name is the name of the range within the network interface's subnet from which to allocate an IP alias range. If unspecified, it defaults to the primary IP range of the subnet. The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -734,6 +776,22 @@ FLAGS $ gcloud compute instances list --filter='tags:tag1' + --termination-time=TERMINATION_TIME + Limits how long this VM instance can run, specified as a time. Format + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to + specify a duration, use --max-run-duration instead. + + If neither --termination-time nor --max-run-duration is specified + (default), the VM instance runs until prompted by a user action or + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. + --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. Valid values are: 1 or @@ -874,8 +932,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/beta/compute/instance-templates/create-with-container b/gcloud/beta/compute/instance-templates/create-with-container index ed30b5c80..253130b78 100644 --- a/gcloud/beta/compute/instance-templates/create-with-container +++ b/gcloud/beta/compute/instance-templates/create-with-container @@ -25,6 +25,8 @@ SYNOPSIS [--create-disk=[PROPERTY=VALUE,...]] [--description=DESCRIPTION] [--disk=[auto-delete=AUTO-DELETE], [boot=BOOT],[device-name=DEVICE-NAME],[mode=MODE],[name=NAME]] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--labels=[KEY=VALUE,...]] [--local-ssd=[device-name=DEVICE-NAME],[interface=INTERFACE]] [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] @@ -386,6 +388,16 @@ FLAGS the instance, this option won't apply. The default value for this is yes. + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -531,14 +543,18 @@ FLAGS --aliases="10.128.1.0/24;range1:/32" - Each IP alias range consists of a range name and an CIDR netmask - (e.g. `/24`) separated by a colon, or just the netmask. + Each IP alias range consists of a range name and a CIDR netmask + (e.g. `/24`) separated by a colon or just the netmask. The range name is the name of the range within the network interface's subnet from which to allocate an IP alias range. If unspecified, it defaults to the primary IP range of the subnet. The IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-tier=NETWORK_TIER Specifies the network tier that will be used to configure the instance. NETWORK_TIER must be one of: PREMIUM, STANDARD, FIXED_STANDARD. The diff --git a/gcloud/beta/compute/instances/bulk/create b/gcloud/beta/compute/instances/bulk/create index 2120bd0d2..bb4b5b8b2 100644 --- a/gcloud/beta/compute/instances/bulk/create +++ b/gcloud/beta/compute/instances/bulk/create @@ -22,6 +22,7 @@ SYNOPSIS [--labels=[KEY=VALUE,...]] [--local-ssd=[device-name=DEVICE-NAME],[interface=INTERFACE]] [--location-policy=[ZONE=POLICY,...]] [--machine-type=MACHINE_TYPE] + [--max-run-duration=MAX_RUN_DURATION] [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--metadata-from-file=KEY=LOCAL_FILE_PATH,[...]] [--min-count=MIN_COUNT] [--min-cpu-platform=PLATFORM] @@ -37,6 +38,7 @@ SYNOPSIS [--shielded-vtpm] [--source-instance-template=SOURCE_INSTANCE_TEMPLATE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] [--target-distribution-shape=SHAPE] + [--termination-time=TERMINATION_TIME] [--threads-per-core=THREADS_PER_CORE] [--visible-core-count=VISIBLE_CORE_COUNT] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY @@ -404,7 +406,9 @@ OPTIONAL FLAGS the default behavior of the host error recovery is used. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -453,6 +457,26 @@ OPTIONAL FLAGS available machine types, run 'gcloud compute machine-types list'. If unspecified, the default type is n1-standard-1. + --max-run-duration=MAX_RUN_DURATION + Limits how long this VM instance can run, specified as a duration + relative to the VM instance's most-recent start time. Format the + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. + + If neither --max-run-duration nor --termination-time is specified + (default), the VM instance runs until prompted by a user action or + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. + --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on the instances. Each metadata entry is a key/value pair separated by an @@ -675,6 +699,22 @@ OPTIONAL FLAGS to minimize the impact of zonal failures. Recommended for highly available serving or batch workloads. + --termination-time=TERMINATION_TIME + Limits how long this VM instance can run, specified as a time. Format + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to + specify a duration, use --max-run-duration instead. + + If neither --termination-time nor --max-run-duration is specified + (default), the VM instance runs until prompted by a user action or + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. + --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. Valid values are: 1 or diff --git a/gcloud/beta/compute/instances/create b/gcloud/beta/compute/instances/create index 6d2de6101..db679998b 100644 --- a/gcloud/beta/compute/instances/create +++ b/gcloud/beta/compute/instances/create @@ -16,6 +16,8 @@ SYNOPSIS [device-name=DEVICE-NAME],[mode=MODE],[name=NAME],[scope=SCOPE]] [--enable-display-device] [--[no-]enable-nested-virtualization] [--[no-]enable-uefi-networking] [--erase-windows-vss-signature] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--hostname=HOSTNAME] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] @@ -24,6 +26,7 @@ SYNOPSIS [--key-revocation-action-type=POLICY] [--labels=[KEY=VALUE,...]] [--local-ssd=[device-name=DEVICE-NAME],[interface=INTERFACE]] [--machine-type=MACHINE_TYPE] [--maintenance-policy=MAINTENANCE_POLICY] + [--max-run-duration=MAX_RUN_DURATION] [--metadata=KEY=VALUE,[KEY=VALUE,...]] [--metadata-from-file=KEY=LOCAL_FILE_PATH,[...]] [--min-cpu-platform=PLATFORM] [--min-node-cpu=MIN_NODE_CPU] @@ -42,6 +45,7 @@ SYNOPSIS [--source-machine-image=SOURCE_MACHINE_IMAGE] [--source-machine-image-csek-key-file=FILE] [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--termination-time=TERMINATION_TIME] [--threads-per-core=THREADS_PER_CORE] [--visible-core-count=VISIBLE_CORE_COUNT] [--zone=ZONE] [--address=ADDRESS | --no-address] @@ -106,7 +110,7 @@ EXAMPLES --zone=central2-a --shielded-secure-boot --shielded-vtpm \ --shielded-integrity-monitoring - To create an preemptible instance called 'instance-1', run: + To create a preemptible instance called 'instance-1', run: $ gcloud beta compute instances create instance-1 \ --machine-type=n1-standard-1 --zone=us-central1-b \ @@ -407,6 +411,16 @@ FLAGS machine image should erase Windows specific VSS signature. See https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot#--guest-flush + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS The timeout in seconds for host error detection. The value must be set with 30 second increments, with a range of 90 to 330 seconds. If unset, @@ -420,7 +434,9 @@ FLAGS using zonal DNS. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -493,6 +509,26 @@ FLAGS TERMINATE The instances should be terminated. + --max-run-duration=MAX_RUN_DURATION + Limits how long this VM instance can run, specified as a duration + relative to the VM instance's most-recent start time. Format the + duration, MAX_RUN_DURATION, as the number of days, hours, minutes, and + seconds followed by d, h, m, and s respectively. For example, specify + 30m for a duration of 30 minutes or specify 1d2h3m4s for a duration of + 1 day, 2 hours, 3 minutes, and 4 seconds. Alternatively, to specify a + timestamp, use --termination-time instead. + + If neither --max-run-duration nor --termination-time is specified + (default), the VM instance runs until prompted by a user action or + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --max-run-duration, the VM instance + is automatically terminated when the VM's current runtime reaches + MAX_RUN_DURATION. Note: Anytime the VM instance is stopped or + suspended, --max-run-duration and (unless the VM uses + --provisioning-model=SPOT) --instance-termination-action are + automatically removed from the VM. + --metadata=KEY=VALUE,[KEY=VALUE,...] Metadata to be made available to the guest operating system running on the instances. Each metadata entry is a key/value pair separated by an @@ -557,8 +593,10 @@ FLAGS Adds a network interface to the instance. Mutually exclusive with any of these flags: --address, --network, --network-tier, --subnet, --private-network-ip, --stack-type, --ipv6-network-tier, - --ipv6-public-ptr-domain. This flag can be repeated to specify multiple - network interfaces. + --ipv6-public-ptr-domain, --internal-ipv6-address, + --internal-ipv6-prefix-length, --ipv6-address, --ipv6-prefix-length, + --external-ipv6-address, --external-ipv6-prefix-length. This flag can + be repeated to specify multiple network interfaces. The following keys are allowed: address @@ -631,6 +669,10 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network @@ -790,6 +832,22 @@ FLAGS $ gcloud compute instances list --filter='tags:tag1' + --termination-time=TERMINATION_TIME + Limits how long this VM instance can run, specified as a time. Format + the time, TERMINATION_TIME, as a RFC 3339 timestamp. For more + information, see https://tools.ietf.org/html/rfc3339. Alternatively, to + specify a duration, use --max-run-duration instead. + + If neither --termination-time nor --max-run-duration is specified + (default), the VM instance runs until prompted by a user action or + system event. If either is specified, the VM instance is scheduled to + be automatically terminated using the action specified by + --instance-termination-action. For --termination-time, the VM instance + is automatically terminated at the specified timestamp. Note: Anytime + the VM instance is stopped or suspended, --termination-time and (unless + the VM uses --provisioning-model=SPOT) --instance-termination-action + are automatically removed from the VM. + --threads-per-core=THREADS_PER_CORE The number of visible threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. Valid values are: 1 or @@ -968,8 +1026,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/beta/compute/instances/create-with-container b/gcloud/beta/compute/instances/create-with-container index 5b4f6e54f..cc2cf062f 100644 --- a/gcloud/beta/compute/instances/create-with-container +++ b/gcloud/beta/compute/instances/create-with-container @@ -26,6 +26,8 @@ SYNOPSIS [--disk=[auto-delete=AUTO-DELETE],[boot=BOOT], [device-name=DEVICE-NAME],[mode=MODE],[name=NAME],[scope=SCOPE]] [--[no-]enable-nested-virtualization] + [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] [--host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] [--labels=[KEY=VALUE,...]] @@ -406,13 +408,25 @@ FLAGS --enable-nested-virtualization to enable and --no-enable-nested-virtualization to disable. + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to the instance that is + created. The address must be the first IP address in the range. This + option can be used only when creating a single instance. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This field should + be used together with --external-ipv6-address. Only the /96 IP address + range is supported, and the default value is 96. + --host-error-timeout-seconds=HOST_ERROR_TIMEOUT_SECONDS The timeout in seconds for host error detection. The value must be set with 30 second increments, with a range of 90 to 330 seconds. If unset, the default behavior of the host error recovery is used. --instance-termination-action=INSTANCE_TERMINATION_ACTION - Specifies the termination action that will be taken upon VM preemption. + Specifies the termination action that will be taken upon VM preemption + (--provisioning-model=SPOT or --preemptible) or automatic instance + termination (--max-run-duration or --termination-time). INSTANCE_TERMINATION_ACTION must be one of: DELETE @@ -579,6 +593,10 @@ FLAGS IP allocator will pick an available range with the specified netmask and allocate it to this network interface. + network-attachment + Specifies the network attachment that this interface should connect + to. Mutually exclusive with --network and --subnet flags. + --network-performance-configs=[PROPERTY=VALUE,...] Configures network performance settings for the instance. If this flag is not specified, the instance will be created with its default network diff --git a/gcloud/beta/compute/instances/delete b/gcloud/beta/compute/instances/delete index 8b8ccfa4e..8b2ec87ea 100644 --- a/gcloud/beta/compute/instances/delete +++ b/gcloud/beta/compute/instances/delete @@ -56,8 +56,9 @@ FLAGS disks' auto-delete configuration. When this flag is provided, the auto-delete bits on the attached disks are modified accordingly before the instance deletion requests are issued. For more - information on disk auto-deletion, see - https://cloud.google.com/compute/docs/disks/persistent-disks#updateautodelete. + information on disk auto-deletion, see Set the auto-delete state of a + zonal persistent disk + (https://cloud.google.com/compute/docs/disks/modify-persistent-disk#updateautodelete). DISK_TYPE must be one of: all @@ -72,8 +73,9 @@ FLAGS the disks' auto-delete configuration. When this flag is provided, the auto-delete bits on the attached disks are modified accordingly before the instance deletion requests are issued. For more - information on disk auto-deletion, see - https://cloud.google.com/compute/docs/disks/persistent-disks#updateautodelete. + information on disk auto-deletion, see Set the auto-delete state of a + zonal persistent disk + (https://cloud.google.com/compute/docs/disks/modify-persistent-disk#updateautodelete). DISK_TYPE must be one of: all diff --git a/gcloud/beta/compute/instances/import b/gcloud/beta/compute/instances/import index 86dbea12d..9a1d8f0af 100644 --- a/gcloud/beta/compute/instances/import +++ b/gcloud/beta/compute/instances/import @@ -121,11 +121,11 @@ OPTIONAL FLAGS default, use --no-guest-environment to disable. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - (currently only one value is supported): UEFI_COMPATIBLE. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be (currently only one value is supported): + UEFI_COMPATIBLE. --hostname=HOSTNAME Specify the hostname of the VM instance to be imported. The specified @@ -166,10 +166,10 @@ OPTIONAL FLAGS --os=OS Specifies the OS of the image being imported. OS must be one of: centos-7, debian-10, debian-11, debian-8, debian-9, opensuse-15, - rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, - sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, - sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rhel-9, + rhel-9-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, + sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, + ubuntu-1404, ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, @@ -279,8 +279,10 @@ OPTIONAL FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/beta/compute/instances/network-interfaces/update b/gcloud/beta/compute/instances/network-interfaces/update index 7f49ea91b..2379ee295 100644 --- a/gcloud/beta/compute/instances/network-interfaces/update +++ b/gcloud/beta/compute/instances/network-interfaces/update @@ -4,8 +4,9 @@ NAME SYNOPSIS gcloud beta compute instances network-interfaces update INSTANCE_NAME - [--aliases=ALIASES] [--ipv6-network-tier=IPV6_NETWORK_TIER] - [--network=NETWORK] + [--aliases=ALIASES] [--external-ipv6-address=EXTERNAL_IPV6_ADDRESS] + [--external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH] + [--ipv6-network-tier=IPV6_NETWORK_TIER] [--network=NETWORK] [--network-interface=NETWORK_INTERFACE; default="nic0"] [--private-network-ip=PRIVATE_NETWORK_IP] [--stack-type=STACK_TYPE] [--subnetwork=SUBNETWORK] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] @@ -42,6 +43,16 @@ FLAGS --aliases="10.128.1.0/24;r1:/32" + --external-ipv6-address=EXTERNAL_IPV6_ADDRESS + Assigns the given external IPv6 address to an instance. The address + must be the first IP in the range. This option is applicable only to + dual-stack instances with stack-type=IPV4_ONLY. + + --external-ipv6-prefix-length=EXTERNAL_IPV6_PREFIX_LENGTH + The prefix length of the external IPv6 address range. This flag should + be used together with --external-ipv6-address. Currently only /96 is + supported and the default value is 96. + --ipv6-network-tier=IPV6_NETWORK_TIER Specifies the IPv6 network tier that will be used to configure the instance network interface IPv6 access config. IPV6_NETWORK_TIER must diff --git a/gcloud/beta/compute/instances/set-scheduling b/gcloud/beta/compute/instances/set-scheduling index 30a1bcffd..a844e3d1f 100644 --- a/gcloud/beta/compute/instances/set-scheduling +++ b/gcloud/beta/compute/instances/set-scheduling @@ -125,7 +125,9 @@ FLAGS --instance-termination-action=INSTANCE_TERMINATION_ACTION Specifies the termination action that will be taken upon VM - preemption. INSTANCE_TERMINATION_ACTION must be one of: + preemption (--provisioning-model=SPOT or --preemptible) or automatic + instance termination (--max-run-duration or --termination-time). + INSTANCE_TERMINATION_ACTION must be one of: DELETE Permanently delete the VM. @@ -151,8 +153,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/beta/compute/instances/stop b/gcloud/beta/compute/instances/stop index 2a03bb468..72141989a 100644 --- a/gcloud/beta/compute/instances/stop +++ b/gcloud/beta/compute/instances/stop @@ -3,20 +3,29 @@ NAME SYNOPSIS gcloud beta compute instances stop INSTANCE_NAMES [INSTANCE_NAMES ...] - [--async] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--async] [--discard-local-ssd[=DISCARD_LOCAL_SSD]] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute instances stop is used to stop a Compute Engine virtual machine. Stopping a VM performs a clean shutdown, much like invoking the shutdown functionality of a workstation or laptop. Stopping a - VM with a local SSD is not supported and will result in an API error. - Stopping a VM which is already stopped will return without errors. + VM with a local SSD is not supported and will result in an API error unless + the --discard-local-ssd flag is passed. Stopping a VM which is already + stopped will return without errors. EXAMPLES To stop an instance named test-instance, run: $ gcloud beta compute instances stop test-instance + To stop an instance named test-instance that has a Local SSD, run: + + $ gcloud beta compute instances stop test-instance \ + --discard-local-ssd=True + + Using '--discard-local-ssd' without a value defaults to True. + POSITIONAL ARGUMENTS INSTANCE_NAMES [INSTANCE_NAMES ...] Names of the instances to operate on. For details on valid instance @@ -28,6 +37,9 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --discard-local-ssd[=DISCARD_LOCAL_SSD] + If set to true, local SSD data is discarded. + --zone=ZONE Zone of the instances to operate on. If not specified, you might be prompted to select a zone (interactive mode only). gcloud attempts to diff --git a/gcloud/beta/compute/instances/suspend b/gcloud/beta/compute/instances/suspend index edf5bba01..bea17bc71 100644 --- a/gcloud/beta/compute/instances/suspend +++ b/gcloud/beta/compute/instances/suspend @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud beta compute instances suspend INSTANCE_NAMES [INSTANCE_NAMES ...] - [--async] [--discard-local-ssd] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--async] [--discard-local-ssd[=DISCARD_LOCAL_SSD]] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute instances suspend is used to suspend a Compute @@ -24,6 +25,13 @@ EXAMPLES $ gcloud beta compute instances suspend test-instance + To suspend an instance named test-instance that has a Local SSD, run: + + $ gcloud beta compute instances suspend test-instance \ + --discard-local-ssd=True + + Using '--discard-local-ssd' without a value defaults to True. + POSITIONAL ARGUMENTS INSTANCE_NAMES [INSTANCE_NAMES ...] Names of the instances to operate on. For details on valid instance @@ -35,8 +43,8 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --discard-local-ssd - If provided, local SSD data is discarded. + --discard-local-ssd[=DISCARD_LOCAL_SSD] + If set to true, local SSD data is discarded. --zone=ZONE Zone of the instances to operate on. If not specified, you might be diff --git a/gcloud/beta/compute/instances/update b/gcloud/beta/compute/instances/update index 506e0d2b8..2aa0777dd 100644 --- a/gcloud/beta/compute/instances/update +++ b/gcloud/beta/compute/instances/update @@ -180,8 +180,10 @@ FLAGS according to their node affinity labels. A node's affinity labels come from the node template of the group the node is in. - The file should contain a list of a JSON/YAML objects with the - following fields: + The file should contain a list of a JSON/YAML objects. For an + example, see + https://cloud.google.com/compute/docs/nodes/provisioning-sole-tenant-vms#configure_node_affinity_labels. + The following list describes the fields: key Corresponds to the node affinity label keys of the Node resource. diff --git a/gcloud/beta/compute/instances/update-access-config b/gcloud/beta/compute/instances/update-access-config index f6099c360..cee35eb1c 100644 --- a/gcloud/beta/compute/instances/update-access-config +++ b/gcloud/beta/compute/instances/update-access-config @@ -14,13 +14,22 @@ SYNOPSIS DESCRIPTION (BETA) gcloud beta compute instances update-access-config is used to update access configurations for network interfaces of Compute Engine virtual - machines. + machines. IPv4 and IPv6 access configurations cannot be updated together. EXAMPLES - To update network interface of an instance to 'nic0', run: + To update public PTR record in IPv4 access config in network interface + 'nic0' of an instance, run: $ gcloud beta compute instances update-access-config \ - example-instance --network-interface=nic0 --zone=us-central1-b + example-instance --network-interface=nic0 --zone=us-central1-b \ + --public-ptr --public-ptr-domain=exampledomain.com. + + To update public PTR record in IPv6 access config in default network + interface 'nic0' of an instance, run: + + $ gcloud beta compute instances update-access-config \ + example-instance --zone=us-central1-b \ + --ipv6-public-ptr-domain=exampledomain.com. POSITIONAL ARGUMENTS INSTANCE_NAME diff --git a/gcloud/beta/compute/machine-images/import b/gcloud/beta/compute/machine-images/import index 97b5689ce..4c804f500 100644 --- a/gcloud/beta/compute/machine-images/import +++ b/gcloud/beta/compute/machine-images/import @@ -121,11 +121,11 @@ OPTIONAL FLAGS prepare for the snapshot process. --guest-os-features=[GUEST_OS_FEATURE,...] - This parameter enables one or more features for VM instances that use - the image for their boot disks. See - https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features - for descriptions of the supported features. GUEST_OS_FEATURE must be - (currently only one value is supported): UEFI_COMPATIBLE. + Enables one or more features for VM instances that use the image for + their boot disks. See the descriptions of supported features at: + https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features. + GUEST_OS_FEATURE must be (currently only one value is supported): + UEFI_COMPATIBLE. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. @@ -159,10 +159,10 @@ OPTIONAL FLAGS --os=OS Specifies the OS of the machine image being imported. OS must be one of: centos-7, debian-10, debian-11, debian-8, debian-9, opensuse-15, - rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rocky-8, - sles-12, sles-12-byol, sles-15, sles-15-byol, sles-sap-12, - sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, ubuntu-1404, - ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, + rhel-6, rhel-6-byol, rhel-7, rhel-7-byol, rhel-8, rhel-8-byol, rhel-9, + rhel-9-byol, rocky-8, sles-12, sles-12-byol, sles-15, sles-15-byol, + sles-sap-12, sles-sap-12-byol, sles-sap-15, sles-sap-15-byol, + ubuntu-1404, ubuntu-1604, ubuntu-1804, ubuntu-2004, ubuntu-2204, windows-10-x64-byol, windows-10-x86-byol, windows-11-x64-byol, windows-2008r2, windows-2008r2-byol, windows-2012, windows-2012-byol, windows-2012r2, windows-2012r2-byol, windows-2016, windows-2016-byol, diff --git a/gcloud/beta/compute/network-edge-security-services/create b/gcloud/beta/compute/network-edge-security-services/create index 344c58d72..110faca0b 100644 --- a/gcloud/beta/compute/network-edge-security-services/create +++ b/gcloud/beta/compute/network-edge-security-services/create @@ -6,8 +6,7 @@ SYNOPSIS gcloud beta compute network-edge-security-services create NAME [--description=DESCRIPTION] [--region=REGION] [--security-policy=SECURITY_POLICY] - [--global-security-policy - | --security-policy-region=SECURITY_POLICY_REGION] + [--security-policy-region=SECURITY_POLICY_REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -44,14 +43,9 @@ FLAGS service. To remove the policy from this network edge security service set the policy to an empty string. - At most one of these can be specified: - - --global-security-policy - If set, the security policy is global. - - --security-policy-region=SECURITY_POLICY_REGION - Region of the security policy to operate on. Overrides the default - compute/region property value for this command invocation. + --security-policy-region=SECURITY_POLICY_REGION + Region of the security policy to operate on. Overrides the default + compute/region property value for this command invocation. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -62,8 +56,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-edge-security-services create $ gcloud alpha compute network-edge-security-services create diff --git a/gcloud/beta/compute/network-edge-security-services/delete b/gcloud/beta/compute/network-edge-security-services/delete index 6238ff955..69d8379ca 100644 --- a/gcloud/beta/compute/network-edge-security-services/delete +++ b/gcloud/beta/compute/network-edge-security-services/delete @@ -35,8 +35,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-edge-security-services delete $ gcloud alpha compute network-edge-security-services delete diff --git a/gcloud/beta/compute/network-edge-security-services/describe b/gcloud/beta/compute/network-edge-security-services/describe index 7ecca788f..b5114a31d 100644 --- a/gcloud/beta/compute/network-edge-security-services/describe +++ b/gcloud/beta/compute/network-edge-security-services/describe @@ -36,8 +36,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-edge-security-services describe $ gcloud alpha compute network-edge-security-services describe diff --git a/gcloud/beta/compute/network-edge-security-services/help b/gcloud/beta/compute/network-edge-security-services/help index 92e01ed63..1498f9e19 100644 --- a/gcloud/beta/compute/network-edge-security-services/help +++ b/gcloud/beta/compute/network-edge-security-services/help @@ -40,8 +40,10 @@ COMMANDS (BETA) Update a network edge security service. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-edge-security-services $ gcloud alpha compute network-edge-security-services diff --git a/gcloud/beta/compute/network-edge-security-services/list b/gcloud/beta/compute/network-edge-security-services/list index 75fedea61..f070e7fba 100644 --- a/gcloud/beta/compute/network-edge-security-services/list +++ b/gcloud/beta/compute/network-edge-security-services/list @@ -71,8 +71,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-edge-security-services list $ gcloud alpha compute network-edge-security-services list diff --git a/gcloud/beta/compute/network-edge-security-services/update b/gcloud/beta/compute/network-edge-security-services/update index 346fe3efa..c83d5c8ba 100644 --- a/gcloud/beta/compute/network-edge-security-services/update +++ b/gcloud/beta/compute/network-edge-security-services/update @@ -6,8 +6,7 @@ SYNOPSIS gcloud beta compute network-edge-security-services update NAME [--description=DESCRIPTION] [--region=REGION] [--security-policy=SECURITY_POLICY] - [--global-security-policy - | --security-policy-region=SECURITY_POLICY_REGION] + [--security-policy-region=SECURITY_POLICY_REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -44,14 +43,9 @@ FLAGS service. To remove the policy from this network edge security service set the policy to an empty string. - At most one of these can be specified: - - --global-security-policy - If set, the security policy is global. - - --security-policy-region=SECURITY_POLICY_REGION - Region of the security policy to operate on. Overrides the default - compute/region property value for this command invocation. + --security-policy-region=SECURITY_POLICY_REGION + Region of the security policy to operate on. Overrides the default + compute/region property value for this command invocation. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, @@ -62,8 +56,10 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud compute network-edge-security-services update $ gcloud alpha compute network-edge-security-services update diff --git a/gcloud/beta/compute/network-firewall-policies/rules/create b/gcloud/beta/compute/network-firewall-policies/rules/create index 893db9bb4..09020e23b 100644 --- a/gcloud/beta/compute/network-firewall-policies/rules/create +++ b/gcloud/beta/compute/network-firewall-policies/rules/create @@ -67,8 +67,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if diff --git a/gcloud/beta/compute/network-firewall-policies/rules/update b/gcloud/beta/compute/network-firewall-policies/rules/update index e5e0e98e7..078bdfcad 100644 --- a/gcloud/beta/compute/network-firewall-policies/rules/update +++ b/gcloud/beta/compute/network-firewall-policies/rules/update @@ -60,8 +60,7 @@ OPTIONAL FLAGS is egress. --dest-ip-ranges=[DEST_IP_RANGE,...] - Destination IP ranges to match for this rule. Can only be specified if - DIRECTION is egress. + Destination IP ranges to match for this rule. --dest-region-codes=[DEST_REGION_CODES,...] Dest Region Code to match for this rule. Can only be specified if diff --git a/gcloud/beta/compute/networks/subnets/create b/gcloud/beta/compute/networks/subnets/create index 6bedd3057..97e5d4e70 100644 --- a/gcloud/beta/compute/networks/subnets/create +++ b/gcloud/beta/compute/networks/subnets/create @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta compute networks subnets create NAME --network=NETWORK - --range=RANGE [--description=DESCRIPTION] [--enable-flow-logs] + [--description=DESCRIPTION] [--enable-flow-logs] [--enable-private-ip-google-access] [--ipv6-access-type=IPV6_ACCESS_TYPE] [--logging-aggregation-interval=LOGGING_AGGREGATION_INTERVAL] @@ -13,9 +13,11 @@ SYNOPSIS [--logging-metadata=LOGGING_METADATA] [--logging-metadata-fields=[METADATA_FIELD,...]] [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] - [--purpose=PURPOSE] [--region=REGION] [--role=ROLE] - [--secondary-range=PROPERTY=VALUE,[...]] [--stack-type=STACK_TYPE] - [GCLOUD_WIDE_FLAG ...] + [--purpose=PURPOSE] [--range=RANGE] [--region=REGION] + [--reserved-internal-range=RESERVED_INTERNAL_RANGE] [--role=ROLE] + [--secondary-range=PROPERTY=VALUE,[...]] + [--secondary-range-with-reserved-internal-range=RANGE_NAME=INTERNAL_RANGE_URL, + [...]] [--stack-type=STACK_TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute networks subnets create define a subnetwork for @@ -36,9 +38,6 @@ REQUIRED FLAGS --network=NETWORK The network to which the subnetwork belongs. - --range=RANGE - The IP space allocated to this subnetwork in CIDR format. - OPTIONAL FLAGS --description=DESCRIPTION An optional description of this subnetwork. @@ -111,6 +110,9 @@ OPTIONAL FLAGS REGIONAL_MANAGED_PROXY Reserved for Regional HTTP(S) Load Balancing. + --range=RANGE + The IP space allocated to this subnetwork in CIDR format. + --region=REGION Region of the subnetwork to create. If not specified, you might be prompted to select a region (interactive mode only). @@ -131,6 +133,23 @@ OPTIONAL FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + --reserved-internal-range=RESERVED_INTERNAL_RANGE + If set, the primary IP range of the subnetwork will be associated with + the given InternalRange resource. + + If --range is set, the subnetwork will only use the given IP range. It + has to be contained by the IP range defined by the InternalRange + resource. + + For example, --range=10.0.0.0/24 --reserved-internal-range + //networkconnectivity.googleapis.com/projects/PROJECT/locations/global/internalRanges/RANGE + + If --range is not set, the subnetwork will use the entire IP range + defined by the InternalRange resource. + + For example, --reserved-internal-range + //networkconnectivity.googleapis.com/projects/PROJECT/locations/global/internalRanges/RANGE + --role=ROLE The role of subnetwork. This field is required when the purpose is set to REGIONAL_MANAGED_PROXY or INTERNAL_HTTPS_LOAD_BALANCER. ROLE must be @@ -150,6 +169,17 @@ OPTIONAL FLAGS ◆ RANGE_NAME - Name of the secondary range. ◆ RANGE - IP range in CIDR format. + --secondary-range-with-reserved-internal-range=RANGE_NAME=INTERNAL_RANGE_URL,[...] + Adds secondary IP ranges that are associated with InternalRange + resources. + + For example, --secondary-range-with-reserved-internal-range + range1=//networkconnectivity.googleapis.com/projects/PROJECT/locations/global/internalRanges/RANGE + adds a secondary range with the reserved internal range resource. + + ◆ RANGE_NAME - Name of the secondary range. + ◆ INTERNAL_RANGE_URL - URL of an InternalRange resource. + --stack-type=STACK_TYPE The stack type for this subnet. Determines if IPv6 is enabled on the subnet. If not specified IPV4_ONLY will be used. STACK_TYPE must be one diff --git a/gcloud/beta/compute/networks/subnets/update b/gcloud/beta/compute/networks/subnets/update index 75e3d04fb..7a1671153 100644 --- a/gcloud/beta/compute/networks/subnets/update +++ b/gcloud/beta/compute/networks/subnets/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta compute networks subnets update NAME - [--drain-timeout=DRAIN_TIMEOUT; default="0s"] + [--add-secondary-ranges-with-reserved-internal-range=RANGE_NAME=INTERNAL_RANGE_URL, + [...]] [--drain-timeout=DRAIN_TIMEOUT; default="0s"] [--ipv6-access-type=IPV6_ACCESS_TYPE] [--logging-aggregation-interval=LOGGING_AGGREGATION_INTERVAL] [--logging-filter-expr=LOGGING_FILTER_EXPR] @@ -35,6 +36,17 @@ POSITIONAL ARGUMENTS Name of the subnetwork to update. FLAGS + --add-secondary-ranges-with-reserved-internal-range=RANGE_NAME=INTERNAL_RANGE_URL,[...] + Adds secondary IP ranges that are associated with InternalRange + resources. + + For example, --add-secondary-ranges-with-reserved-internal-range + range1=//networkconnectivity.googleapis.com/projects/PROJECT/locations/global/internalRanges/RANGE + adds a secondary range with the reserved internal range resource. + + ◆ RANGE_NAME - Name of the secondary range. + ◆ INTERNAL_RANGE_URL - URL of an InternalRange resource. + --drain-timeout=DRAIN_TIMEOUT; default="0s" The time period for draining traffic from Internal HTTP(S) Load Balancer proxies that are assigned addresses in the current ACTIVE diff --git a/gcloud/beta/compute/networks/vpc-access/connectors/create b/gcloud/beta/compute/networks/vpc-access/connectors/create index 0e2462c72..19dafeb65 100644 --- a/gcloud/beta/compute/networks/vpc-access/connectors/create +++ b/gcloud/beta/compute/networks/vpc-access/connectors/create @@ -140,7 +140,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/networks/vpc-access/connectors/delete b/gcloud/beta/compute/networks/vpc-access/connectors/delete index d82fbeb05..7f1c46566 100644 --- a/gcloud/beta/compute/networks/vpc-access/connectors/delete +++ b/gcloud/beta/compute/networks/vpc-access/connectors/delete @@ -64,7 +64,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/networks/vpc-access/connectors/describe b/gcloud/beta/compute/networks/vpc-access/connectors/describe index 96dc628f0..c6ae65895 100644 --- a/gcloud/beta/compute/networks/vpc-access/connectors/describe +++ b/gcloud/beta/compute/networks/vpc-access/connectors/describe @@ -60,7 +60,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/networks/vpc-access/connectors/help b/gcloud/beta/compute/networks/vpc-access/connectors/help index 1127dd34a..b31f5e873 100644 --- a/gcloud/beta/compute/networks/vpc-access/connectors/help +++ b/gcloud/beta/compute/networks/vpc-access/connectors/help @@ -29,6 +29,9 @@ COMMANDS list (BETA) List VPC Access connectors. + update + (BETA) Update a VPC Access connector. + NOTES This command is currently in beta and might change without notice. This variant is also available: diff --git a/gcloud/beta/compute/networks/vpc-access/connectors/list b/gcloud/beta/compute/networks/vpc-access/connectors/list index 0d8adfd1a..ffe225b36 100644 --- a/gcloud/beta/compute/networks/vpc-access/connectors/list +++ b/gcloud/beta/compute/networks/vpc-access/connectors/list @@ -78,7 +78,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/networks/vpc-access/connectors/update b/gcloud/beta/compute/networks/vpc-access/connectors/update new file mode 100644 index 000000000..cd5d2fe4f --- /dev/null +++ b/gcloud/beta/compute/networks/vpc-access/connectors/update @@ -0,0 +1,93 @@ +NAME + gcloud beta compute networks vpc-access connectors update - update a VPC + Access connector + +SYNOPSIS + gcloud beta compute networks vpc-access connectors update + (CONNECTOR : --region=REGION) [--async] [--machine-type=MACHINE_TYPE] + [--max-instances=MAX_INSTANCES] [--min-instances=MIN_INSTANCES] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update an existing VPC Access connector with the given name. + + This command can fail for the following reasons: + ▪ Invalid parameters are passed to this command. + ▪ The active account does not have permission to update instances. + +EXAMPLES + The following command updates a VPC Access connector with name + my-vpc-connector in region us-central1: + + $ gcloud beta compute networks vpc-access connectors update \ + my-vpc-connector --region=us-central1 --min-instances=3 \ + --max-instances=5 + +POSITIONAL ARGUMENTS + Connector resource - Arguments and flags that specify the VPC Access + connector you want to update. 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 connector 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. + + CONNECTOR + ID of the connector or fully qualified identifier for the connector. + To set the connector attribute: + ▸ provide the argument connector on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + Compute region (e.g. us-central1) for the connector. + + To set the region attribute: + ▸ provide the argument connector on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --machine-type=MACHINE_TYPE + If set, updates the machine type of VMs underlying the connector. + Accepted values are "e2-micro", "f1-micro", and "e2-standard-4". + + --max-instances=MAX_INSTANCES + If set, updates the maximum number of instances within an autoscaling + group underlying the connector. Value must be between 3 and 10, + inclusive, greater than or equal to the currently set maximum number of + instances, and greater than the value specified by --min-instances. + --min-instances must be provided. + + --min-instances=MIN_INSTANCES + If set, updates the minimum number of instances within an autoscaling + group underlying the connector. Value must be between 2 and 9, + inclusive, greater than or equal to the currently set minimum number of + instances, and less than the value specified by --max-instances. + --max-instances must be provided + +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 vpcaccess/v1beta1 API. The full documentation for + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access + +NOTES + This command is currently in beta and might change without notice. + diff --git a/gcloud/beta/compute/networks/vpc-access/locations/list b/gcloud/beta/compute/networks/vpc-access/locations/list index 5c231338d..9f2ad9c7a 100644 --- a/gcloud/beta/compute/networks/vpc-access/locations/list +++ b/gcloud/beta/compute/networks/vpc-access/locations/list @@ -58,7 +58,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/networks/vpc-access/operations/describe b/gcloud/beta/compute/networks/vpc-access/operations/describe index 006d1e366..cedc2e3ad 100644 --- a/gcloud/beta/compute/networks/vpc-access/operations/describe +++ b/gcloud/beta/compute/networks/vpc-access/operations/describe @@ -61,7 +61,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/networks/vpc-access/operations/list b/gcloud/beta/compute/networks/vpc-access/operations/list index 7f48c3b23..0cb5f2a50 100644 --- a/gcloud/beta/compute/networks/vpc-access/operations/list +++ b/gcloud/beta/compute/networks/vpc-access/operations/list @@ -79,7 +79,8 @@ GCLOUD WIDE FLAGS API REFERENCE This command uses the vpcaccess/v1beta1 API. The full documentation for - this API can be found at: http://cloud.google.com + this API can be found at: + https://cloud.google.com/vpc/docs/configure-serverless-vpc-access NOTES This command is currently in beta and might change without notice. This diff --git a/gcloud/beta/compute/reservations/create b/gcloud/beta/compute/reservations/create index 7102e8194..7c246bcf0 100644 --- a/gcloud/beta/compute/reservations/create +++ b/gcloud/beta/compute/reservations/create @@ -4,7 +4,9 @@ NAME SYNOPSIS gcloud beta compute reservations create RESERVATION - (--vm-count=VM_COUNT ([--machine-type=MACHINE_TYPE + (--vm-count=VM_COUNT + (--source-instance-template=SOURCE_INSTANCE_TEMPLATE + | [--machine-type=MACHINE_TYPE : --accelerator=[count=COUNT],[type=TYPE] --local-ssd=[interface=INTERFACE],[size=SIZE] --min-cpu-platform=MIN_CPU_PLATFORM]) @@ -51,7 +53,12 @@ REQUIRED FLAGS Manage the instance properties for the SpecificSKU reservation. - This must be specified. + Exactly one of these must be specified: + + --source-instance-template=SOURCE_INSTANCE_TEMPLATE + The url of the instance template that will be used to populate the + fields of the reservation. Instance properties can not be defined + in addition to source instance template. Define the individual instance properties for the SpecificSKU reservation. diff --git a/gcloud/beta/compute/security-policies/rules/create b/gcloud/beta/compute/security-policies/rules/create index d9a335739..1e6f6558e 100644 --- a/gcloud/beta/compute/security-policies/rules/create +++ b/gcloud/beta/compute/security-policies/rules/create @@ -119,9 +119,14 @@ OPTIONAL FLAGS X-Forwarded-For header as the key ◆ http-cookie: key type takes the value of the HTTP cookie configured in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, - http-cookie. + http-cookie, http-path, sni, region-code. --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the diff --git a/gcloud/beta/compute/security-policies/rules/update b/gcloud/beta/compute/security-policies/rules/update index df6b5cb53..5952c3eda 100644 --- a/gcloud/beta/compute/security-policies/rules/update +++ b/gcloud/beta/compute/security-policies/rules/update @@ -108,9 +108,14 @@ FLAGS X-Forwarded-For header as the key ◆ http-cookie: key type takes the value of the HTTP cookie configured in enforce-on-key-name as the key value + ◆ http-path: key type takes the value of the URL path in the request + ◆ sni: key type takes the value of the server name indication from + the TLS session of the HTTPS request + ◆ region-code: key type takes the value of the region code from which + the request originates ENFORCE_ON_KEY must be one of: ip, all, http-header, xff-ip, - http-cookie. + http-cookie, http-path, sni, region-code. --enforce-on-key-name=ENFORCE_ON_KEY_NAME Determines the key name for the rate limit key. Applicable only for the diff --git a/gcloud/beta/compute/sole-tenancy/node-groups/help b/gcloud/beta/compute/sole-tenancy/node-groups/help index 5494a6311..1107dd2a8 100644 --- a/gcloud/beta/compute/sole-tenancy/node-groups/help +++ b/gcloud/beta/compute/sole-tenancy/node-groups/help @@ -43,6 +43,9 @@ COMMANDS set-iam-policy (BETA) Set the IAM policy for a Compute Engine node group. + simulate-maintenance-event + (BETA) Simulate maintenance of a Compute Engine node group. + update (BETA) Update a Compute Engine node group. diff --git a/gcloud/beta/compute/sole-tenancy/node-groups/simulate-maintenance-event b/gcloud/beta/compute/sole-tenancy/node-groups/simulate-maintenance-event new file mode 100644 index 000000000..da64a623c --- /dev/null +++ b/gcloud/beta/compute/sole-tenancy/node-groups/simulate-maintenance-event @@ -0,0 +1,66 @@ +NAME + gcloud beta compute sole-tenancy node-groups simulate-maintenance-event - + simulate maintenance of a Compute Engine node group + +SYNOPSIS + gcloud beta compute sole-tenancy node-groups simulate-maintenance-event + NAME [--async] [--nodes=[NODE,...]] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Simulate maintenance of a Compute Engine node group. + +EXAMPLES + To simulate maintenance of a node group, run: + + $ gcloud beta compute sole-tenancy node-groups \ + simulate-maintenance-event my-node-group --nodes=example-nodes + +POSITIONAL ARGUMENTS + NAME + Name of the node group to operate on. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --nodes=[NODE,...] + The names of the nodes to simulate maintenance event. + + --zone=ZONE + Zone of the node group to operate on. If not specified and the + compute/zone property isn't set, you might be prompted to select a zone + (interactive mode only). + + To avoid prompting when this flag is omitted, you can set the + compute/zone property: + + $ gcloud config set compute/zone ZONE + + A list of zones can be fetched by running: + + $ gcloud compute zones list + + To unset the property, run: + + $ gcloud config unset compute/zone + + Alternatively, the zone can be stored in the environment variable + CLOUDSDK_COMPUTE_ZONE. + +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. This + variant is also available: + + $ gcloud alpha compute sole-tenancy node-groups \ + simulate-maintenance-event + diff --git a/gcloud/beta/config/get b/gcloud/beta/config/get index fdf1e5622..938b53433 100644 --- a/gcloud/beta/config/get +++ b/gcloud/beta/config/get @@ -49,6 +49,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -77,6 +89,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -87,6 +110,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -142,97 +170,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -241,69 +296,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -311,110 +388,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -422,29 +540,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -863,6 +987,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -904,6 +1034,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -999,6 +1140,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1124,6 +1270,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use @@ -1173,8 +1323,10 @@ AVAILABLE PROPERTIES fall back to this value, if set. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: $ gcloud config get + $ gcloud alpha config get + diff --git a/gcloud/beta/config/help b/gcloud/beta/config/help index a1f178abf..3726ca9f0 100644 --- a/gcloud/beta/config/help +++ b/gcloud/beta/config/help @@ -81,6 +81,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -109,6 +121,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -119,6 +142,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -174,97 +202,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -273,69 +328,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -343,110 +420,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -454,29 +572,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -895,6 +1019,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -936,6 +1066,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1031,6 +1172,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1156,6 +1302,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/beta/config/list b/gcloud/beta/config/list index c8745d2d1..54106b065 100644 --- a/gcloud/beta/config/list +++ b/gcloud/beta/config/list @@ -7,30 +7,36 @@ SYNOPSIS [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) gcloud beta config list lists all properties of the active - configuration. These include the account used to authorize access to Google - Cloud, the current Google Cloud project, and the default Compute Engine - region and zone, if set. See gcloud topic configurations for more about - configurations. + (BETA) gcloud beta config list lists the properties of the specified + section using the active configuration. These include the account used to + authorize access to Google Cloud, the current Google Cloud project, and the + default Compute Engine region and zone, if set. See gcloud topic + configurations for more about configurations. EXAMPLES - To list the project property in the core section, run: + To list the set project property in the core section, run: $ gcloud beta config list project - To list the zone property in the compute section, run: + To list the set zone property in the compute section, run: $ gcloud beta config list compute/zone - To list all the properties in the compute section, run: + To list all the set properties in the compute section, run: $ gcloud beta config list compute/ + To list all the properties in the compute section, run: + + $ gcloud beta config list compute/ --all + To list all the properties, run: $ gcloud beta config list --all - Note, you cannot specify both --all and a property name. + Note, you cannot specify both --all and a property name. Only a section + name and the --all flag can be used together in the format gcloud config + list
/ --all. POSITIONAL ARGUMENTS [SECTION/PROPERTY] @@ -87,6 +93,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -115,6 +133,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -125,6 +154,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -180,97 +214,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -279,69 +340,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -349,110 +432,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -460,29 +584,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -901,6 +1031,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -942,6 +1078,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1037,6 +1184,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1162,6 +1314,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/beta/config/set b/gcloud/beta/config/set index e38697647..e2e577216 100644 --- a/gcloud/beta/config/set +++ b/gcloud/beta/config/set @@ -96,6 +96,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -124,6 +136,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -134,6 +157,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -189,97 +217,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -288,69 +343,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -358,110 +435,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -469,29 +587,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -910,6 +1034,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -951,6 +1081,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1046,6 +1187,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1171,6 +1317,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/beta/config/unset b/gcloud/beta/config/unset index 81257539e..79d689c4a 100644 --- a/gcloud/beta/config/unset +++ b/gcloud/beta/config/unset @@ -57,6 +57,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -85,6 +97,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -95,6 +118,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -150,97 +178,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -249,69 +304,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -319,110 +396,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -430,29 +548,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -871,6 +995,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -912,6 +1042,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1007,6 +1148,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1132,6 +1278,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/beta/container/clusters/create b/gcloud/beta/container/clusters/create index 0acf28e1e..d16e45e3e 100644 --- a/gcloud/beta/container/clusters/create +++ b/gcloud/beta/container/clusters/create @@ -24,7 +24,8 @@ SYNOPSIS [--no-enable-autoupgrade] [--enable-cloud-logging] [--enable-cloud-monitoring] [--enable-cloud-run-alpha] [--enable-confidential-nodes] [--enable-cost-allocation] - [--enable-dataplane-v2] [--enable-gke-oidc] [--enable-gvnic] + [--enable-dataplane-v2] [--enable-gke-oidc] + [--enable-google-cloud-access] [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] [--enable-l4-ilb-subsetting] @@ -51,6 +52,7 @@ SYNOPSIS [--notification-config=[pubsub=ENABLED|DISABLED, pubsub-topic=TOPIC,...]] [--num-nodes=NUM_NODES; default=3] [--placement-type=PLACEMENT_TYPE] [--preemptible] + [--private-endpoint-subnetwork=NAME] [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--release-channel=CHANNEL] [--security-group=SECURITY_GROUP] [--services-ipv4-cidr=CIDR] [--services-secondary-range-name=NAME] @@ -60,7 +62,8 @@ SYNOPSIS [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] [--workload-metadata=WORKLOAD_METADATA] [--workload-pool=WORKLOAD_POOL] [--additional-zones=ZONE,[ZONE,...] | --node-locations=ZONE,[ZONE,...]] - [--binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE + [--binauthz-policy=BINAUTHZ_POLICY + --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE | --enable-binauthz] [--cluster-dns=CLUSTER_DNS --cluster-dns-domain=CLUSTER_DNS_DOMAIN --cluster-dns-scope=CLUSTER_DNS_SCOPE] @@ -94,6 +97,8 @@ SYNOPSIS --master-ipv4-cidr=MASTER_IPV4_CIDR --private-cluster] [--enable-tpu --enable-tpu-service-networking | --tpu-ipv4-cidr=CIDR] [--ephemeral-storage=[local-ssd-count=LOCAL-SSD-COUNT] + | --ephemeral-storage-local-ssd=[count=COUNT] + | --local-nvme-ssd-block=[count=COUNT] | --local-ssd-count=LOCAL_SSD_COUNT] [--maintenance-window=START_TIME | --maintenance-window-end=TIME_STAMP --maintenance-window-recurrence=RRULE @@ -161,7 +166,7 @@ FLAGS ADDON must be one of: HttpLoadBalancing, HorizontalPodAutoscaling, KubernetesDashboard, NetworkPolicy, NodeLocalDNS, ConfigConnector, GcePersistentDiskCsiDriver, GcpFilestoreCsiDriver, BackupRestore, - Istio, ApplicationManager, CloudRun. + Istio, CloudRun. --allow-route-overlap Allows the provided cluster CIDRs to overlap with existing routes that @@ -421,6 +426,11 @@ FLAGS Thus, flag --enable-gke-oidc is also deprecated. Please use --enable-identity-service to enable the Identity Service component + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --enable-gvnic Enable the use of GVNIC for this cluster. Requires re-creation of nodes using either a node-pool upgrade or node-pool creation. @@ -600,7 +610,7 @@ FLAGS --logging=[COMPONENT,...] Set the components that have logging enabled. Valid component values - are: SYSTEM, WORKLOAD, NONE + are: SYSTEM, WORKLOAD, API_SERVER, CONTROLLER_MANAGER, SCHEDULER, NONE For more information, look at https://cloud.google.com/stackdriver/docs/solutions/gke/installing#available-logs @@ -608,7 +618,8 @@ FLAGS Examples: $ gcloud beta container clusters create --logging=SYSTEM - $ gcloud beta container clusters create --logging=SYSTEM,WORKLOAD + $ gcloud beta container clusters create \ + --logging=SYSTEM,API_SERVER,WORKLOAD $ gcloud beta container clusters create --logging=NONE --logging-variant=LOGGING_VARIANT @@ -830,9 +841,9 @@ FLAGS UNSPECIFIED - No requirements on the placement of nodes. This is the default option. - COMPACT - Google will attempt to place the nodes in a close proximity - to each other. This helps to reduce the communication latency between - the nodes, but imposes additional limitations on the node pool size. + COMPACT - GKE will attempt to place the nodes in a close proximity to + each other. This helps to reduce the communication latency between the + nodes, but imposes additional limitations on the node pool size. $ gcloud beta container clusters create example-cluster \ --placement-type=COMPACT @@ -849,6 +860,10 @@ FLAGS https://cloud.google.com/kubernetes-engine/docs/preemptible-vm for more information on how to use Preemptible VMs with Kubernetes Engine. + --private-endpoint-subnetwork=NAME + Sets the subnetwork GKE uses to provision the control plane's private + endpoint. + --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE Sets the type of private access to Google services over IPv6. @@ -954,8 +969,8 @@ FLAGS VM instances. --stack-type=STACK_TYPE - IP stack type of the node VMs. Defaults to 'ipv4'. STACK_TYPE must be - one of: ipv4, ipv4-ipv6. + IP stack type of the node VMs. STACK_TYPE must be one of: ipv4, + ipv4-ipv6. --subnetwork=SUBNETWORK The Google Compute Engine subnetwork @@ -1117,11 +1132,17 @@ FLAGS Flags for Binary Authorization: + --binauthz-policy=BINAUTHZ_POLICY + The relative resource name of the Binary Authorization policy to + audit and/or enforce. GKE policies have the following format: + projects/{project_number}/platforms/gke/policies/{policy_id}. + At most one of these can be specified: --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE Enable Binary Authorization for this cluster. - BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, + BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, MONITORING, + MONITORING_AND_PROJECT_SINGLETON_POLICY_ENFORCE, PROJECT_SINGLETON_POLICY_ENFORCE. --enable-binauthz @@ -1148,7 +1169,7 @@ FLAGS --cluster-dns-scope=CLUSTER_DNS_SCOPE DNS scope for the Cloud DNS zone created - valid only with - --cluster-dns=clouddns + --cluster-dns=clouddns. Defaults to cluster. CLUSTER_DNS_SCOPE must be one of: @@ -1398,7 +1419,8 @@ FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the node @@ -1563,12 +1585,48 @@ FLAGS 'local-ssd-count' specifies the number of local SSDs to use to back ephemeral storage. Local SDDs use NVMe interfaces and each is 375 GB - in size. If 'local-ssd-count=0', it means to disable using local SSDs - as ephemeral storage. + in size. Setting 'local-ssd-count=0' disables using local SSDs as + ephemeral storage. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. + --ephemeral-storage-local-ssd=[count=COUNT] + Parameters for the ephemeral storage filesystem. If unspecified, + ephemeral storage is backed by the boot disk. + + Examples: + + $ gcloud beta container clusters create example_cluster \ + --ephemeral-storage-local-ssd count=2 + + 'count' specifies the number of local SSDs to use to back ephemeral + storage. Local SDDs use NVMe interfaces and each is 375 GB in size. + Setting 'count=0' disables using local SSDs as ephemeral storage. + + See https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-nvme-ssd-block=[count=COUNT] + Adds the requested local SSDs on all nodes in default node pool(s) in + the new cluster. + + Examples: + + $ gcloud beta container clusters create example_cluster \ + --local-nvme-ssd-block count=2 + + 'count' must be between 1-8 + + New nodes, including ones created by resize or recreate, will have these + local SSDs. + + Local SSDs have a fixed 375 GB capacity per device. The number of disks + that can be attached to an instance is limited by the maximum number of + disks available on a machine, which differs by compute zone. See + https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + --local-ssd-count=LOCAL_SSD_COUNT The number of local SSD disks to provision on each node, formatted and mounted in the filesystem. diff --git a/gcloud/beta/container/clusters/create-auto b/gcloud/beta/container/clusters/create-auto index 48a3d7473..b67c7dbfb 100644 --- a/gcloud/beta/container/clusters/create-auto +++ b/gcloud/beta/container/clusters/create-auto @@ -5,16 +5,18 @@ NAME SYNOPSIS gcloud beta container clusters create-auto NAME [--async] [--autoprovisioning-network-tags=TAGS,[TAGS,...]] - [--binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster-ipv4-cidr=CLUSTER_IPV4_CIDR] [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] [--create-subnetwork=[KEY=VALUE,...]] - [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--network=NETWORK] - [--release-channel=CHANNEL] [--security-group=SECURITY_GROUP] - [--services-ipv4-cidr=CIDR] [--services-secondary-range-name=NAME] - [--subnetwork=SUBNETWORK] + [--database-encryption-key=DATABASE_ENCRYPTION_KEY] + [--enable-google-cloud-access] [--network=NETWORK] + [--private-endpoint-subnetwork=NAME] [--release-channel=CHANNEL] + [--security-group=SECURITY_GROUP] [--services-ipv4-cidr=CIDR] + [--services-secondary-range-name=NAME] [--subnetwork=SUBNETWORK] + [--binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE + --binauthz-policy=BINAUTHZ_POLICY] [--enable-master-authorized-networks --master-authorized-networks=NETWORK,[NETWORK,...]] [--enable-private-endpoint @@ -61,13 +63,6 @@ FLAGS https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/create for examples. - Flags for Binary Authorization: - - --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE - Enable Binary Authorization for this cluster. - BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, - PROJECT_SINGLETON_POLICY_ENFORCE. - --boot-disk-kms-key=BOOT_DISK_KMS_KEY The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form @@ -154,11 +149,20 @@ FLAGS For more information, see https://cloud.google.com/kubernetes-engine/docs/how-to/encrypting-secrets. + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --network=NETWORK The Compute Engine Network that the cluster will connect to. Google Kubernetes Engine will use this network when creating routes and firewalls for the clusters. Defaults to the 'default' network. + --private-endpoint-subnetwork=NAME + Sets the subnetwork GKE uses to provision the control plane's private + endpoint. + --release-channel=CHANNEL Release channel a cluster is subscribed to. @@ -227,6 +231,19 @@ FLAGS Cannot be used with the "--create-subnetwork" option. + Flags for Binary Authorization: + + --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE + Enable Binary Authorization for this cluster. + BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, MONITORING, + MONITORING_AND_PROJECT_SINGLETON_POLICY_ENFORCE, + PROJECT_SINGLETON_POLICY_ENFORCE. + + --binauthz-policy=BINAUTHZ_POLICY + The relative resource name of the Binary Authorization policy to + audit and/or enforce. GKE policies have the following format: + projects/{project_number}/platforms/gke/policies/{policy_id}. + Master Authorized Networks --enable-master-authorized-networks diff --git a/gcloud/beta/container/clusters/update b/gcloud/beta/container/clusters/update index 242f007e8..a8434cdfd 100644 --- a/gcloud/beta/container/clusters/update +++ b/gcloud/beta/container/clusters/update @@ -11,27 +11,28 @@ SYNOPSIS | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling | --enable-cost-allocation | --enable-gke-oidc - | --enable-identity-service | --enable-image-streaming - | --enable-intra-node-visibility | --enable-l4-ilb-subsetting - | --enable-legacy-authorization + | --enable-google-cloud-access | --enable-identity-service + | --enable-image-streaming | --enable-intra-node-visibility + | --enable-l4-ilb-subsetting | --enable-legacy-authorization | --enable-logging-monitoring-system-only | --enable-master-authorized-networks | --enable-master-global-access | --enable-network-policy | --enable-pod-security-policy - | --enable-service-externalips | --enable-shielded-nodes - | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling - | --gateway-api=GATEWAY_API | --generate-password - | --identity-provider=IDENTITY_PROVIDER + | --enable-private-endpoint | --enable-service-externalips + | --enable-shielded-nodes | --enable-stackdriver-kubernetes + | --enable-vertical-pod-autoscaling | --gateway-api=GATEWAY_API + | --generate-password | --identity-provider=IDENTITY_PROVIDER | --logging-variant=LOGGING_VARIANT | --maintenance-window=START_TIME | --notification-config=[pubsub=ENABLED|DISABLED, pubsub-topic=TOPIC,...] | --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE | --release-channel=CHANNEL | --remove-labels=[KEY,...] | --security-group=SECURITY_GROUP | --set-password - | --start-credential-rotation | --start-ip-rotation - | --update-addons=[ADDON=ENABLED|DISABLED,...] + | --stack-type=STACK_TYPE | --start-credential-rotation + | --start-ip-rotation | --update-addons=[ADDON=ENABLED|DISABLED,...] | --update-labels=[KEY=VALUE,...] | --workload-pool=WORKLOAD_POOL | --additional-zones=[ZONE,...] | --node-locations=ZONE,[ZONE,...] - | --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE + | --binauthz-policy=BINAUTHZ_POLICY + --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE | --enable-binauthz | --clear-maintenance-window | --remove-maintenance-exclusion=NAME | [--add-maintenance-exclusion-end=TIME_STAMP @@ -185,7 +186,8 @@ REQUIRED FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --enable-cost-allocation Enable the cost management feature. @@ -211,6 +213,11 @@ REQUIRED FLAGS Thus, flag --enable-gke-oidc is also deprecated. Please use --enable-identity-service to enable the Identity Service component + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --enable-identity-service Enable Identity Service component on the cluster. @@ -287,6 +294,10 @@ REQUIRED FLAGS PodSecurityPolicy API objects. For more information, see https://cloud.google.com/kubernetes-engine/docs/how-to/pod-security-policies. + --enable-private-endpoint + Enables cluster's control plane to be accessible using private IP + address only. + --enable-service-externalips Enables use of services with externalIPs field. @@ -467,6 +478,10 @@ REQUIRED FLAGS Set the basic auth password to the specified value, keeping the existing username. + --stack-type=STACK_TYPE + IP stack type of the node VMs. STACK_TYPE must be one of: ipv4, + ipv4-ipv6. + --start-credential-rotation Start the rotation of IP and credentials for this cluster. For example: @@ -493,9 +508,9 @@ REQUIRED FLAGS HorizontalPodAutoscaling=ENABLED|DISABLED HttpLoadBalancing=ENABLED|DISABLED KubernetesDashboard=ENABLED|DISABLED Istio=ENABLED|DISABLED - ApplicationManager=ENABLED|DISABLED BackupRestore=ENABLED|DISABLED - NetworkPolicy=ENABLED|DISABLED CloudRun=ENABLED|DISABLED - ConfigConnector=ENABLED|DISABLED NodeLocalDNS=ENABLED|DISABLED + BackupRestore=ENABLED|DISABLED NetworkPolicy=ENABLED|DISABLED + CloudRun=ENABLED|DISABLED ConfigConnector=ENABLED|DISABLED + NodeLocalDNS=ENABLED|DISABLED GcePersistentDiskCsiDriver=ENABLED|DISABLED GcpFilestoreCsiDriver=ENABLED|DISABLED @@ -571,11 +586,17 @@ REQUIRED FLAGS Flags for Binary Authorization: + --binauthz-policy=BINAUTHZ_POLICY + The relative resource name of the Binary Authorization policy to + audit and/or enforce. GKE policies have the following format: + projects/{project_number}/platforms/gke/policies/{policy_id}. + At most one of these can be specified: --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE Enable Binary Authorization for this cluster. - BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, + BINAUTHZ_EVALUATION_MODE must be one of: DISABLED, MONITORING, + MONITORING_AND_PROJECT_SINGLETON_POLICY_ENFORCE, PROJECT_SINGLETON_POLICY_ENFORCE. --enable-binauthz @@ -738,7 +759,7 @@ REQUIRED FLAGS --cluster-dns-scope=CLUSTER_DNS_SCOPE DNS scope for the Cloud DNS zone created - valid only with - --cluster-dns=clouddns + --cluster-dns=clouddns. Defaults to cluster. CLUSTER_DNS_SCOPE must be one of: @@ -1018,7 +1039,8 @@ REQUIRED FLAGS --logging=[COMPONENT,...] Set the components that have logging enabled. Valid component values - are: SYSTEM, WORKLOAD, NONE + are: SYSTEM, WORKLOAD, API_SERVER, CONTROLLER_MANAGER, SCHEDULER, + NONE For more information, look at https://cloud.google.com/stackdriver/docs/solutions/gke/installing#available-logs @@ -1026,7 +1048,8 @@ REQUIRED FLAGS Examples: $ gcloud beta container clusters update --logging=SYSTEM - $ gcloud beta container clusters update --logging=SYSTEM,WORKLOAD + $ gcloud beta container clusters update \ + --logging=SYSTEM,API_SERVER,WORKLOAD $ gcloud beta container clusters update --logging=NONE --monitoring=[COMPONENT,...] diff --git a/gcloud/beta/container/fleet/config-management/apply b/gcloud/beta/container/fleet/config-management/apply index be61ab6b3..ac5e8ad66 100644 --- a/gcloud/beta/container/fleet/config-management/apply +++ b/gcloud/beta/container/fleet/config-management/apply @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container fleet config-management apply --config=CONFIG - [--membership=MEMBERSHIP] [--version=VERSION] [GCLOUD_WIDE_FLAG ...] + [--version=VERSION] [--membership=MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update a user-specified config file to a ConfigManagement Custom @@ -26,12 +27,33 @@ REQUIRED FLAGS The path to config-management.yaml. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. - --version=VERSION The version of ACM to install. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/container/fleet/config-management/unmanage b/gcloud/beta/container/fleet/config-management/unmanage index 6e6b24ca4..d81d0c9e3 100644 --- a/gcloud/beta/container/fleet/config-management/unmanage +++ b/gcloud/beta/container/fleet/config-management/unmanage @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container fleet config-management unmanage - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Remove the Config Management Feature Spec for the given membership. @@ -18,8 +18,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/config-management/upgrade b/gcloud/beta/container/fleet/config-management/upgrade index 5870cdab3..612d43eee 100644 --- a/gcloud/beta/container/fleet/config-management/upgrade +++ b/gcloud/beta/container/fleet/config-management/upgrade @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container fleet config-management upgrade --version=VERSION - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Upgrade a specified membership to any supported version of the @@ -21,8 +21,29 @@ REQUIRED FLAGS The version of ACM to change to. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/features/list b/gcloud/beta/container/fleet/features/list index c057847e5..797c3f015 100644 --- a/gcloud/beta/container/fleet/features/list +++ b/gcloud/beta/container/fleet/features/list @@ -7,15 +7,15 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List enabled Hub features in a project. + (BETA) List enabled fleet features in a project. EXAMPLES - To list all enabled Hub features in a project, run: + To list all enabled fleet features in a project, run: $ gcloud beta container fleet features list FLAGS - Location resource - The location to list Features under. + Location resource - The location to list features under. 'global' is the only supported value. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be diff --git a/gcloud/beta/container/fleet/help b/gcloud/beta/container/fleet/help index a9ae6b1f1..aa6af210a 100644 --- a/gcloud/beta/container/fleet/help +++ b/gcloud/beta/container/fleet/help @@ -61,7 +61,7 @@ GROUPS (BETA) Manage Multi-cluster Ingress Feature. memberships - (BETA) Manage memberships of all your GKE and other Kubernetes cluster + (BETA) Manage memberships of all your GKE and other Kubernetes clusters with fleets. mesh diff --git a/gcloud/beta/container/fleet/identity-service/apply b/gcloud/beta/container/fleet/identity-service/apply index 4dadd8ce0..de4a77aef 100644 --- a/gcloud/beta/container/fleet/identity-service/apply +++ b/gcloud/beta/container/fleet/identity-service/apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container fleet identity-service apply --config=CONFIG - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Applies the authentication configuration to the Identity Service @@ -26,8 +26,29 @@ REQUIRED FLAGS The path to the identity-service.yaml config file. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/identity-service/delete b/gcloud/beta/container/fleet/identity-service/delete index 303b62a62..2d76d5eda 100644 --- a/gcloud/beta/container/fleet/identity-service/delete +++ b/gcloud/beta/container/fleet/identity-service/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container fleet identity-service delete - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Removes the Identity Service Feature Spec for the given membership. @@ -16,8 +16,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/ingress/enable b/gcloud/beta/container/fleet/ingress/enable index 6f2c238b7..76aeac95e 100644 --- a/gcloud/beta/container/fleet/ingress/enable +++ b/gcloud/beta/container/fleet/ingress/enable @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container fleet ingress enable - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command enables Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/ingress/update b/gcloud/beta/container/fleet/ingress/update index 13bd32725..e2d958d8f 100644 --- a/gcloud/beta/container/fleet/ingress/update +++ b/gcloud/beta/container/fleet/ingress/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container fleet ingress update - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command updates Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/memberships/describe b/gcloud/beta/container/fleet/memberships/describe index 2daf4e3f3..2fb042b81 100644 --- a/gcloud/beta/container/fleet/memberships/describe +++ b/gcloud/beta/container/fleet/memberships/describe @@ -6,12 +6,12 @@ SYNOPSIS (MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Describe a membership in Fleet. + (BETA) Describe a membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud beta container fleet memberships list diff --git a/gcloud/beta/container/fleet/memberships/get-credentials b/gcloud/beta/container/fleet/memberships/get-credentials index 77cfb9da5..cf759b1d6 100644 --- a/gcloud/beta/container/fleet/memberships/get-credentials +++ b/gcloud/beta/container/fleet/memberships/get-credentials @@ -3,31 +3,64 @@ NAME for a fleet-registered cluster to be used in Connect Gateway SYNOPSIS - gcloud beta container fleet memberships get-credentials MEMBERSHIP - [GCLOUD_WIDE_FLAG ...] + gcloud beta container fleet memberships get-credentials + (MEMBERSHIP_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta container fleet memberships get-credentials updates the kubeconfig file with the appropriate credentials and endpoint information - to send kubectl commands to a fleet-registered and connected cluster - through Connect Gateway Service. + to send kubectl commands to a fleet-registered and -connected cluster + through the Connect Gateway service. It takes a project, passed through by set defaults or flags. By default, credentials are written to $HOME/.kube/config. You can provide an alternate path by setting the KUBECONFIG environment variable. If KUBECONFIG contains multiple paths, the first one is used. - Upon success, this command will switch current context to the target - cluster, when working with multiple clusters. + Upon success, this command will switch the current context to the target + cluster if other contexts are already present in the kubeconfig file. EXAMPLES - Get gateway kubeconfig for a registered cluster: + Get the Gateway kubeconfig for a globally registered cluster: $ gcloud beta container fleet memberships get-credentials my-cluster + $ gcloud beta container fleet memberships get-credentials \ + my-cluster --location=global + + Get the Gateway kubeconfig for a cluster registered in us-central1: + + $ gcloud beta container fleet memberships get-credentials \ + my-cluster --location=us-central1 POSITIONAL ARGUMENTS - MEMBERSHIP - The membership name used to locate a cluster in your project. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/fleet/memberships/help b/gcloud/beta/container/fleet/memberships/help index ccd168953..ed05c7572 100644 --- a/gcloud/beta/container/fleet/memberships/help +++ b/gcloud/beta/container/fleet/memberships/help @@ -1,13 +1,14 @@ NAME gcloud beta container fleet memberships - manage memberships of all your - GKE and other Kubernetes cluster with fleets + GKE and other Kubernetes clusters with fleets SYNOPSIS - gcloud beta container fleet memberships COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud beta container fleet memberships GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Manage memberships of all your GKE and other Kubernetes cluster with - fleets. + (BETA) Manage memberships of all your GKE and other Kubernetes clusters + with fleets. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -37,7 +38,7 @@ COMMANDS (BETA) Register a cluster with a fleet. unregister - (BETA) Unregister a cluster from Fleet. + (BETA) Unregister a cluster from a fleet. update (BETA) Update a membership. diff --git a/gcloud/beta/container/fleet/memberships/register b/gcloud/beta/container/fleet/memberships/register index ddf70f03a..491a58005 100644 --- a/gcloud/beta/container/fleet/memberships/register +++ b/gcloud/beta/container/fleet/memberships/register @@ -101,7 +101,7 @@ EXAMPLES $ gcloud beta container fleet memberships register my-cluster \ --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --install-connect-agent --version=20220819-00-00 \ --service-account-key-file=/tmp/keyfile.json Register a GKE cluster and output a manifest that can be used to install the diff --git a/gcloud/beta/container/fleet/memberships/unregister b/gcloud/beta/container/fleet/memberships/unregister index 64998d1d1..90b10188c 100644 --- a/gcloud/beta/container/fleet/memberships/unregister +++ b/gcloud/beta/container/fleet/memberships/unregister @@ -1,9 +1,10 @@ NAME gcloud beta container fleet memberships unregister - unregister a cluster - from Fleet + from a fleet SYNOPSIS - gcloud beta container fleet memberships unregister MEMBERSHIP_NAME + gcloud beta container fleet memberships unregister + (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] @@ -64,9 +65,34 @@ EXAMPLES --uninstall-connect-agent POSITIONAL ARGUMENTS - MEMBERSHIP_NAME - The membership name that you choose to uniquely represents the cluster - being registered on the fleet. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. REQUIRED FLAGS Cluster identifier. diff --git a/gcloud/beta/container/fleet/memberships/update b/gcloud/beta/container/fleet/memberships/update index 8b6d5a742..285eef4a3 100644 --- a/gcloud/beta/container/fleet/memberships/update +++ b/gcloud/beta/container/fleet/memberships/update @@ -8,12 +8,12 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Update an existing membership in Fleet. + (BETA) Update an existing membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud beta container fleet memberships list diff --git a/gcloud/beta/container/hub/config-management/apply b/gcloud/beta/container/hub/config-management/apply index 1fbecd058..3cee93618 100644 --- a/gcloud/beta/container/hub/config-management/apply +++ b/gcloud/beta/container/hub/config-management/apply @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container hub config-management apply --config=CONFIG - [--membership=MEMBERSHIP] [--version=VERSION] [GCLOUD_WIDE_FLAG ...] + [--version=VERSION] [--membership=MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update a user-specified config file to a ConfigManagement Custom @@ -26,12 +27,33 @@ REQUIRED FLAGS The path to config-management.yaml. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. - --version=VERSION The version of ACM to install. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/container/hub/config-management/unmanage b/gcloud/beta/container/hub/config-management/unmanage index d4be893ec..b6d38e9aa 100644 --- a/gcloud/beta/container/hub/config-management/unmanage +++ b/gcloud/beta/container/hub/config-management/unmanage @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container hub config-management unmanage - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Remove the Config Management Feature Spec for the given membership. @@ -18,8 +18,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/config-management/upgrade b/gcloud/beta/container/hub/config-management/upgrade index e39caa8b3..3a0823c78 100644 --- a/gcloud/beta/container/hub/config-management/upgrade +++ b/gcloud/beta/container/hub/config-management/upgrade @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container hub config-management upgrade --version=VERSION - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Upgrade a specified membership to any supported version of the @@ -21,8 +21,29 @@ REQUIRED FLAGS The version of ACM to change to. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/features/list b/gcloud/beta/container/hub/features/list index a35e8b4de..c61a6e1c1 100644 --- a/gcloud/beta/container/hub/features/list +++ b/gcloud/beta/container/hub/features/list @@ -7,15 +7,15 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List enabled Hub features in a project. + (BETA) List enabled fleet features in a project. EXAMPLES - To list all enabled Hub features in a project, run: + To list all enabled fleet features in a project, run: $ gcloud beta container hub features list FLAGS - Location resource - The location to list Features under. + Location resource - The location to list features under. 'global' is the only supported value. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be diff --git a/gcloud/beta/container/hub/help b/gcloud/beta/container/hub/help index adf616318..9fed0cc50 100644 --- a/gcloud/beta/container/hub/help +++ b/gcloud/beta/container/hub/help @@ -61,7 +61,7 @@ GROUPS (BETA) Manage Multi-cluster Ingress Feature. memberships - (BETA) Manage memberships of all your GKE and other Kubernetes cluster + (BETA) Manage memberships of all your GKE and other Kubernetes clusters with fleets. mesh diff --git a/gcloud/beta/container/hub/identity-service/apply b/gcloud/beta/container/hub/identity-service/apply index 55d40c40b..dbf84ae8a 100644 --- a/gcloud/beta/container/hub/identity-service/apply +++ b/gcloud/beta/container/hub/identity-service/apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta container hub identity-service apply --config=CONFIG - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Applies the authentication configuration to the Identity Service @@ -26,8 +26,29 @@ REQUIRED FLAGS The path to the identity-service.yaml config file. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/identity-service/delete b/gcloud/beta/container/hub/identity-service/delete index 94c14ce19..f23047d9d 100644 --- a/gcloud/beta/container/hub/identity-service/delete +++ b/gcloud/beta/container/hub/identity-service/delete @@ -3,8 +3,8 @@ NAME Service Feature Spec for the given membership SYNOPSIS - gcloud beta container hub identity-service delete [--membership=MEMBERSHIP] - [GCLOUD_WIDE_FLAG ...] + gcloud beta container hub identity-service delete + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Removes the Identity Service Feature Spec for the given membership. @@ -16,8 +16,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/ingress/enable b/gcloud/beta/container/hub/ingress/enable index e736cc1be..a01c0fece 100644 --- a/gcloud/beta/container/hub/ingress/enable +++ b/gcloud/beta/container/hub/ingress/enable @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container hub ingress enable - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command enables Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/ingress/update b/gcloud/beta/container/hub/ingress/update index 4a6229fef..000e1cd0a 100644 --- a/gcloud/beta/container/hub/ingress/update +++ b/gcloud/beta/container/hub/ingress/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta container hub ingress update - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command updates Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/memberships/describe b/gcloud/beta/container/hub/memberships/describe index 28713bfb7..3c052c684 100644 --- a/gcloud/beta/container/hub/memberships/describe +++ b/gcloud/beta/container/hub/memberships/describe @@ -6,12 +6,12 @@ SYNOPSIS (MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Describe a membership in Fleet. + (BETA) Describe a membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud beta container hub memberships list diff --git a/gcloud/beta/container/hub/memberships/get-credentials b/gcloud/beta/container/hub/memberships/get-credentials index ef200a329..91658d9c2 100644 --- a/gcloud/beta/container/hub/memberships/get-credentials +++ b/gcloud/beta/container/hub/memberships/get-credentials @@ -3,31 +3,64 @@ NAME for a fleet-registered cluster to be used in Connect Gateway SYNOPSIS - gcloud beta container hub memberships get-credentials MEMBERSHIP - [GCLOUD_WIDE_FLAG ...] + gcloud beta container hub memberships get-credentials + (MEMBERSHIP_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta container hub memberships get-credentials updates the kubeconfig file with the appropriate credentials and endpoint information - to send kubectl commands to a fleet-registered and connected cluster - through Connect Gateway Service. + to send kubectl commands to a fleet-registered and -connected cluster + through the Connect Gateway service. It takes a project, passed through by set defaults or flags. By default, credentials are written to $HOME/.kube/config. You can provide an alternate path by setting the KUBECONFIG environment variable. If KUBECONFIG contains multiple paths, the first one is used. - Upon success, this command will switch current context to the target - cluster, when working with multiple clusters. + Upon success, this command will switch the current context to the target + cluster if other contexts are already present in the kubeconfig file. EXAMPLES - Get gateway kubeconfig for a registered cluster: + Get the Gateway kubeconfig for a globally registered cluster: $ gcloud beta container hub memberships get-credentials my-cluster + $ gcloud beta container hub memberships get-credentials my-cluster \ + --location=global + + Get the Gateway kubeconfig for a cluster registered in us-central1: + + $ gcloud beta container hub memberships get-credentials my-cluster \ + --location=us-central1 POSITIONAL ARGUMENTS - MEMBERSHIP - The membership name used to locate a cluster in your project. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/container/hub/memberships/help b/gcloud/beta/container/hub/memberships/help index eeac9b543..ed960e4cf 100644 --- a/gcloud/beta/container/hub/memberships/help +++ b/gcloud/beta/container/hub/memberships/help @@ -1,13 +1,14 @@ NAME gcloud beta container hub memberships - manage memberships of all your GKE - and other Kubernetes cluster with fleets + and other Kubernetes clusters with fleets SYNOPSIS - gcloud beta container hub memberships COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud beta container hub memberships GROUP | COMMAND + [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Manage memberships of all your GKE and other Kubernetes cluster with - fleets. + (BETA) Manage memberships of all your GKE and other Kubernetes clusters + with fleets. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -37,7 +38,7 @@ COMMANDS (BETA) Register a cluster with a fleet. unregister - (BETA) Unregister a cluster from Fleet. + (BETA) Unregister a cluster from a fleet. update (BETA) Update a membership. diff --git a/gcloud/beta/container/hub/memberships/register b/gcloud/beta/container/hub/memberships/register index 0e2205f0d..904af3e00 100644 --- a/gcloud/beta/container/hub/memberships/register +++ b/gcloud/beta/container/hub/memberships/register @@ -101,7 +101,7 @@ EXAMPLES $ gcloud beta container hub memberships register my-cluster \ --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --install-connect-agent --version=20220819-00-00 \ --service-account-key-file=/tmp/keyfile.json Register a GKE cluster and output a manifest that can be used to install the diff --git a/gcloud/beta/container/hub/memberships/unregister b/gcloud/beta/container/hub/memberships/unregister index 268ab9451..ea4a56288 100644 --- a/gcloud/beta/container/hub/memberships/unregister +++ b/gcloud/beta/container/hub/memberships/unregister @@ -1,9 +1,10 @@ NAME gcloud beta container hub memberships unregister - unregister a cluster - from Fleet + from a fleet SYNOPSIS - gcloud beta container hub memberships unregister MEMBERSHIP_NAME + gcloud beta container hub memberships unregister + (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] @@ -64,9 +65,34 @@ EXAMPLES --uninstall-connect-agent POSITIONAL ARGUMENTS - MEMBERSHIP_NAME - The membership name that you choose to uniquely represents the cluster - being registered on the fleet. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. REQUIRED FLAGS Cluster identifier. diff --git a/gcloud/beta/container/hub/memberships/update b/gcloud/beta/container/hub/memberships/update index 0f7c30167..721bcc287 100644 --- a/gcloud/beta/container/hub/memberships/update +++ b/gcloud/beta/container/hub/memberships/update @@ -8,12 +8,12 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Update an existing membership in Fleet. + (BETA) Update an existing membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud beta container hub memberships list diff --git a/gcloud/beta/container/node-pools/create b/gcloud/beta/container/node-pools/create index 929100e4d..b4f86fc3a 100644 --- a/gcloud/beta/container/node-pools/create +++ b/gcloud/beta/container/node-pools/create @@ -8,13 +8,14 @@ SYNOPSIS gpu-partition-size=GPU_PARTITION_SIZE, gpu-sharing-strategy=GPU_SHARING_STRATEGY, max-shared-clients-per-gpu=MAX_SHARED_CLIENTS_PER_GPU],...]] - [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] + [--async] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] [--disable-pod-cidr-overprovision] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] - [--enable-gvnic] [--enable-image-streaming] [--enable-surge-upgrade] - [--image-type=IMAGE_TYPE] [--logging-variant=LOGGING_VARIANT] + [--enable-gvnic] [--enable-image-streaming] [--enable-private-nodes] + [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] + [--labels=[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] [--max-surge-upgrade=MAX_SURGE_UPGRADE; default=1] @@ -35,12 +36,15 @@ SYNOPSIS batch-soak-duration=BATCH_SOAK_DURATION,...]] [--system-config-from-file=SYSTEM_CONFIG_FROM_FILE] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] + [--windows-os-version=WINDOWS_OS_VERSION] [--workload-metadata=WORKLOAD_METADATA] [--create-pod-ipv4-range=[KEY=VALUE,...] | --pod-ipv4-range=NAME] [--enable-autoscaling --location-policy=LOCATION_POLICY --max-nodes=MAX_NODES --min-nodes=MIN_NODES --total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES] [--ephemeral-storage=[local-ssd-count=LOCAL-SSD-COUNT] + | --ephemeral-storage-local-ssd=[count=COUNT] + | --local-nvme-ssd-block=[count=COUNT] | --local-ssd-count=LOCAL_SSD_COUNT] [--region=REGION | --zone=ZONE, -z ZONE] [--reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY] @@ -100,6 +104,10 @@ FLAGS (Optional) The max number of containers allowed to share each GPU on the node. This field is used together with gpu-sharing-strategy. + --async + Return immediately, without waiting for the operation in progress to + complete. + --boot-disk-kms-key=BOOT_DISK_KMS_KEY The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form @@ -171,6 +179,13 @@ FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-private-nodes + Enables provisioning nodes with private IP addresses only. + + The control plane still communicates with all nodes through private IP + addresses only, regardless of whether private nodes are enabled or + disabled. + --enable-surge-upgrade Changes node pool upgrade strategy to surge upgrade. @@ -187,6 +202,15 @@ FLAGS $ gcloud container get-server-config + --labels=[KEY=VALUE,...] + Labels to apply to the Google Cloud resources of node pools in the + Kubernetes Engine cluster. These are unrelated to Kubernetes labels. + + Examples: + + $ gcloud beta container node-pools create node-pool-1 \ + --cluster=example-cluster --labels=label1=value1,label2=value2 + --logging-variant=LOGGING_VARIANT Specifies the logging variant that will be deployed on all the nodes in the node pool. If the node pool doesn't specify a logging variant, then @@ -406,9 +430,9 @@ FLAGS UNSPECIFIED - No requirements on the placement of nodes. This is the default option. - COMPACT - Google will attempt to place the nodes in a close proximity - to each other. This helps to reduce the communication latency between - the nodes, but imposes additional limitations on the node pool size. + COMPACT - GKE will attempt to place the nodes in a close proximity to + each other. This helps to reduce the communication latency between the + nodes, but imposes additional limitations on the node pool size. $ gcloud beta container node-pools create node-pool-1 \ --cluster=example-cluster --placement-type=COMPACT @@ -528,6 +552,14 @@ FLAGS The number of visible threads per physical core for each node. To disable simultaneous multithreading (SMT) set this to 1. + --windows-os-version=WINDOWS_OS_VERSION + Specifies the Windows Server Image to use when creating a Windows node + pool. Valid variants can be "ltsc2019", "ltsc2022". It means using + LTSC2019 server image or LTSC2022 server image. If the node pool + doesn't specify a Windows Server Image Os version, then Ltsc2019 will + be the default one to use. WINDOWS_OS_VERSION must be one of: ltsc2019, + ltsc2022. + --workload-metadata=WORKLOAD_METADATA Type of metadata server available to pods running in the node pool. WORKLOAD_METADATA must be one of: @@ -623,7 +655,8 @@ FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the node @@ -677,12 +710,48 @@ FLAGS 'local-ssd-count' specifies the number of local SSDs to use to back ephemeral storage. Local SDDs use NVMe interfaces and each is 375 GB - in size. If 'local-ssd-count=0', it means to disable using local SSDs - as ephemeral storage. + in size. Setting 'local-ssd-count=0' disables using local SSDs as + ephemeral storage. See https://cloud.google.com/compute/docs/disks/local-ssd for more information. + --ephemeral-storage-local-ssd=[count=COUNT] + Parameters for the ephemeral storage filesystem. If unspecified, + ephemeral storage is backed by the boot disk. + + Examples: + + $ gcloud beta container node-pools create node-pool-1 \ + --cluster=example cluster --ephemeral-storage-local-ssd count=2 + + 'count' specifies the number of local SSDs to use to back ephemeral + storage. Local SDDs use NVMe interfaces and each is 375 GB in size. + Setting 'count=0' disables using local SSDs as ephemeral storage. + + See https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-nvme-ssd-block=[count=COUNT] + Adds the requested local SSDs on all nodes in default node pool(s) in + the new cluster. + + Examples: + + $ gcloud beta container node-pools create node-pool-1 \ + --cluster=example cluster --local-nvme-ssd-block count=2 + + 'count' must be between 1-8 + + New nodes, including ones created by resize or recreate, will have these + local SSDs. + + Local SSDs have a fixed 375 GB capacity per device. The number of disks + that can be attached to an instance is limited by the maximum number of + disks available on a machine, which differs by compute zone. See + https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + --local-ssd-count=LOCAL_SSD_COUNT The number of local SSD disks to provision on each node, formatted and mounted in the filesystem. diff --git a/gcloud/beta/container/node-pools/delete b/gcloud/beta/container/node-pools/delete index 3fc614aa1..0ddef8060 100644 --- a/gcloud/beta/container/node-pools/delete +++ b/gcloud/beta/container/node-pools/delete @@ -8,9 +8,12 @@ SYNOPSIS DESCRIPTION (BETA) gcloud beta container node-pools delete deletes a node pool from a - Google Kubernetes Engine cluster. This command does not gracefully drain - the nodes prior to deleting them. Use "kubectl drain NODE_NAME" to drain - each node to have containers running on these nodes terminate gracefully. + Google Kubernetes Engine (GKE) cluster. When you delete a node pool, GKE + drains all the nodes in the node pool. The draining process involves GKE + evicting Pods on each node in the node pool. Each node in a node pool is + drained by evicting Pods with an allotted graceful termination period of + MAX_POD. MAX_POD is the maximum terminationGracePeriodSeconds set on the + Pods scheduled to the node with a cap of one hour. EXAMPLES To delete the "node-pool-1" node pool from the cluster "sample-cluster", diff --git a/gcloud/beta/container/node-pools/update b/gcloud/beta/container/node-pools/update index 0cadf08ea..7ed8dca04 100644 --- a/gcloud/beta/container/node-pools/update +++ b/gcloud/beta/container/node-pools/update @@ -5,15 +5,16 @@ NAME SYNOPSIS gcloud beta container node-pools update NAME (--enable-confidential-nodes | --enable-gvnic - | --enable-image-streaming | --logging-variant=LOGGING_VARIANT + | --enable-image-streaming | --enable-private-nodes + | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] | --system-config-from-file=SYSTEM_CONFIG_FROM_FILE - | --tags=[TAG,...] | --workload-metadata=WORKLOAD_METADATA - | --enable-autoprovisioning --enable-autoscaling - --location-policy=LOCATION_POLICY --max-nodes=MAX_NODES - --min-nodes=MIN_NODES + | --tags=[TAG,...] | --windows-os-version=WINDOWS_OS_VERSION + | --workload-metadata=WORKLOAD_METADATA | --enable-autoprovisioning + --enable-autoscaling --location-policy=LOCATION_POLICY + --max-nodes=MAX_NODES --min-nodes=MIN_NODES --total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES | --enable-autorepair --enable-autoupgrade | --enable-blue-green-upgrade --enable-surge-upgrade @@ -22,8 +23,9 @@ SYNOPSIS --node-pool-soak-duration=NODE_POOL_SOAK_DURATION --standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, batch-percent=BATCH_NODE_PERCENTAGE, - batch-soak-duration=BATCH_SOAK_DURATION,...]) [--cluster=CLUSTER] - [--region=REGION | --zone=ZONE, -z ZONE] [GCLOUD_WIDE_FLAG ...] + batch-soak-duration=BATCH_SOAK_DURATION,...]) [--async] + [--cluster=CLUSTER] [--region=REGION | --zone=ZONE, -z ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta container node-pools update updates a node pool in a @@ -54,6 +56,22 @@ REQUIRED FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-private-nodes + Enables provisioning nodes with private IP addresses only. + + The control plane still communicates with all nodes through private + IP addresses only, regardless of whether private nodes are enabled or + disabled. + + --labels=[KEY=VALUE,...] + Labels to apply to the Google Cloud resources of node pools in the + Kubernetes Engine cluster. These are unrelated to Kubernetes labels. + + Examples: + + $ gcloud beta container node-pools update node-pool-1 \ + --cluster=example-cluster --labels=label1=value1,label2=value2 + --logging-variant=LOGGING_VARIANT Specifies the logging variant that will be deployed on all the nodes in the node pool. If the node pool doesn't specify a logging variant, @@ -188,6 +206,14 @@ REQUIRED FLAGS https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/create for examples. + --windows-os-version=WINDOWS_OS_VERSION + Specifies the Windows Server Image to use when creating a Windows + node pool. Valid variants can be "ltsc2019", "ltsc2022". It means + using LTSC2019 server image or LTSC2022 server image. If the node + pool doesn't specify a Windows Server Image Os version, then Ltsc2019 + will be the default one to use. WINDOWS_OS_VERSION must be one of: + ltsc2019, ltsc2022. + --workload-metadata=WORKLOAD_METADATA Type of metadata server available to pods running in the node pool. WORKLOAD_METADATA must be one of: @@ -234,7 +260,8 @@ REQUIRED FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or - the default node pool if --node-pool is not provided. + the default node pool if --node-pool is not provided. If not + already, --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the @@ -363,6 +390,10 @@ REQUIRED FLAGS batch-soak-duration=60s OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --cluster=CLUSTER The name of the cluster. Overrides the default container/cluster property value for this command invocation. diff --git a/gcloud/beta/dataproc/jobs/kill b/gcloud/beta/dataproc/jobs/kill index dfe386aeb..32cabbaad 100644 --- a/gcloud/beta/dataproc/jobs/kill +++ b/gcloud/beta/dataproc/jobs/kill @@ -2,7 +2,7 @@ NAME gcloud beta dataproc jobs kill - kill an active job SYNOPSIS - gcloud beta dataproc jobs kill (JOB : --region=REGION) + gcloud beta dataproc jobs kill (JOB : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -44,6 +44,11 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property dataproc/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, diff --git a/gcloud/beta/dataproc/jobs/submit/help b/gcloud/beta/dataproc/jobs/submit/help index a5190cdb9..b63d31485 100644 --- a/gcloud/beta/dataproc/jobs/submit/help +++ b/gcloud/beta/dataproc/jobs/submit/help @@ -87,6 +87,9 @@ COMMANDS spark-sql (BETA) Submit a Spark SQL job to a cluster. + trino + (BETA) Submit a Trino job to a cluster. + NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/dataproc/jobs/submit/trino b/gcloud/beta/dataproc/jobs/submit/trino new file mode 100644 index 000000000..05ade9b81 --- /dev/null +++ b/gcloud/beta/dataproc/jobs/submit/trino @@ -0,0 +1,135 @@ +NAME + gcloud beta dataproc jobs submit trino - submit a Trino job to a cluster + +SYNOPSIS + gcloud beta dataproc jobs submit trino + (--cluster=CLUSTER | --cluster-labels=[KEY=VALUE,...]) + (--execute=QUERY, -e QUERY | --file=FILE, -f FILE) [--async] + [--bucket=BUCKET] [--client-tags=[CLIENT_TAG,...]] + [--continue-on-failure] [--driver-log-levels=[PACKAGE=LEVEL,...]] + [--labels=[KEY=VALUE,...]] + [--max-failures-per-hour=MAX_FAILURES_PER_HOUR] + [--max-failures-total=MAX_FAILURES_TOTAL] + [--properties=[PARAM=VALUE,...]] [--properties-file=PROPERTIES_FILE] + [--query-output-format=QUERY_OUTPUT_FORMAT] [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Submit a Trino job to a cluster + +EXAMPLES + To submit a Trino job with a local script, run: + + $ gcloud beta dataproc jobs submit trino --cluster=my-cluster \ + --file=my_script.R + + To submit a Trino job with inline queries, run: + + $ gcloud beta dataproc jobs submit trino --cluster=my-cluster \ + -e="SELECT * FROM foo WHERE bar > 2" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --cluster=CLUSTER + The Dataproc cluster to submit the job to. + + --cluster-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + Labels of Dataproc cluster on which to place the job. + + Exactly one of these must be specified: + + --execute=QUERY, -e QUERY + A Trino query to execute. + + --file=FILE, -f FILE + HCFS URI of file containing the Trino script to execute. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --bucket=BUCKET + The Cloud Storage bucket to stage files in. Defaults to the cluster's + configured bucket. + + --client-tags=[CLIENT_TAG,...] + A list of Trino client tags to attach to this query. + + --continue-on-failure + Whether to continue if a query fails. + + --driver-log-levels=[PACKAGE=LEVEL,...] + A list of package-to-log4j log level pairs to configure driver logging. + For example: root=FATAL,com.example=INFO + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --max-failures-per-hour=MAX_FAILURES_PER_HOUR + Specifies the maximum number of times a job can be restarted per hour + in event of failure. Default is 0 (no retries after job failure). + + --max-failures-total=MAX_FAILURES_TOTAL + Specifies the maximum total number of times a job can be restarted + after the job fails. Default is 0 (no retries after job failure). + + --properties=[PARAM=VALUE,...] + A list of key value pairs to set Trino session properties. + + --properties-file=PROPERTIES_FILE + Path to a local file or a file in a Cloud Storage bucket containing + configuration properties for the job. The client machine running this + command must have read permission to the file. + + Specify properties in the form of property=value in the text file. For + example: + + # Properties to set for the job: + key1=value1 + key2=value2 + # Comment out properties not used. + # key3=value3 + + If a property is set in both --properties and --properties-file, the + value defined in --properties takes precedence. + + --query-output-format=QUERY_OUTPUT_FORMAT + The query output display format. See the Trino documentation for + supported output formats. + + --region=REGION + Dataproc region to use. Each Dataproc region constitutes an independent + resource namespace constrained to deploying instances into Compute + Engine zones inside the region. Overrides the default dataproc/region + property value for this command invocation. + +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 dataproc jobs submit trino + + $ gcloud alpha dataproc jobs submit trino + diff --git a/gcloud/beta/dataproc/workflow-templates/add-job/help b/gcloud/beta/dataproc/workflow-templates/add-job/help index 598e44606..4b722a796 100644 --- a/gcloud/beta/dataproc/workflow-templates/add-job/help +++ b/gcloud/beta/dataproc/workflow-templates/add-job/help @@ -69,6 +69,9 @@ COMMANDS spark-sql (BETA) Add a SparkSql job to the workflow template. + trino + (BETA) Add a Trino job to the workflow template. + NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/dataproc/workflow-templates/add-job/trino b/gcloud/beta/dataproc/workflow-templates/add-job/trino new file mode 100644 index 000000000..bdd4c2c73 --- /dev/null +++ b/gcloud/beta/dataproc/workflow-templates/add-job/trino @@ -0,0 +1,131 @@ +NAME + gcloud beta dataproc workflow-templates add-job trino - add a Trino job to + the workflow template + +SYNOPSIS + gcloud beta dataproc workflow-templates add-job trino --step-id=STEP_ID + (--execute=QUERY, -e QUERY | --file=FILE, -f FILE) + (--workflow-template=WORKFLOW_TEMPLATE : --region=REGION) + [--client-tags=[CLIENT_TAG,...]] [--continue-on-failure] + [--driver-log-levels=[PACKAGE=LEVEL,...]] [--labels=[KEY=VALUE,...]] + [--properties=[PARAM=VALUE,...]] [--properties-file=PROPERTIES_FILE] + [--query-output-format=QUERY_OUTPUT_FORMAT] + [--start-after=STEP_ID,[STEP_ID,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Add a Trino job to the workflow template. + +EXAMPLES + To add a Trino job that executes 'QUERY' to the workflow template + 'my-workflow-template' in the 'us-central1' region with 'my-step-id', + + run: + + $ gcloud beta dataproc workflow-templates add-job trino \ + --step-id=my-step_id -e=QUERY \ + --workflow-template=my-workflow-template --region=us-central1 + +REQUIRED FLAGS + --step-id=STEP_ID + The step ID of the job in the workflow template. + + Exactly one of these must be specified: + + --execute=QUERY, -e QUERY + A Trino query to execute. + + --file=FILE, -f FILE + HCFS URI of file containing the Trino script to execute. + + Template resource - The name of the workflow template to add job to. 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 --workflow-template 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. + + --workflow-template=WORKFLOW_TEMPLATE + ID of the template or fully qualified identifier for the template. To + set the template attribute: + ▸ provide the argument --workflow-template on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --region=REGION + Dataproc region for the template. Each Dataproc region constitutes an + independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument --workflow-template on the command line with + a fully specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +OPTIONAL FLAGS + --client-tags=[CLIENT_TAG,...] + A list of Trino client tags to attach to this query. + + --continue-on-failure + Whether to continue if a query fails. + + --driver-log-levels=[PACKAGE=LEVEL,...] + A list of package-to-log4j log level pairs to configure driver logging. + For example: root=FATAL,com.example=INFO + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --properties=[PARAM=VALUE,...] + A list of key value pairs to set Trino session properties. + + --properties-file=PROPERTIES_FILE + Path to a local file or a file in a Cloud Storage bucket containing + configuration properties for the job. The client machine running this + command must have read permission to the file. + + Specify properties in the form of property=value in the text file. For + example: + + # Properties to set for the job: + key1=value1 + key2=value2 + # Comment out properties not used. + # key3=value3 + + If a property is set in both --properties and --properties-file, the + value defined in --properties takes precedence. + + --query-output-format=QUERY_OUTPUT_FORMAT + The query output display format. See the Trino documentation for + supported output formats. + + --start-after=STEP_ID,[STEP_ID,...] + (Optional) List of step IDs to start this job after. + +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 dataproc workflow-templates add-job trino + + $ gcloud alpha dataproc workflow-templates add-job trino + diff --git a/gcloud/beta/deploy/releases/create b/gcloud/beta/deploy/releases/create index 55688e1b9..d7f2b0229 100644 --- a/gcloud/beta/deploy/releases/create +++ b/gcloud/beta/deploy/releases/create @@ -10,7 +10,9 @@ SYNOPSIS [--ignore-file=IGNORE_FILE] [--labels=[KEY=VALUE,...]] [--skaffold-version=SKAFFOLD_VERSION] [--to-target=TO_TARGET] [--build-artifacts=BUILD_ARTIFACTS | --images=[NAME=TAG,...]] - [--disable-initial-rollout | --enable-initial-rollout] + [--disable-initial-rollout | --enable-initial-rollout + --initial-rollout-annotations=[KEY=VALUE,...] + --initial-rollout-labels=[KEY=VALUE,...]] [--from-k8s-manifest=FROM_K8S_MANIFEST | --from-run-manifest=FROM_RUN_MANIFEST | --skaffold-file=SKAFFOLD_FILE --source=SOURCE; default="."] @@ -160,6 +162,28 @@ FLAGS Creates a rollout in the first target defined in the delivery pipeline. This is the default behavior. + --initial-rollout-annotations=[KEY=VALUE,...] + Annotations to apply to the initial rollout when creating the + release. Annotations take the form of key/value string pairs. + + Examples: + + Add annotations: + + $ gcloud beta deploy releases create \ + --initial-rollout-annotations="from_target=test,status=stable" + + --initial-rollout-labels=[KEY=VALUE,...] + Labels to apply to the initial rollout when creating the release. + Labels take the form of key/value string pairs. + + Examples: + + Add labels: + + $ gcloud beta deploy releases create \ + initial-rollout-labels="commit=abc123,author=foo" + At most one of these can be specified: --from-k8s-manifest=FROM_K8S_MANIFEST diff --git a/gcloud/beta/dns/record-sets/create b/gcloud/beta/dns/record-sets/create index 2b2ca60c3..42547ec78 100644 --- a/gcloud/beta/dns/record-sets/create +++ b/gcloud/beta/dns/record-sets/create @@ -119,7 +119,7 @@ REQUIRED FLAGS For --routing-policy-type = "WRR" this flag indicates the weighted round robin policy data. The field accepts a semicolon-delimited list of the format - "${weight_percent}:${rrdata},${rrdata}". Specify weight as a + "${weight_percent}=${rrdata},${rrdata}". Specify weight as a non-negative number (0 is allowed). Ratio of traffic routed to the target is calculated from the ratio of individual weight over the total across all weights. @@ -127,7 +127,7 @@ REQUIRED FLAGS For --routing-policy-type = "GEO" this flag indicates the geo-locations policy data. The field accepts a semicolon-delimited list of the format - "${region}:${rrdata},${rrdata}". Each individual rrdata can + "${region}=${rrdata},${rrdata}". Each individual rrdata can either be an ip address or a string of the format forwarding_config_name@region. diff --git a/gcloud/beta/dns/record-sets/update b/gcloud/beta/dns/record-sets/update index 956594eaa..473e363ac 100644 --- a/gcloud/beta/dns/record-sets/update +++ b/gcloud/beta/dns/record-sets/update @@ -86,7 +86,7 @@ REQUIRED FLAGS For --routing-policy-type = "WRR" this flag indicates the weighted round robin policy data. The field accepts a semicolon-delimited list of the format - "${weight_percent}:${rrdata},${rrdata}". Specify weight as a + "${weight_percent}=${rrdata},${rrdata}". Specify weight as a non-negative number (0 is allowed). Ratio of traffic routed to the target is calculated from the ratio of individual weight over the total across all weights. @@ -94,7 +94,7 @@ REQUIRED FLAGS For --routing-policy-type = "GEO" this flag indicates the geo-locations policy data. The field accepts a semicolon-delimited list of the format - "${region}:${rrdata},${rrdata}". Each individual rrdata can + "${region}=${rrdata},${rrdata}". Each individual rrdata can either be an ip address or a string of the format forwarding_config_name@region. diff --git a/gcloud/beta/firebase/test/android/run b/gcloud/beta/firebase/test/android/run index 4118ecf55..a5daa31cd 100644 --- a/gcloud/beta/firebase/test/android/run +++ b/gcloud/beta/firebase/test/android/run @@ -367,7 +367,7 @@ FLAGS is no greater than the total number of test cases. When you select one or more physical devices, the number of shards specified must be <= 50. When you select one or more ARM virtual devices, the number of - shards specified must be <= 50. When you select only x86 virtual + shards specified must be <= 100. When you select only x86 virtual devices, the number of shards specified must be <= 500. --test-targets-for-shard=TEST_TARGETS_FOR_SHARD @@ -375,7 +375,7 @@ FLAGS each shard (a group of test cases). Each time this flag is repeated, it creates a new shard. The shards are run in parallel on separate devices. You can repeat this flag up to 50 times when you select one - or more physical devices, up to 50 times when you select one or more + or more physical devices, up to 100 times when you select one or more ARM virtual devices, and up to 500 times when you select only x86 virtual devices. diff --git a/gcloud/beta/firebase/test/ios/run b/gcloud/beta/firebase/test/ios/run index adb4b477b..e2a1ba35d 100644 --- a/gcloud/beta/firebase/test/ios/run +++ b/gcloud/beta/firebase/test/ios/run @@ -13,9 +13,9 @@ SYNOPSIS [--other-files=DEVICE_PATH=FILE_PATH,[...]] [--record-video] [--results-bucket=RESULTS_BUCKET] [--results-dir=RESULTS_DIR] [--results-history-name=RESULTS_HISTORY_NAME] - [--scenario-numbers=int,[int,...]] [--test-special-entitlements] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + [--robo-script=ROBO_SCRIPT] [--scenario-numbers=int,[int,...]] + [--test-special-entitlements] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta firebase test ios run invokes and monitors tests in @@ -138,7 +138,8 @@ COMMONLY USED FLAGS ◆ --timeout 100 is 100 seconds --type=TYPE - The type of iOS test to run. TYPE must be one of: xctest, game-loop. + The type of iOS test to run. TYPE must be one of: xctest, game-loop, + robo. --xcode-version=XCODE_VERSION The version of Xcode that should be used to run an XCTest. Defaults to @@ -164,8 +165,8 @@ FLAGS --app=APP The path to the application archive (.ipa file) for game-loop testing. The path may be in the local filesystem or in Google Cloud Storage - using gs:// notation. This flag is only valid when --type=game-loop is - also set. + using gs:// notation. This flag is only valid when --type is game-loop + or robo. --async Invoke a test asynchronously without waiting for test results. @@ -240,6 +241,14 @@ FLAGS the same history name will have their results grouped together in the Firebase console in a time-ordered test history list. + --robo-script=ROBO_SCRIPT + The path to a Robo Script JSON file. The path may be in the local + filesystem or in Google Cloud Storage using gs:// notation. You can + guide the Robo test to perform specific actions by specifying a Robo + Script with this argument. Learn more at + https://firebase.google.com/docs/test-lab/robo-ux-test#scripting. This + flag is only valid when --type=robo is also set. + --scenario-numbers=int,[int,...] A list of game-loop scenario numbers which will be run as part of the test (default: scenario 1). A maximum of 1024 scenarios may be diff --git a/gcloud/beta/firestore/export b/gcloud/beta/firestore/export index d89b6d876..b6181b753 100644 --- a/gcloud/beta/firestore/export +++ b/gcloud/beta/firestore/export @@ -4,10 +4,12 @@ NAME SYNOPSIS gcloud beta firestore export OUTPUT_URI_PREFIX [--async] - [--collection-ids=[COLLECTION_IDS,...]] [GCLOUD_WIDE_FLAG ...] + [--collection-ids=[COLLECTION_IDS,...]] + [--database=DATABASE; default="(default)"] + [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) export Cloud Firestore documents to Google Cloud Storage + (BETA) export Cloud Firestore documents to Google Cloud Storage. EXAMPLES To export all collection groups to mybucket in objects prefixed with @@ -21,6 +23,11 @@ EXAMPLES --collection-ids='specific collection group1','specific collection group2' --async + To export all collection groups from certain namespace, run: + + $ gcloud beta firestore export gs://mybucket/my/path \ + --namespace-ids='specific namespace id' + POSITIONAL ARGUMENTS OUTPUT_URI_PREFIX Location where the export files will be stored. Must be a valid Google @@ -47,6 +54,24 @@ FLAGS $ gcloud beta firestore export --collection-ids='customers','orders' + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud beta firestore export --database='foo' + + --namespace-ids=[NAMESPACE_IDS,...] + A list specifying which namespaces will be included in the operation. + When omitted, all namespaces are included. + + This is only supported for Datastore Mode databases. + + For example, to operate on only the 'customers' and 'orders' + namespaces: + + $ gcloud beta firestore export --namespaces-ids='customers','orders' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/fields/ttls/list b/gcloud/beta/firestore/fields/ttls/list index 897f82fda..17ee80b76 100644 --- a/gcloud/beta/firestore/fields/ttls/list +++ b/gcloud/beta/firestore/fields/ttls/list @@ -4,9 +4,9 @@ NAME SYNOPSIS gcloud beta firestore fields ttls list - [--collection-group=COLLECTION_GROUP] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--collection-group=COLLECTION_GROUP --database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) List fields that give an expiration timestamp for documents in a @@ -21,22 +21,15 @@ FLAGS Collection group resource - Collection group of the ttl. This can be omitted to include fields across all collection groups - (kinds). 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: + (kinds). 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 --collection-group on the command line with a fully specified name; ◆ provide the argument [--collection-group] 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--collection-group] on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. --collection-group=COLLECTION_GROUP ID of the collection group or fully qualified identifier for the @@ -44,6 +37,17 @@ FLAGS ▸ provide the argument --collection-group on the command line; ▸ provide the argument [--collection-group] on the command line. + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/beta/firestore/fields/ttls/update b/gcloud/beta/firestore/fields/ttls/update index eb6822d59..5dad0a212 100644 --- a/gcloud/beta/firestore/fields/ttls/update +++ b/gcloud/beta/firestore/fields/ttls/update @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta firestore fields ttls update - (FIELD : --collection-group=COLLECTION_GROUP) + (FIELD : --collection-group=COLLECTION_GROUP --database=DATABASE) (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -35,12 +35,7 @@ POSITIONAL ARGUMENTS ◆ provide the argument field 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 - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. This must be specified. @@ -60,6 +55,15 @@ POSITIONAL ARGUMENTS specified name; ▸ provide the argument --collection-group on the command line. + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/beta/firestore/import b/gcloud/beta/firestore/import index 31b7b9665..3764969bb 100644 --- a/gcloud/beta/firestore/import +++ b/gcloud/beta/firestore/import @@ -4,10 +4,12 @@ NAME SYNOPSIS gcloud beta firestore import INPUT_URI_PREFIX [--async] - [--collection-ids=[COLLECTION_IDS,...]] [GCLOUD_WIDE_FLAG ...] + [--collection-ids=[COLLECTION_IDS,...]] + [--database=DATABASE; default="(default)"] + [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) import Cloud Firestore documents from Google Cloud Storage + (BETA) import Cloud Firestore documents from Google Cloud Storage. EXAMPLES To import all collection groups from mybucket/my/path, run: @@ -20,6 +22,11 @@ EXAMPLES --collection-ids='specific collection group1','specific collection group2' --async + To import all collection groups from certain namespace, run: + + $ gcloud beta firestore import gs://mybucket/my/path \ + --namespace-ids='specific namespace id' + POSITIONAL ARGUMENTS INPUT_URI_PREFIX Location of the import files. @@ -42,6 +49,24 @@ FLAGS $ gcloud beta firestore import --collection-ids='customers','orders' + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud beta firestore import --database='foo' + + --namespace-ids=[NAMESPACE_IDS,...] + A list specifying which namespaces will be included in the operation. + When omitted, all namespaces are included. + + This is only supported for Datastore Mode databases. + + For example, to operate on only the 'customers' and 'orders' + namespaces: + + $ gcloud beta firestore import --namespaces-ids='customers','orders' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/indexes/composite/create b/gcloud/beta/firestore/indexes/composite/create index b26bab3d9..6b630affc 100644 --- a/gcloud/beta/firestore/indexes/composite/create +++ b/gcloud/beta/firestore/indexes/composite/create @@ -3,9 +3,9 @@ NAME index SYNOPSIS - gcloud beta firestore indexes composite create - --collection-group=COLLECTION_GROUP --field-config=FIELD_CONFIG - [--async] [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore indexes composite create --field-config=FIELD_CONFIG + (--collection-group=COLLECTION_GROUP : --database=DATABASE) [--async] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create a new composite index. @@ -20,27 +20,12 @@ EXAMPLES --field-config=field-path=user-id,order=descending \ --field-config=field-path=timestamp,order=descending + $ gcloud beta firestore indexes composite create \ + --database=(default) --collection-group=Events \ + --field-config=field-path=user-id,order=descending \ + --field-config=field-path=timestamp,order=descending + REQUIRED FLAGS - Collection group resource - Collection group of the index. 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 --collection-group 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). - - This must be specified. - - --collection-group=COLLECTION_GROUP - ID of the collection group or fully qualified identifier for the - collection group. To set the collection-group attribute: - ▸ provide the argument --collection-group on the command line. - --field-config=FIELD_CONFIG Configuration for a field. @@ -67,6 +52,34 @@ REQUIRED FLAGS option is 'contains'. Exactly one of 'order' or 'array-config' must be specified. + Collection group resource - Collection group of the index. 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 --collection-group on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --collection-group=COLLECTION_GROUP + ID of the collection group or fully qualified identifier for the + collection group. To set the collection-group attribute: + ▸ provide the argument --collection-group on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/beta/firestore/indexes/composite/delete b/gcloud/beta/firestore/indexes/composite/delete index 2797a4b72..abcdf98bf 100644 --- a/gcloud/beta/firestore/indexes/composite/delete +++ b/gcloud/beta/firestore/indexes/composite/delete @@ -3,7 +3,8 @@ NAME index SYNOPSIS - gcloud beta firestore indexes composite delete INDEX [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore indexes composite delete + (INDEX : --database=DATABASE) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Delete the given composite index. @@ -13,20 +14,19 @@ EXAMPLES $ gcloud beta firestore indexes composite delete 3421ef + $ gcloud beta firestore indexes composite delete 3421ef \ + --database=(default) + POSITIONAL ARGUMENTS - Composite index resource - Index 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: + Composite index resource - Index 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 index 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 - database attribute: - ◆ provide the argument index on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). To set the collection-group - attribute: + collection-group attribute: ◆ provide the argument index on the command line with a fully specified name; ◆ provide the argument [--collection-group] on the command line. @@ -38,6 +38,18 @@ POSITIONAL ARGUMENTS composite index. To set the index attribute: ▸ provide the argument index on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + Database of the composite index. + + To set the database attribute: + ▸ provide the argument index on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/indexes/composite/describe b/gcloud/beta/firestore/indexes/composite/describe index 44e3a0c7e..594d2311b 100644 --- a/gcloud/beta/firestore/indexes/composite/describe +++ b/gcloud/beta/firestore/indexes/composite/describe @@ -3,8 +3,8 @@ NAME composite index SYNOPSIS - gcloud beta firestore indexes composite describe INDEX - [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore indexes composite describe + (INDEX : --database=DATABASE) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Describe the given composite index. @@ -14,20 +14,19 @@ EXAMPLES $ gcloud beta firestore indexes composite describe 3421ef + $ gcloud beta firestore indexes composite describe 3421ef \ + --database=(default) + POSITIONAL ARGUMENTS - Composite index resource - Index 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: + Composite index resource - Index 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 index 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 - database attribute: - ◆ provide the argument index on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). To set the collection-group - attribute: + collection-group attribute: ◆ provide the argument index on the command line with a fully specified name; ◆ provide the argument [--collection-group] on the command line. @@ -39,6 +38,18 @@ POSITIONAL ARGUMENTS composite index. To set the index attribute: ▸ provide the argument index on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + Database of the composite index. + + To set the database attribute: + ▸ provide the argument index on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/indexes/composite/list b/gcloud/beta/firestore/indexes/composite/list index 60df2c346..5aefe1d2d 100644 --- a/gcloud/beta/firestore/indexes/composite/list +++ b/gcloud/beta/firestore/indexes/composite/list @@ -2,9 +2,9 @@ NAME gcloud beta firestore indexes composite list - list composite indexes SYNOPSIS - gcloud beta firestore indexes composite list [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud beta firestore indexes composite list [--database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) List composite indexes. @@ -14,12 +14,34 @@ EXAMPLES $ gcloud beta firestore indexes composite list + $ gcloud beta firestore indexes composite list --database=(default) + The following command lists composite indexes in the Events collection group: $ gcloud beta firestore indexes composite list \ --filter=COLLECTION_GROUP:Events +FLAGS + Collection group resource - Collection group of the index. 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 [--collection-group] 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 + collection-group attribute: + ◆ provide the argument [--collection-group] on the command line. + + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/beta/firestore/indexes/fields/describe b/gcloud/beta/firestore/indexes/fields/describe index c2da244ea..7f4842e26 100644 --- a/gcloud/beta/firestore/indexes/fields/describe +++ b/gcloud/beta/firestore/indexes/fields/describe @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta firestore indexes fields describe - [[FIELD] --collection-group=COLLECTION_GROUP] [GCLOUD_WIDE_FLAG ...] + [[FIELD] --collection-group=COLLECTION_GROUP --database=DATABASE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Describe the index configuration of the given field. @@ -14,6 +15,8 @@ EXAMPLES $ gcloud beta firestore indexes fields describe + $ gcloud beta firestore indexes fields describe --database=(default) + The following command describes the index configuration of the timestamp field in the Events collection group. @@ -31,13 +34,7 @@ POSITIONAL ARGUMENTS name; ◆ with a fully specified name; ◆ set the property core/project; - ◆ provide the argument --project on the command line. To set the - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ with a fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. [FIELD] ID of the field or fully qualified identifier for the field. To set @@ -55,6 +52,16 @@ POSITIONAL ARGUMENTS ▸ provide the argument --collection-group on the command line; ▸ . + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/firestore/indexes/fields/list b/gcloud/beta/firestore/indexes/fields/list index 0253a3a33..3056ded3c 100644 --- a/gcloud/beta/firestore/indexes/fields/list +++ b/gcloud/beta/firestore/indexes/fields/list @@ -4,9 +4,9 @@ NAME SYNOPSIS gcloud beta firestore indexes fields list - [--collection-group=COLLECTION_GROUP] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--collection-group=COLLECTION_GROUP --database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) List fields that have had their index configurations exempted from @@ -18,6 +18,8 @@ EXAMPLES $ gcloud beta firestore indexes fields list + $ gcloud beta firestore indexes fields list --database=(default) + The following command lists fields with custom index settings in the Events collection group: @@ -34,23 +36,16 @@ EXAMPLES FLAGS Collection group resource - Collection group of the index. - This can be omitted to include fields across all collection groups. 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: + This can be omitted to include fields across all collection groups. 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 --collection-group on the command line with a fully specified name; ◆ provide the argument [--collection-group] 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--collection-group] on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. --collection-group=COLLECTION_GROUP ID of the collection group or fully qualified identifier for the @@ -58,6 +53,17 @@ FLAGS ▸ provide the argument --collection-group on the command line; ▸ provide the argument [--collection-group] on the command line. + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/beta/firestore/indexes/fields/update b/gcloud/beta/firestore/indexes/fields/update index 56685bd1d..53dd15cdd 100644 --- a/gcloud/beta/firestore/indexes/fields/update +++ b/gcloud/beta/firestore/indexes/fields/update @@ -4,9 +4,8 @@ NAME SYNOPSIS gcloud beta firestore indexes fields update - (FIELD : --collection-group=COLLECTION_GROUP) - (--clear-exemption | --disable-indexes - | --index=[array-config=ARRAY-CONFIG],[order=ORDER]) [--async] + (FIELD : --collection-group=COLLECTION_GROUP --database=DATABASE) + (--clear-exemption | --disable-indexes | --index=KEY=VALUE) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -22,6 +21,9 @@ EXAMPLES $ gcloud beta firestore indexes fields update timestamp \ --collection-group=Events --disable-indexes + $ gcloud beta firestore indexes fields update timestamp \ + --database=(default) --collection-group=Events --disable-indexes + The following command creates an exemption for the timestamp field in the Events collection group, in which the list of indexes is explicitly set to [ASCENDING, DESCENDING]: @@ -45,12 +47,7 @@ POSITIONAL ARGUMENTS ◆ provide the argument field 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 - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. This must be specified. @@ -70,6 +67,15 @@ POSITIONAL ARGUMENTS specified name; ▸ provide the argument --collection-group on the command line. + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + REQUIRED FLAGS Exactly one of these must be specified: @@ -80,7 +86,7 @@ REQUIRED FLAGS --disable-indexes If provided, the field will no longer be indexed at all. - --index=[array-config=ARRAY-CONFIG],[order=ORDER] + --index=KEY=VALUE An index for the field. This flag can be repeated to provide multiple indexes. Any existing diff --git a/gcloud/beta/functions/add-invoker-policy-binding b/gcloud/beta/functions/add-invoker-policy-binding index 7374bf463..bef65f79d 100644 --- a/gcloud/beta/functions/add-invoker-policy-binding +++ b/gcloud/beta/functions/add-invoker-policy-binding @@ -7,7 +7,7 @@ SYNOPSIS --member=PRINCIPAL [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) This command applies to Cloud Functions V2 only. + (BETA) This command applies to Cloud Functions 2nd gen only. EXAMPLES To add the invoker policy binding for FUNCTION-1 from role ROLE-1 for diff --git a/gcloud/beta/functions/deploy b/gcloud/beta/functions/deploy index 84b1ec74b..9f749a4dc 100644 --- a/gcloud/beta/functions/deploy +++ b/gcloud/beta/functions/deploy @@ -3,10 +3,10 @@ NAME SYNOPSIS gcloud beta functions deploy (NAME : --region=REGION) - [--allow-unauthenticated] [--docker-registry=DOCKER_REGISTRY] - [--egress-settings=EGRESS_SETTINGS] [--entry-point=ENTRY_POINT] - [--gen2] [--ignore-file=IGNORE_FILE] - [--ingress-settings=INGRESS_SETTINGS] [--memory=MEMORY] [--retry] + [--allow-unauthenticated] [--concurrency=CONCURRENCY] + [--docker-registry=DOCKER_REGISTRY] [--egress-settings=EGRESS_SETTINGS] + [--entry-point=ENTRY_POINT] [--gen2] [--ignore-file=IGNORE_FILE] + [--ingress-settings=INGRESS_SETTINGS] [--retry] [--run-service-account=RUN_SERVICE_ACCOUNT] [--runtime=RUNTIME] [--security-level=SECURITY_LEVEL; default="secure-always"] [--serve-all-traffic-latest-revision] @@ -38,6 +38,7 @@ SYNOPSIS /secret_path=SECRET_VALUE_REF, /mount_path:/secret_file_path=SECRET_VALUE_REF,...]] [--clear-vpc-connector | --vpc-connector=VPC_CONNECTOR] + [--memory=MEMORY : --cpu=CPU] [--trigger-bucket=TRIGGER_BUCKET | --trigger-http | --trigger-topic=TRIGGER_TOPIC | --trigger-event=EVENT_TYPE --trigger-resource=RESOURCE @@ -95,6 +96,11 @@ FLAGS If set, makes this a public function. This will allow all callers, without checking authentication. + --concurrency=CONCURRENCY + Set the maximum number of concurrent requests allowed per container + instance. Leave concurrency unspecified to receive the server default + value. Only applicable when the --gen2 flag is provided. + --docker-registry=DOCKER_REGISTRY Docker Registry to use for storing the function's Docker images. The option container-registry is used by default. @@ -132,22 +138,6 @@ FLAGS default all will be used. INGRESS_SETTINGS must be one of: all, internal-only, internal-and-gclb. - --memory=MEMORY - Limit on the amount of memory the function can use. - - Allowed values for v1 are: 128MB, 256MB, 512MB, 1024MB, 2048MB, 4096MB, - and 8192MB. - - Allowed values for GCF 2nd gen are in the format: with - allowed units of "k", "M", "G", "Ki", "Mi", "Gi". Ending 'b' or 'B' is - allowed. - - Examples: 100000k, 128M, 10Mb, 1024Mi, 750K, 4Gi. - - By default, a new function is limited to 256MB of memory. When - deploying an update to an existing function, the function keeps its old - memory limit unless you specify this flag. - --retry If specified, then the function will be retried in case of a failure. @@ -528,6 +518,38 @@ FLAGS ${CONNECTOR}, where ${CONNECTOR} is the short name of the VPC Access connector. + --memory=MEMORY + Limit on the amount of memory the function can use. + + Allowed values for v1 are: 128MB, 256MB, 512MB, 1024MB, 2048MB, 4096MB, + and 8192MB. + + Allowed values for GCF 2nd gen are in the format: with + allowed units of "k", "M", "G", "Ki", "Mi", "Gi". Ending 'b' or 'B' is + allowed. + + Examples: 100000k, 128M, 10Mb, 1024Mi, 750K, 4Gi. + + By default, a new function is limited to 256MB of memory. When + deploying an update to an existing function, the function keeps its old + memory limit unless you specify this flag. + + --cpu=CPU + The number of available CPUs to set. Only valid when --gen2 and + --memory=MEMORY are specified. + + Examples: .5, 2, 2.0, 2000m. + + By default, a new function's available CPUs is determined based on its + memory value. + + When deploying an update that includes memory changes to an existing + function, the function's available CPUs will be recalculated based on + the new memory unless this flag is specified. When deploying an update + that does not include memory changes to an existing function, the + function's "available CPUs" setting will keep its old value unless you + use this flag to change the setting. + If you don't specify a trigger when deploying an update to an existing function it will keep its current trigger. You must specify --trigger-topic, --trigger-bucket, --trigger-http, --trigger-event-filters diff --git a/gcloud/beta/functions/remove-invoker-policy-binding b/gcloud/beta/functions/remove-invoker-policy-binding index 47cd530a9..8e8457706 100644 --- a/gcloud/beta/functions/remove-invoker-policy-binding +++ b/gcloud/beta/functions/remove-invoker-policy-binding @@ -7,7 +7,7 @@ SYNOPSIS (NAME : --region=REGION) --member=PRINCIPAL [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) This command applies to Cloud Functions V2 only. + (BETA) This command applies to Cloud Functions 2nd gen only. EXAMPLES To remove the invoker policy binding for FUNCTION-1 from role ROLE-1 for diff --git a/gcloud/beta/healthcare/fhir-stores/import/gcs b/gcloud/beta/healthcare/fhir-stores/import/gcs index dacb6fe08..c9528c658 100644 --- a/gcloud/beta/healthcare/fhir-stores/import/gcs +++ b/gcloud/beta/healthcare/fhir-stores/import/gcs @@ -17,14 +17,14 @@ EXAMPLES the folder 'someFolder' into the FHIR store 'test-fhir-store', run: $ gcloud beta healthcare fhir-stores import gcs test-fhir-store \ - --gcs-uri=gs://testGcsBucket/someFolder --dataset=test-dataset + --gcs-uri=gs://testGcsBucket/someFolder/* --dataset=test-dataset To perform the same import, but importing resources with the content structure of 'RESOURCE', run: $ gcloud beta healthcare fhir-stores import gcs test-fhir-store \ - --gcs-uri=gs://testGcsBucket/someFolder --dataset=test-dataset \ - --content-structure=RESOURCE + --gcs-uri=gs://testGcsBucket/someFolder/* \ + --dataset=test-dataset --content-structure=RESOURCE POSITIONAL ARGUMENTS FhirStore resource - Cloud Healthcare API FHIR store into which the data @@ -64,7 +64,21 @@ REQUIRED FLAGS --gcs-uri=GCS_URI Cloud Storage source data locations. Each Cloud Storage object should be a text file that contains newline-delimited JSON structures - conforming to the FHIR standard. + conforming to the FHIR standard. You can use wildcards to import + multiple files from one or more directories. + ◆ Use * to match 0 or more non-separator characters. For example, + gs://BUCKET/DIRECTORY/Example*.ndjson matches Example.ndjson and + Example22.ndjson in DIRECTORY. + ◆ Use ** to match 0 or more characters (including separators). Must + be used at the end of a path and with no other wildcards in the path. + Can also be used with a filename extension (such as .ndjson), which + imports all files with the filename extension in the specified + directory and its subdirectories. For example, + gs://BUCKET/DIRECTORY/**.ndjson imports all files with the .ndjson + filename extension in DIRECTORY and its subdirectories. + ◆ Use ? to match 1 character. For example, + gs://BUCKET/DIRECTORY/Example?.ndjson matches Example1.ndjson but + does not match Example.ndjson or Example01.ndjson. OPTIONAL FLAGS --async diff --git a/gcloud/beta/iap/oauth-clients/create b/gcloud/beta/iap/oauth-clients/create index 956bdcdab..682d2eecf 100644 --- a/gcloud/beta/iap/oauth-clients/create +++ b/gcloud/beta/iap/oauth-clients/create @@ -1,5 +1,5 @@ NAME - gcloud beta iap oauth-clients create - create a Cloud IAP OAuth client for + gcloud beta iap oauth-clients create - create a Cloud IAP OAuth client in the project SYNOPSIS @@ -7,18 +7,18 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) gcloud beta iap oauth-clients create is used to create a Cloud IAP - OAuth client for the project. To call this command, the Cloud OAuth brand - for the project must exist and be set for 'internal only'. The client is - owned by Cloud IAP. + (BETA) gcloud beta iap oauth-clients create is used to create an OAuth + client in the project to be used by Cloud IAP. To call this command, the + Cloud OAuth brand for the project must exist and be set for 'internal + only'. The new client is owned by Cloud IAP. EXAMPLES - To create a Cloud OAuth client for the current project, run: + To create a Cloud IAP OAuth client for the current project, run: $ gcloud beta iap oauth-clients create BRAND \ --display_name=DISPLAY_NAME - To create a Cloud OAuth client for the project PROJECT_ID, run: + To create a Cloud IAP OAuth client for the project PROJECT_ID, run: $ gcloud beta iap oauth-clients create BRAND \ --display_name=DISPLAY_NAME --project=PROJECT_ID diff --git a/gcloud/beta/iap/oauth-clients/delete b/gcloud/beta/iap/oauth-clients/delete index b7e725bb1..1e9ec5d5c 100644 --- a/gcloud/beta/iap/oauth-clients/delete +++ b/gcloud/beta/iap/oauth-clients/delete @@ -7,15 +7,16 @@ SYNOPSIS DESCRIPTION (BETA) gcloud beta iap oauth-clients delete is used to delete a Cloud IAP - OAuth client. + OAuth client. Note this command cannot be used to delete any other type of + OAuth client in your project. EXAMPLES - To delete a Cloud OAuth client named CLIENT for the current project and + To delete a Cloud IAP OAuth client named CLIENT for the current project and brand BRAND, run: $ gcloud beta iap oauth-clients delete CLIENT --brand=BRAND - To delete a Cloud OAuth client named CLIENT for a specific project + To delete a Cloud IAP OAuth client named CLIENT for a specific project PROJECT_ID and brand BRAND, run: $ gcloud beta iap oauth-clients delete CLIENT --brand=BRAND \ diff --git a/gcloud/beta/iap/oauth-clients/describe b/gcloud/beta/iap/oauth-clients/describe index 8965b6446..a987ddb9c 100644 --- a/gcloud/beta/iap/oauth-clients/describe +++ b/gcloud/beta/iap/oauth-clients/describe @@ -7,14 +7,15 @@ SYNOPSIS DESCRIPTION (BETA) gcloud beta iap oauth-clients describe is used to describe a Cloud - IAP OAuth client. + IAP OAuth client. Note this command cannot be used to describe any other + type of OAuth client in your project. EXAMPLES - To describe a Cloud OAuth client for the current project, run: + To describe a Cloud IAP OAuth client for the current project, run: $ gcloud beta iap oauth-clients describe NAME - To describe a Cloud OAuth client for a specific brand, run: + To describe a Cloud IAP OAuth client for a specific brand, run: $ gcloud beta iap oauth-clients describe NAME --brand=BRAND diff --git a/gcloud/beta/iap/oauth-clients/help b/gcloud/beta/iap/oauth-clients/help index e3935cdf4..0f68777eb 100644 --- a/gcloud/beta/iap/oauth-clients/help +++ b/gcloud/beta/iap/oauth-clients/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud beta iap oauth-clients COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Manage IAP OAuth clients. + (BETA) Manage OAuth clients that are used by Cloud Identity-Aware Proxy. + Note this API cannot be used as a generic management API for all OAuth + clients in your project. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,7 +18,7 @@ COMMANDS COMMAND is one of the following: create - (BETA) Create a Cloud IAP OAuth client for the project. + (BETA) Create a Cloud IAP OAuth client in the project. delete (BETA) Delete a Cloud IAP OAuth client. diff --git a/gcloud/beta/iap/oauth-clients/list b/gcloud/beta/iap/oauth-clients/list index 1f64c8539..ef7679cf9 100644 --- a/gcloud/beta/iap/oauth-clients/list +++ b/gcloud/beta/iap/oauth-clients/list @@ -9,10 +9,11 @@ SYNOPSIS DESCRIPTION (BETA) gcloud beta iap oauth-clients list is used to list Cloud IAP OAuth - clients in a Cloud OAuth brand. + clients in a Cloud OAuth brand. Note this command will not list any other + type of OAuth client in your project. EXAMPLES - To list a Cloud OAuth client for the current project, run: + To list the Cloud IAP OAuth clients for the current project, run: $ gcloud beta iap oauth-clients list BRAND diff --git a/gcloud/beta/iap/oauth-clients/reset-secret b/gcloud/beta/iap/oauth-clients/reset-secret index cc942ed2b..e4a1e5c97 100644 --- a/gcloud/beta/iap/oauth-clients/reset-secret +++ b/gcloud/beta/iap/oauth-clients/reset-secret @@ -8,14 +8,15 @@ SYNOPSIS DESCRIPTION (BETA) gcloud beta iap oauth-clients reset-secret is used to reset a Cloud - IAP OAuth client secret. + IAP OAuth client secret. Note this command cannot be used to reset the + secret for any other type of OAuth client in your project. EXAMPLES - To reset a Cloud OAuth client secret, run: + To reset a Cloud IAP OAuth client secret, run: $ gcloud beta iap oauth-clients reset-secret NAME - To reset a Cloud OAuth client secret for a specific brand, run: + To reset a Cloud IAP OAuth client secret for a specific brand, run: $ gcloud beta iap oauth-clients reset-secret NAME --brand=BRAND diff --git a/gcloud/beta/ids/endpoints/create b/gcloud/beta/ids/endpoints/create index ce73c6956..be60d1611 100644 --- a/gcloud/beta/ids/endpoints/create +++ b/gcloud/beta/ids/endpoints/create @@ -5,7 +5,8 @@ SYNOPSIS gcloud beta ids endpoints create (ENDPOINT : --zone=ZONE) --network=NETWORK --severity=SEVERITY [--async] [--description=DESCRIPTION] [--enable-traffic-logs] [--labels=[KEY=VALUE,...]] - [--max-wait=MAX_WAIT; default="60m"] [GCLOUD_WIDE_FLAG ...] + [--max-wait=MAX_WAIT; default="60m"] + [--threat-exceptions=[exc1,exc2,...,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create an endpoint for the specified VPC network. Successful @@ -21,6 +22,14 @@ EXAMPLES $ gcloud beta ids endpoints create my-endpoint --network=my-net \ --zone=us-central1-a --project=my-project --severity=LOW + To create an endpoint called my-endpoint for VPC network my-net, in zone + us-central1-a, alerting on LOW threats or higher, excluding threat IDs 1000 + and 2000, run: + + $ gcloud beta ids endpoints create my-endpoint --network=my-net \ + --zone=us-central1-a --project=my-project --severity=LOW \ + --threat-exceptions=1000,2000 + POSITIONAL ARGUMENTS Endpoint resource - endpoint. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not @@ -83,6 +92,10 @@ OPTIONAL FLAGS specified. See $ gcloud topic datetimes for information on time formats. + --threat-exceptions=[exc1,exc2,...,...] + List of threat IDs to be excepted from alerting. Passing empty list + clears the exceptions. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/ids/endpoints/help b/gcloud/beta/ids/endpoints/help index 05213c411..8b95676ba 100644 --- a/gcloud/beta/ids/endpoints/help +++ b/gcloud/beta/ids/endpoints/help @@ -32,6 +32,9 @@ COMMANDS list (BETA) List Cloud IDS endpoints. + update + (BETA) Update an existing Cloud IDS endpoint. + NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/ids/endpoints/update b/gcloud/beta/ids/endpoints/update new file mode 100644 index 000000000..0d039e509 --- /dev/null +++ b/gcloud/beta/ids/endpoints/update @@ -0,0 +1,84 @@ +NAME + gcloud beta ids endpoints update - update an existing Cloud IDS endpoint + +SYNOPSIS + gcloud beta ids endpoints update (ENDPOINT : --zone=ZONE) [--async] + [--max-wait=MAX_WAIT; default="60m"] + [--threat-exceptions=[exc1,exc2,...,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update the endpoint for the specified VPC network. Check the + progress of endpoint update by using gcloud alpha ids endpoints list. + + For more examples, refer to the EXAMPLES section below. + +EXAMPLES + To update an endpoint called my-endpoint, excluding threat IDs 1000 and + 2000, run: + + $ gcloud beta ids endpoints update my-endpoint \ + --threat-exceptions=1000,2000 + + To update an endpoint called my-endpoint, clearing the excluded threat + list, run: + + $ gcloud beta ids endpoints update my-endpoint --threat-exceptions= + +POSITIONAL ARGUMENTS + Endpoint resource - endpoint. 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 endpoint 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. + + ENDPOINT + ID of the endpoint or fully qualified identifier for the endpoint. To + set the endpoint attribute: + ▸ provide the argument endpoint on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --zone=ZONE + Zone of the endpoint. To set the zone attribute: + ▸ provide the argument endpoint on the command line with a fully + specified name; + ▸ provide the argument --zone on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --max-wait=MAX_WAIT; default="60m" + Time to synchronously wait for the operation to complete, after which + the operation continues asynchronously. Ignored if --no-async isn't + specified. See $ gcloud topic datetimes for information on time + formats. + + --threat-exceptions=[exc1,exc2,...,...] + List of threat IDs to be excepted from alerting. Passing empty list + clears the exceptions. + +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 ids endpoints update + + $ gcloud alpha ids endpoints update + diff --git a/gcloud/beta/kms/keys/create b/gcloud/beta/kms/keys/create index 3541385c7..38c31bf04 100644 --- a/gcloud/beta/kms/keys/create +++ b/gcloud/beta/kms/keys/create @@ -162,7 +162,8 @@ OPTIONAL FLAGS https://cloud.google.com/kms/docs/algorithms. DEFAULT_ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, external-symmetric-encryption, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/beta/kms/keys/update b/gcloud/beta/kms/keys/update index f1bfc35a8..90b78089b 100644 --- a/gcloud/beta/kms/keys/update +++ b/gcloud/beta/kms/keys/update @@ -112,7 +112,8 @@ FLAGS https://cloud.google.com/kms/docs/algorithms. DEFAULT_ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, external-symmetric-encryption, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/beta/kms/keys/versions/import b/gcloud/beta/kms/keys/versions/import index f0762d652..74d6866c7 100644 --- a/gcloud/beta/kms/keys/versions/import +++ b/gcloud/beta/kms/keys/versions/import @@ -32,7 +32,8 @@ REQUIRED FLAGS about supported algorithms, see https://cloud.google.com/kms/docs/algorithms. ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/beta/logging/buckets/create b/gcloud/beta/logging/buckets/create index 4d7a9bbc3..76863f3f6 100644 --- a/gcloud/beta/logging/buckets/create +++ b/gcloud/beta/logging/buckets/create @@ -1,5 +1,5 @@ NAME - gcloud beta logging buckets create - creates a bucket + gcloud beta logging buckets create - create a bucket SYNOPSIS gcloud beta logging buckets create BUCKET_ID --location=LOCATION diff --git a/gcloud/beta/logging/buckets/delete b/gcloud/beta/logging/buckets/delete index c0a1a4e76..b37efc227 100644 --- a/gcloud/beta/logging/buckets/delete +++ b/gcloud/beta/logging/buckets/delete @@ -24,16 +24,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a bucket associated with this billing account. + Billing account of the bucket to delete. --folder=FOLDER_ID - Delete a bucket associated with this folder. + Folder of the bucket to delete. --organization=ORGANIZATION_ID - Delete a bucket associated with this organization. + Organization of the bucket to delete. --project=PROJECT_ID - Delete a bucket associated with this project. + Project of the bucket to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/buckets/describe b/gcloud/beta/logging/buckets/describe index 0b14c90e8..c65820a2a 100644 --- a/gcloud/beta/logging/buckets/describe +++ b/gcloud/beta/logging/buckets/describe @@ -1,5 +1,5 @@ NAME - gcloud beta logging buckets describe - displays information about a bucket + gcloud beta logging buckets describe - display information about a bucket SYNOPSIS gcloud beta logging buckets describe BUCKET_ID --location=LOCATION @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Displays information about a bucket. + (BETA) Display information about a bucket. EXAMPLES To describe a bucket in a project, run: @@ -27,16 +27,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a bucket associated with this billing account. + Billing account of the bucket to describe. --folder=FOLDER_ID - Describe a bucket associated with this folder. + Folder of the bucket to describe. --organization=ORGANIZATION_ID - Describe a bucket associated with this organization. + Organization of the bucket to describe. --project=PROJECT_ID - Describe a bucket associated with this project. + Project of the bucket to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/buckets/help b/gcloud/beta/logging/buckets/help index 46b37fb8c..b7db336da 100644 --- a/gcloud/beta/logging/buckets/help +++ b/gcloud/beta/logging/buckets/help @@ -18,22 +18,22 @@ COMMANDS COMMAND is one of the following: create - (BETA) Creates a bucket. + (BETA) Create a bucket. delete (BETA) Delete a bucket. describe - (BETA) Displays information about a bucket. + (BETA) Display information about a bucket. list - (BETA) Lists the defined buckets. + (BETA) List the defined buckets. undelete (BETA) Undelete a bucket. update - (BETA) Updates a bucket. + (BETA) Update a bucket. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/logging/buckets/list b/gcloud/beta/logging/buckets/list index ce25f01ab..a90602ba0 100644 --- a/gcloud/beta/logging/buckets/list +++ b/gcloud/beta/logging/buckets/list @@ -1,5 +1,5 @@ NAME - gcloud beta logging buckets list - lists the defined buckets + gcloud beta logging buckets list - list the defined buckets SYNOPSIS gcloud beta logging buckets list [--location=LOCATION] @@ -9,7 +9,7 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Lists the buckets for a project. + (BETA) List the buckets for a project. EXAMPLES To list the buckets in a project, run: @@ -24,16 +24,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List buckets associated with this billing account. + Billing account of the buckets to list. --folder=FOLDER_ID - List buckets associated with this folder. + Folder of the buckets to list. --organization=ORGANIZATION_ID - List buckets associated with this organization. + Organization of the buckets to list. --project=PROJECT_ID - List buckets associated with this project. + Project of the buckets to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/buckets/undelete b/gcloud/beta/logging/buckets/undelete index c68eb07f4..6de4fe127 100644 --- a/gcloud/beta/logging/buckets/undelete +++ b/gcloud/beta/logging/buckets/undelete @@ -24,16 +24,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Undelete a bucket associated with this billing account. + Billing account of the bucket to undelete. --folder=FOLDER_ID - Undelete a bucket associated with this folder. + Folder of the bucket to undelete. --organization=ORGANIZATION_ID - Undelete a bucket associated with this organization. + Organization of the bucket to undelete. --project=PROJECT_ID - Undelete a bucket associated with this project. + Project of the bucket to undelete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/buckets/update b/gcloud/beta/logging/buckets/update index 9c722d965..8c04400fd 100644 --- a/gcloud/beta/logging/buckets/update +++ b/gcloud/beta/logging/buckets/update @@ -1,5 +1,5 @@ NAME - gcloud beta logging buckets update - updates a bucket + gcloud beta logging buckets update - update a bucket SYNOPSIS gcloud beta logging buckets update BUCKET_ID --location=LOCATION @@ -11,7 +11,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Updates the properties of a bucket. + (BETA) Update the properties of a bucket. EXAMPLES To update a bucket in your project, run: diff --git a/gcloud/beta/logging/copy b/gcloud/beta/logging/copy index 2c7af10d1..e35c2c6c5 100644 --- a/gcloud/beta/logging/copy +++ b/gcloud/beta/logging/copy @@ -44,16 +44,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Copy log entries associated with this billing account. + Billing account of the log entries to copy. --folder=FOLDER_ID - Copy log entries associated with this folder. + Folder of the log entries to copy. --organization=ORGANIZATION_ID - Copy log entries associated with this organization. + Organization of the log entries to copy. --project=PROJECT_ID - Copy log entries associated with this project. + Project of the log entries to copy. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/locations/describe b/gcloud/beta/logging/locations/describe index 9d6a27aa8..1c916117b 100644 --- a/gcloud/beta/logging/locations/describe +++ b/gcloud/beta/logging/locations/describe @@ -24,16 +24,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a location associated with this billing account. + Billing account of the location to describe. --folder=FOLDER_ID - Describe a location associated with this folder. + Folder of the location to describe. --organization=ORGANIZATION_ID - Describe a location associated with this organization. + Organization of the location to describe. --project=PROJECT_ID - Describe a location associated with this project. + Project of the location to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/locations/list b/gcloud/beta/logging/locations/list index ae9d46959..6ab3f0be0 100644 --- a/gcloud/beta/logging/locations/list +++ b/gcloud/beta/logging/locations/list @@ -20,16 +20,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List locations associated with this billing account. + Billing account of the locations to list. --folder=FOLDER_ID - List locations associated with this folder. + Folder of the locations to list. --organization=ORGANIZATION_ID - List locations associated with this organization. + Organization of the locations to list. --project=PROJECT_ID - List locations associated with this project. + Project of the locations to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/logs/delete b/gcloud/beta/logging/logs/delete index 1dda248e5..433abb3d9 100644 --- a/gcloud/beta/logging/logs/delete +++ b/gcloud/beta/logging/logs/delete @@ -1,16 +1,17 @@ NAME - gcloud beta logging logs delete - deletes all entries from a log + gcloud beta logging logs delete - delete all entries from a log in the + _Default log bucket SYNOPSIS gcloud beta logging logs delete LOG_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Deletes all entries from a log. With no entries, the log will not - appear in the list of your project's logs. However, you can write new - entries to the log. + (BETA) Delete all entries from a log in the _Default log bucket. With no + entries, the log will not appear in the list of your project's logs. + However, you can write new entries to the log. EXAMPLES - To delete all entries from log 'my-log': + To delete all entries from log 'my-log' in the _Default log bucket: $ gcloud beta logging logs delete my-log diff --git a/gcloud/beta/logging/logs/help b/gcloud/beta/logging/logs/help index cf11b0114..5f5cb434e 100644 --- a/gcloud/beta/logging/logs/help +++ b/gcloud/beta/logging/logs/help @@ -16,10 +16,10 @@ COMMANDS COMMAND is one of the following: delete - (BETA) Deletes all entries from a log. + (BETA) Delete all entries from a log in the _Default log bucket. list - (BETA) Lists your project's logs. + (BETA) List your project's logs. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/logging/logs/list b/gcloud/beta/logging/logs/list index d2e845978..1538d54f9 100644 --- a/gcloud/beta/logging/logs/list +++ b/gcloud/beta/logging/logs/list @@ -1,5 +1,5 @@ NAME - gcloud beta logging logs list - lists your project's logs + gcloud beta logging logs list - list your project's logs SYNOPSIS gcloud beta logging logs list diff --git a/gcloud/beta/logging/metrics/create b/gcloud/beta/logging/metrics/create index c5d5e12e7..db7c3f2b7 100644 --- a/gcloud/beta/logging/metrics/create +++ b/gcloud/beta/logging/metrics/create @@ -1,5 +1,5 @@ NAME - gcloud beta logging metrics create - creates a logs-based metric + gcloud beta logging metrics create - create a logs-based metric SYNOPSIS gcloud beta logging metrics create METRIC_NAME @@ -8,7 +8,7 @@ SYNOPSIS : --bucket-name=BUCKET_NAME]) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Creates a logs-based metric to count the number of log entries that + (BETA) Create a logs-based metric to count the number of log entries that match a filter expression. Logs-based metrics can also be used to extract values from logs and create a distribution of the values. diff --git a/gcloud/beta/logging/metrics/delete b/gcloud/beta/logging/metrics/delete index cb8b847fe..5610e074c 100644 --- a/gcloud/beta/logging/metrics/delete +++ b/gcloud/beta/logging/metrics/delete @@ -1,11 +1,11 @@ NAME - gcloud beta logging metrics delete - deletes a logs-based metric + gcloud beta logging metrics delete - delete a logs-based metric SYNOPSIS gcloud beta logging metrics delete METRIC_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Deletes a logs-based metric called high_severity_count. + (BETA) Delete a logs-based metric called high_severity_count. EXAMPLES To delete a metric called high_severity_count, run: diff --git a/gcloud/beta/logging/metrics/describe b/gcloud/beta/logging/metrics/describe index 3847fd0dd..3c1269cc4 100644 --- a/gcloud/beta/logging/metrics/describe +++ b/gcloud/beta/logging/metrics/describe @@ -1,12 +1,12 @@ NAME - gcloud beta logging metrics describe - shows the definition of a logs-based - metric + gcloud beta logging metrics describe - display the definition of a + logs-based metric SYNOPSIS gcloud beta logging metrics describe METRIC_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Shows the definition of a logs-based metric. + (BETA) Show the definition of a logs-based metric. EXAMPLES To show the definition of a metric called high_severity_count, run: diff --git a/gcloud/beta/logging/metrics/help b/gcloud/beta/logging/metrics/help index 0cb3bacb3..1cc70c463 100644 --- a/gcloud/beta/logging/metrics/help +++ b/gcloud/beta/logging/metrics/help @@ -16,19 +16,19 @@ COMMANDS COMMAND is one of the following: create - (BETA) Creates a logs-based metric. + (BETA) Create a logs-based metric. delete - (BETA) Deletes a logs-based metric. + (BETA) Delete a logs-based metric. describe - (BETA) Shows the definition of a logs-based metric. + (BETA) Display the definition of a logs-based metric. list - (BETA) Displays all logs-based metrics. + (BETA) Display all logs-based metrics. update - (BETA) Updates the definition of a logs-based metric. + (BETA) Update the definition of a logs-based metric. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/logging/metrics/list b/gcloud/beta/logging/metrics/list index 74a9a52fe..99641d297 100644 --- a/gcloud/beta/logging/metrics/list +++ b/gcloud/beta/logging/metrics/list @@ -1,5 +1,5 @@ NAME - gcloud beta logging metrics list - displays all logs-based metrics + gcloud beta logging metrics list - display all logs-based metrics SYNOPSIS gcloud beta logging metrics list [--filter=EXPRESSION] [--limit=LIMIT] diff --git a/gcloud/beta/logging/metrics/update b/gcloud/beta/logging/metrics/update index a6a6ec7d4..998121cb8 100644 --- a/gcloud/beta/logging/metrics/update +++ b/gcloud/beta/logging/metrics/update @@ -1,5 +1,5 @@ NAME - gcloud beta logging metrics update - updates the definition of a logs-based + gcloud beta logging metrics update - update the definition of a logs-based metric SYNOPSIS @@ -9,7 +9,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Updates the description or the filter expression of an existing + (BETA) Update the description or the filter expression of an existing logs-based metric. EXAMPLES diff --git a/gcloud/beta/logging/operations/cancel b/gcloud/beta/logging/operations/cancel index a2d16c85f..85e0c2253 100644 --- a/gcloud/beta/logging/operations/cancel +++ b/gcloud/beta/logging/operations/cancel @@ -30,16 +30,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Cancel operation associated with this billing account. + Billing account of the operation to cancel. --folder=FOLDER_ID - Cancel operation associated with this folder. + Folder of the operation to cancel. --organization=ORGANIZATION_ID - Cancel operation associated with this organization. + Organization of the operation to cancel. --project=PROJECT_ID - Cancel operation associated with this project. + Project of the operation to cancel. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/operations/describe b/gcloud/beta/logging/operations/describe index 5faea5dec..203b7e409 100644 --- a/gcloud/beta/logging/operations/describe +++ b/gcloud/beta/logging/operations/describe @@ -1,5 +1,6 @@ NAME - gcloud beta logging operations describe - describe a long running operation + gcloud beta logging operations describe - display the information about a + long running operation SYNOPSIS gcloud beta logging operations describe OPERATION_ID --location=LOCATION @@ -8,10 +9,11 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Describe a long running operation which was scheduled before. For - example, a copy_log_entries operation scheduled by command: "gcloud alpha - logging copy BUCKET_ID DESTINATION --location=LOCATION" OPERATION_ID and - LOCATION are required to locate such operation. + (BETA) Display the information about a long running operation which was + scheduled before. For example, a copy_log_entries operation scheduled by + command: "gcloud alpha logging copy BUCKET_ID DESTINATION + --location=LOCATION" OPERATION_ID and LOCATION are required to locate such + operation. EXAMPLES To describe an operation, run: @@ -31,16 +33,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe operation associated with this billing account. + Billing account of the operation to describe. --folder=FOLDER_ID - Describe operation associated with this folder. + Folder of the operation to describe. --organization=ORGANIZATION_ID - Describe operation associated with this organization. + Organization of the operation to describe. --project=PROJECT_ID - Describe operation associated with this project. + Project of the operation to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/operations/help b/gcloud/beta/logging/operations/help index ebdbcb629..11efa2d37 100644 --- a/gcloud/beta/logging/operations/help +++ b/gcloud/beta/logging/operations/help @@ -19,7 +19,7 @@ COMMANDS (BETA) Cancel a long running operation. describe - (BETA) Describe a long running operation. + (BETA) Display the information about a long running operation. list (BETA) List long running operations. diff --git a/gcloud/beta/logging/operations/list b/gcloud/beta/logging/operations/list index 0bf1a4171..1e1d7b962 100644 --- a/gcloud/beta/logging/operations/list +++ b/gcloud/beta/logging/operations/list @@ -62,16 +62,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List operations associated with this billing account. + Billing account of the operations to list. --folder=FOLDER_ID - List operations associated with this folder. + Folder of the operations to list. --organization=ORGANIZATION_ID - List operations associated with this organization. + Organization of the operations to list. --project=PROJECT_ID - List operations associated with this project. + Project of the operations to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/read b/gcloud/beta/logging/read index eef4bbddc..d6b733706 100644 --- a/gcloud/beta/logging/read +++ b/gcloud/beta/logging/read @@ -6,7 +6,8 @@ SYNOPSIS [--order=ORDER; default="desc"] [--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID | --organization=ORGANIZATION_ID | --project=PROJECT_ID] - [--bucket=BUCKET --location=LOCATION --view=VIEW] [--limit=LIMIT] + [--resource-names=[RESOURCE,...] + | --bucket=BUCKET --location=LOCATION --view=VIEW] [--limit=LIMIT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -49,13 +50,13 @@ EXAMPLES $ gcloud beta logging read --bucket= \ --location=[LOCATION] --limit=1 - To read a log entry from the global Required log bucket using the bucket's - Default log view: + To read a log entry from the global _Required log bucket using the bucket's + _Default log view: $ gcloud beta logging read "" --bucket=_Required --location=global \ --view=_Default --limit=1 - To read a log entry from a log bucket using the bucket's AllLogs log view: + To read a log entry from a log bucket using the bucket's _AllLogs log view: $ gcloud beta logging read "" --bucket=[BUCKET_ID] \ --location=[LOCATION] --view=_AllLogs --limit=1 @@ -66,6 +67,15 @@ EXAMPLES $ gcloud beta logging read "" --bucket=[BUCKET_ID] \ --location=[LOCATION] --view=[VIEW_ID] --limit=1 + To read log entries from multiple resources, specify them as a + comma-delimeted sequence with --resource-names. Each resource name can be + specified either as a top-level resource (e.g., projects/[PROJECT_ID], + folders/[FOLDER_ID], etc.) or as a Log View resource (e.g., + projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_NAME]/views/[VIEW_ID]). + + $ gcloud beta logging read "" \ + --resource-names=[RESOURCE-1],[RESOURCE-2] + POSITIONAL ARGUMENTS [LOG_FILTER] Filter expression that specifies the log entries to return. Detailed @@ -85,16 +95,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Read log entries associated with this billing account. + Billing account of the log entries to read. --folder=FOLDER_ID - Read log entries associated with this folder. + Folder of the log entries to read. --organization=ORGANIZATION_ID - Read log entries associated with this organization. + Organization of the log entries to read. --project=PROJECT_ID - Read log entries associated with this project. + Project of the log entries to read. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be @@ -107,29 +117,38 @@ FLAGS and billing. To specify a different project for quota and billing, use --billing-project or billing/quota_project property. - These arguments are used in conjunction with the parent to construct a - view resource. + At most one of these can be specified: - --bucket=BUCKET - Id of the log bucket. If this argument is provided then --location - and --view must also be specified. + --resource-names=[RESOURCE,...] + Resource name(s) to read logs from. A resource can either be an + top-level resource (e.g., "projects/my-project") or a full log view + resource path (e.g., + "projects/my-project/locations/my-location/buckets/my-bucket/views/my-view"). + Multiple resources can be specified, separated by a comma. - This flag argument must be specified if any of the other arguments in - this group are specified. + These arguments are used in conjunction with the parent to construct a + view resource. - --location=LOCATION - Location of the log bucket. If this argument is provided then - --bucket and --view must also be specified. + --bucket=BUCKET + Id of the log bucket. If this argument is provided then --location + and --view must also be specified. - This flag argument must be specified if any of the other arguments in - this group are specified. + This flag argument must be specified if any of the other arguments + in this group are specified. - --view=VIEW - Id of the view. If this argument is provided then --location and - --bucket must also be specified. + --location=LOCATION + Location of the log bucket. If this argument is provided then + --bucket and --view must also be specified. - This flag argument must be specified if any of the other arguments in - this group are specified. + This flag argument must be specified if any of the other arguments + in this group are specified. + + --view=VIEW + Id of the view. If this argument is provided then --location and + --bucket must also be specified. + + This flag argument must be specified if any of the other arguments + in this group are specified. LIST COMMAND FLAGS --limit=LIMIT diff --git a/gcloud/beta/logging/resource-descriptors/help b/gcloud/beta/logging/resource-descriptors/help index 1f1179edf..281ec421f 100644 --- a/gcloud/beta/logging/resource-descriptors/help +++ b/gcloud/beta/logging/resource-descriptors/help @@ -17,7 +17,7 @@ COMMANDS COMMAND is one of the following: list - (BETA) Lists all available resource descriptors. + (BETA) List all available resource descriptors. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/logging/resource-descriptors/list b/gcloud/beta/logging/resource-descriptors/list index 93ad78fc1..74f690e64 100644 --- a/gcloud/beta/logging/resource-descriptors/list +++ b/gcloud/beta/logging/resource-descriptors/list @@ -1,13 +1,13 @@ NAME - gcloud beta logging resource-descriptors list - lists all available - resource descriptors + gcloud beta logging resource-descriptors list - list all available resource + descriptors SYNOPSIS gcloud beta logging resource-descriptors list [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Lists all available resource descriptors that are used by Cloud + (BETA) List all available resource descriptors that are used by Cloud Logging. Each log entry must be associated with a valid resource descriptor. diff --git a/gcloud/beta/logging/settings/describe b/gcloud/beta/logging/settings/describe index e5e214a5d..be4f32020 100644 --- a/gcloud/beta/logging/settings/describe +++ b/gcloud/beta/logging/settings/describe @@ -1,5 +1,5 @@ NAME - gcloud beta logging settings describe - displays the settings for the Cloud + gcloud beta logging settings describe - display the settings for the Cloud Logging Logs Router SYNOPSIS @@ -33,16 +33,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe settings associated with this billing account. + Billing account of the settings to describe. --folder=FOLDER_ID - Describe settings associated with this folder. + Folder of the settings to describe. --organization=ORGANIZATION_ID - Describe settings associated with this organization. + Organization of the settings to describe. --project=PROJECT_ID - Describe settings associated with this project. + Project of the settings to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/settings/help b/gcloud/beta/logging/settings/help index 1e81e12a7..d02ed001b 100644 --- a/gcloud/beta/logging/settings/help +++ b/gcloud/beta/logging/settings/help @@ -17,10 +17,10 @@ COMMANDS COMMAND is one of the following: describe - (BETA) Displays the settings for the Cloud Logging Logs Router. + (BETA) Display the settings for the Cloud Logging Logs Router. update - (BETA) Updates the settings for the Cloud Logging Logs Router. + (BETA) Update the settings for the Cloud Logging Logs Router. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/logging/settings/update b/gcloud/beta/logging/settings/update index 4817fbb1a..eaca0c3aa 100644 --- a/gcloud/beta/logging/settings/update +++ b/gcloud/beta/logging/settings/update @@ -1,5 +1,5 @@ NAME - gcloud beta logging settings update - updates the settings for the Cloud + gcloud beta logging settings update - update the settings for the Cloud Logging Logs Router SYNOPSIS @@ -69,13 +69,13 @@ REQUIRED FLAGS OPTIONAL FLAGS --disable-default-sink - Enable or disable Default sink for the Default bucket. Specify - --no-disable-default-sink to enable a disabled Default sink. Note: It + Enable or disable _Default sink for the _Default bucket. Specify + --no-disable-default-sink to enable a disabled _Default sink. Note: It only applies to the newly created projects and will not affect the projects created before. --storage-location=STORAGE_LOCATION - Update the storage location for Default bucket and Required bucket. + Update the storage location for _Default bucket and _Required bucket. Note: It only applies to the newly created projects and will not affect the projects created before. diff --git a/gcloud/beta/logging/sinks/create b/gcloud/beta/logging/sinks/create index 6894fb782..16888f8be 100644 --- a/gcloud/beta/logging/sinks/create +++ b/gcloud/beta/logging/sinks/create @@ -1,5 +1,5 @@ NAME - gcloud beta logging sinks create - creates a log sink + gcloud beta logging sinks create - create a log sink SYNOPSIS gcloud beta logging sinks create SINK_NAME DESTINATION @@ -12,8 +12,8 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Creates a log used to route log entries to a destination. The sink - routes all log entries that match its --log-filter flag. + (BETA) Create a log sink used to route log entries to a destination. The + sink routes all log entries that match its --log-filter flag. An empty filter matches all logs. @@ -118,16 +118,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Create a sink associated with this billing account. + Billing account of the sink to create. --folder=FOLDER_ID - Create a sink associated with this folder. + Folder of the sink to create. --organization=ORGANIZATION_ID - Create a sink associated with this organization. + Organization of the sink to create. --project=PROJECT_ID - Create a sink associated with this project. + Project of the sink to create. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/sinks/delete b/gcloud/beta/logging/sinks/delete index 7f8605d68..9adf0ac08 100644 --- a/gcloud/beta/logging/sinks/delete +++ b/gcloud/beta/logging/sinks/delete @@ -1,5 +1,5 @@ NAME - gcloud beta logging sinks delete - deletes a sink + gcloud beta logging sinks delete - delete a sink SYNOPSIS gcloud beta logging sinks delete SINK_NAME @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Deletes a sink and halts the export of log entries associated with + (BETA) Delete a sink and halt the export of log entries associated with that sink. Deleting a sink does not affect log entries already exported through the deleted sink, and will not affect other sinks that are exporting the same log(s). @@ -26,16 +26,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a sink associated with this billing account. + Billing account of the sink to delete. --folder=FOLDER_ID - Delete a sink associated with this folder. + Folder of the sink to delete. --organization=ORGANIZATION_ID - Delete a sink associated with this organization. + Organization of the sink to delete. --project=PROJECT_ID - Delete a sink associated with this project. + Project of the sink to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/sinks/describe b/gcloud/beta/logging/sinks/describe index caf4f07f5..c7fe81912 100644 --- a/gcloud/beta/logging/sinks/describe +++ b/gcloud/beta/logging/sinks/describe @@ -1,5 +1,5 @@ NAME - gcloud beta logging sinks describe - displays information about a sink + gcloud beta logging sinks describe - display information about a sink SYNOPSIS gcloud beta logging sinks describe SINK_NAME @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Displays information about a sink. + (BETA) Display information about a sink. EXAMPLES To describe a sync 'my-bq-sync': @@ -23,16 +23,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a sink associated with this billing account. + Billing account of the sink to describe. --folder=FOLDER_ID - Describe a sink associated with this folder. + Folder of the sink to describe. --organization=ORGANIZATION_ID - Describe a sink associated with this organization. + Organization of the sink to describe. --project=PROJECT_ID - Describe a sink associated with this project. + Project of the sink to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/sinks/help b/gcloud/beta/logging/sinks/help index d66139ace..0f4ce79d2 100644 --- a/gcloud/beta/logging/sinks/help +++ b/gcloud/beta/logging/sinks/help @@ -17,19 +17,19 @@ COMMANDS COMMAND is one of the following: create - (BETA) Creates a log sink. + (BETA) Create a log sink. delete - (BETA) Deletes a sink. + (BETA) Delete a sink. describe - (BETA) Displays information about a sink. + (BETA) Display information about a sink. list - (BETA) Lists the defined sinks. + (BETA) List the defined sinks. update - (BETA) Updates a sink. + (BETA) Update a sink. NOTES This command is currently in beta and might change without notice. These diff --git a/gcloud/beta/logging/sinks/list b/gcloud/beta/logging/sinks/list index f8c19a7bc..9a0c6386a 100644 --- a/gcloud/beta/logging/sinks/list +++ b/gcloud/beta/logging/sinks/list @@ -1,5 +1,5 @@ NAME - gcloud beta logging sinks list - lists the defined sinks + gcloud beta logging sinks list - list the defined sinks SYNOPSIS gcloud beta logging sinks list @@ -9,7 +9,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Lists the defined sinks. + (BETA) List the defined sinks. EXAMPLES To list all defined sinks: @@ -20,16 +20,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List sinks associated with this billing account. + Billing account of the sinks to list. --folder=FOLDER_ID - List sinks associated with this folder. + Folder of the sinks to list. --organization=ORGANIZATION_ID - List sinks associated with this organization. + Organization of the sinks to list. --project=PROJECT_ID - List sinks associated with this project. + Project of the sinks to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/sinks/update b/gcloud/beta/logging/sinks/update index b6baee3ee..d3d9b1b50 100644 --- a/gcloud/beta/logging/sinks/update +++ b/gcloud/beta/logging/sinks/update @@ -1,5 +1,5 @@ NAME - gcloud beta logging sinks update - updates a sink + gcloud beta logging sinks update - update a sink SYNOPSIS gcloud beta logging sinks update SINK_NAME [DESTINATION] @@ -15,9 +15,9 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Changes the [DESTINATION] or --log-filter associated with a sink. - The new destination must already exist and Cloud Logging must have - permission to write to it. + (BETA) Change the [DESTINATION] or --log-filter associated with a sink. The + new destination must already exist and Cloud Logging must have permission + to write to it. Log entries are exported to the new destination immediately. @@ -117,16 +117,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Update a sink associated with this billing account. + Billing account of the sink to update. --folder=FOLDER_ID - Update a sink associated with this folder. + Folder of the sink to update. --organization=ORGANIZATION_ID - Update a sink associated with this organization. + Organization of the sink to update. --project=PROJECT_ID - Update a sink associated with this project. + Project of the sink to update. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/tail b/gcloud/beta/logging/tail index 55c0e99d9..c7f609cd4 100644 --- a/gcloud/beta/logging/tail +++ b/gcloud/beta/logging/tail @@ -76,16 +76,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Tail log entries associated with this billing account. + Billing account of the log entries to tail. --folder=FOLDER_ID - Tail log entries associated with this folder. + Folder of the log entries to tail. --organization=ORGANIZATION_ID - Tail log entries associated with this organization. + Organization of the log entries to tail. --project=PROJECT_ID - Tail log entries associated with this project. + Project of the log entries to tail. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/views/create b/gcloud/beta/logging/views/create index 0d67bb3b9..47ac087af 100644 --- a/gcloud/beta/logging/views/create +++ b/gcloud/beta/logging/views/create @@ -37,16 +37,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Create view associated with this billing account. + Billing account of the view to create. --folder=FOLDER_ID - Create view associated with this folder. + Folder of the view to create. --organization=ORGANIZATION_ID - Create view associated with this organization. + Organization of the view to create. --project=PROJECT_ID - Create view associated with this project. + Project of the view to create. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/views/delete b/gcloud/beta/logging/views/delete index 1c7ce9e91..36d25c261 100644 --- a/gcloud/beta/logging/views/delete +++ b/gcloud/beta/logging/views/delete @@ -32,16 +32,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a bucket associated with this billing account. + Billing account of the view to delete. --folder=FOLDER_ID - Delete a bucket associated with this folder. + Folder of the view to delete. --organization=ORGANIZATION_ID - Delete a bucket associated with this organization. + Organization of the view to delete. --project=PROJECT_ID - Delete a bucket associated with this project. + Project of the view to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/views/describe b/gcloud/beta/logging/views/describe index da435bffc..f3618d6cd 100644 --- a/gcloud/beta/logging/views/describe +++ b/gcloud/beta/logging/views/describe @@ -32,16 +32,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a view associated with this billing account. + Billing account of the view to describe. --folder=FOLDER_ID - Describe a view associated with this folder. + Folder of the view to describe. --organization=ORGANIZATION_ID - Describe a view associated with this organization. + Organization of the view to describe. --project=PROJECT_ID - Describe a view associated with this project. + Project of the view to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/views/list b/gcloud/beta/logging/views/list index 2b0d23a80..d8a90946c 100644 --- a/gcloud/beta/logging/views/list +++ b/gcloud/beta/logging/views/list @@ -27,16 +27,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List views associated with this billing account. + Billing account of the views to list. --folder=FOLDER_ID - List views associated with this folder. + Folder of the views to list. --organization=ORGANIZATION_ID - List views associated with this organization. + Organization of the views to list. --project=PROJECT_ID - List views associated with this project. + Project of the views to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/views/update b/gcloud/beta/logging/views/update index 277d294d1..85f993204 100644 --- a/gcloud/beta/logging/views/update +++ b/gcloud/beta/logging/views/update @@ -39,16 +39,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Update view associated with this billing account. + Billing account of the view to update. --folder=FOLDER_ID - Update view associated with this folder. + Folder of the view to update. --organization=ORGANIZATION_ID - Update view associated with this organization. + Organization of the view to update. --project=PROJECT_ID - Update view associated with this project. + Project of the view to update. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/logging/write b/gcloud/beta/logging/write index 1f8f5ec89..7673fbd85 100644 --- a/gcloud/beta/logging/write +++ b/gcloud/beta/logging/write @@ -54,16 +54,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Write log entries associated with this billing account. + Billing account of the log entries to write. --folder=FOLDER_ID - Write log entries associated with this folder. + Folder of the log entries to write. --organization=ORGANIZATION_ID - Write log entries associated with this organization. + Organization of the log entries to write. --project=PROJECT_ID - Write log entries associated with this project. + Project of the log entries to write. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/beta/metastore/services/alter-metadata-resource-location b/gcloud/beta/metastore/services/alter-metadata-resource-location new file mode 100644 index 000000000..8845083c3 --- /dev/null +++ b/gcloud/beta/metastore/services/alter-metadata-resource-location @@ -0,0 +1,92 @@ +NAME + gcloud beta metastore services alter-metadata-resource-location - alter + metadata resource location + +SYNOPSIS + gcloud beta metastore services alter-metadata-resource-location + (SERVICE : --location=LOCATION) --location_uri=LOCATION_URI + --resource_name=RESOURCE_NAME [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Alter metadata resource location from a Dataproc Metastore service's + underlying metadata store. + + If run asynchronously with --async, exits after printing one operation name + that can be used to poll the status of the creation via: + + gcloud metastore operations describe + +EXAMPLES + To alter metadata resource location with the resource_name + databases/{database_id} or databases/{database_id}/tables/{table_id} or and + location_uri in location us-central, run: + + $ gcloud beta metastore services alter-metadata-resource-location \ + my-metastore-service --location=us-central1 \ + --resource_name=databases/my-db \ + --location_uri=gs://destination_bucket/destination_object + +POSITIONAL ARGUMENTS + Service resource - Arguments and flags that specify the resource and the + location you want to alter. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataproc Metastore service. + + If not specified, will use default metastore/location. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property metastore/location. + +REQUIRED FLAGS + --location_uri=LOCATION_URI + The new location URI for the metadata resource. + + --resource_name=RESOURCE_NAME + The relative metadata resource name in the following format. + databases/{database_id} or databases/{database_id}/tables/{table_id} or + databases/{database_id}/tables/{table_id}/partitions/{partition_id} + +OPTIONAL 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 metastore/v1beta API. The full documentation for this + API can be found at: https://cloud.google.com/dataproc-metastore/docs + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha metastore services alter-metadata-resource-location + diff --git a/gcloud/beta/metastore/services/help b/gcloud/beta/metastore/services/help index 433dfecba..b3d72082e 100644 --- a/gcloud/beta/metastore/services/help +++ b/gcloud/beta/metastore/services/help @@ -37,6 +37,9 @@ COMMANDS add-iam-policy-binding (BETA) Add an IAM policy binding to a service. + alter-metadata-resource-location + (BETA) Alter metadata resource location. + create (BETA) Create a Dataproc Metastore service. @@ -52,6 +55,13 @@ COMMANDS list (BETA) List Dataproc Metastore services. + move-table-to-database + (BETA) Move table to another database. + + query-metadata + (BETA) Execute a SQL query against a Dataproc Metastore Service's + metadata. + remove-iam-policy-binding (BETA) Remove an IAM policy binding from a service. diff --git a/gcloud/beta/metastore/services/move-table-to-database b/gcloud/beta/metastore/services/move-table-to-database new file mode 100644 index 000000000..6bcc0843f --- /dev/null +++ b/gcloud/beta/metastore/services/move-table-to-database @@ -0,0 +1,95 @@ +NAME + gcloud beta metastore services move-table-to-database - move table to + another database + +SYNOPSIS + gcloud beta metastore services move-table-to-database + (SERVICE : --location=LOCATION) + --destination_db_name=DESTINATION_DB_NAME + --source_db_name=SOURCE_DB_NAME --table_name=TABLE_NAME [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Move table to another database from a Dataproc Metastore service's + underlying metadata store. + + If run asynchronously with --async, exits after printing one operation name + that can be used to poll the status of the creation via: + + gcloud metastore operations describe + +EXAMPLES + To move table to database with the table_name, source_db_name, and + destination_db_name in location us-central, run: + + $ gcloud beta metastore services move-table-to-database \ + my-metastore-service --location=us-central1 \ + --table_name=table_name_to_move \ + --source_db_name=database_name_to_move \ + --destination_db_name=destination_database_name + +POSITIONAL ARGUMENTS + Service resource - Arguments and flags that specify the table and the + destination database you want to move to. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the Dataproc Metastore service. + + If not specified, will use default metastore/location. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property metastore/location. + +REQUIRED FLAGS + --destination_db_name=DESTINATION_DB_NAME + The name of the database where the table should be moved. + + --source_db_name=SOURCE_DB_NAME + The name of the database where the table resides. + + --table_name=TABLE_NAME + The name of the table to be moved. + +OPTIONAL 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 metastore/v1beta API. The full documentation for this + API can be found at: https://cloud.google.com/dataproc-metastore/docs + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha metastore services move-table-to-database + diff --git a/gcloud/beta/metastore/services/query-metadata b/gcloud/beta/metastore/services/query-metadata new file mode 100644 index 000000000..307852df3 --- /dev/null +++ b/gcloud/beta/metastore/services/query-metadata @@ -0,0 +1,79 @@ +NAME + gcloud beta metastore services query-metadata - execute a SQL query against + a Dataproc Metastore Service's metadata + +SYNOPSIS + gcloud beta metastore services query-metadata + (SERVICE : --location=LOCATION) --query=QUERY [--format=FORMAT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Execute a SQL query against a Dataproc Metastore Service's metadata. + +EXAMPLES + To query metadata against a Dataproc Metastore service with the name + my-metastore-service in location us-central1, and the sql query "show + tables;", run: + + $ gcloud beta metastore services query-metadata \ + my-metastore-service --location=us-central1 \ + --query="show tables;" + +POSITIONAL ARGUMENTS + Service resource - The service to query metadata. 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 service 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. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location to which the service belongs. To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property metastore/location. + +REQUIRED FLAGS + --query=QUERY + Use Google Standard SQL query for Cloud Spanner and MySQL query syntax + for Cloud SQL. Cloud Spanner SQL is described at + https://cloud.google.com/spanner/docs/query-syntax)" + +COMMONLY USED FLAGS + --format=FORMAT + Sets the format for printing command output resources. The default is a + command-specific human-friendly output format. If both core/format and + --format are specified, --format takes precedence. --format and + core/format both take precedence over core/default_format. The + supported formats are limited to: config, csv, default, diff, disable, + flattened, get, json, list, multi, none, object, table, text, value, + yaml. For more details run $ gcloud topic formats. Run $ gcloud config + set --help to see more information about core/format + +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. This + variant is also available: + + $ gcloud alpha metastore services query-metadata + diff --git a/gcloud/beta/ml/speech/recognize b/gcloud/beta/ml/speech/recognize index e478d02d8..0cf4c0ef7 100644 --- a/gcloud/beta/ml/speech/recognize +++ b/gcloud/beta/ml/speech/recognize @@ -72,7 +72,7 @@ OPTIONAL FLAGS --filter-profanity If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, - e.g. "f**". + e.g. f***. --hints=[HINT,...] A list of strings containing word and phrase "hints" so that the speech diff --git a/gcloud/beta/ml/speech/recognize-long-running b/gcloud/beta/ml/speech/recognize-long-running index 0819d255f..548d928e2 100644 --- a/gcloud/beta/ml/speech/recognize-long-running +++ b/gcloud/beta/ml/speech/recognize-long-running @@ -81,7 +81,7 @@ OPTIONAL FLAGS --filter-profanity If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, - e.g. "f**". + e.g. f***. --hints=[HINT,...] A list of strings containing word and phrase "hints" so that the speech diff --git a/gcloud/beta/ml/video/transcribe-speech b/gcloud/beta/ml/video/transcribe-speech index 89c02905a..ed6b1456b 100644 --- a/gcloud/beta/ml/video/transcribe-speech +++ b/gcloud/beta/ml/video/transcribe-speech @@ -70,7 +70,7 @@ OPTIONAL FLAGS --filter-profanity If enabled, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with - asterisks, e.g. "f**". If disabled or omitted, profanities will not be + asterisks, e.g. f***. If disabled or omitted, profanities will not be filtered out. --hints=[HINTS,...] diff --git a/gcloud/beta/network-management/connectivity-tests/create b/gcloud/beta/network-management/connectivity-tests/create index cdf3d2b73..eadcec014 100644 --- a/gcloud/beta/network-management/connectivity-tests/create +++ b/gcloud/beta/network-management/connectivity-tests/create @@ -8,7 +8,8 @@ SYNOPSIS --destination-gke-master-cluster=DESTINATION_GKE_MASTER_CLUSTER --destination-instance=DESTINATION_INSTANCE --destination-ip-address=DESTINATION_IP_ADDRESS) - (--source-cloud-function=SOURCE_CLOUD_FUNCTION + (--source-app-engine-version=SOURCE_APP_ENGINE_VERSION + --source-cloud-function=SOURCE_CLOUD_FUNCTION --source-cloud-run-revision=SOURCE_CLOUD_RUN_REVISION --source-cloud-sql-instance=SOURCE_CLOUD_SQL_INSTANCE --source-gke-master-cluster=SOURCE_GKE_MASTER_CLUSTER @@ -73,6 +74,9 @@ REQUIRED FLAGS At least one of these must be specified: + --source-app-engine-version=SOURCE_APP_ENGINE_VERSION + App Engine version URI as the source endpoint. + --source-cloud-function=SOURCE_CLOUD_FUNCTION A Cloud function URI as the source endpoint. diff --git a/gcloud/beta/network-management/connectivity-tests/update b/gcloud/beta/network-management/connectivity-tests/update index 8e0c0f7d6..0b029184f 100644 --- a/gcloud/beta/network-management/connectivity-tests/update +++ b/gcloud/beta/network-management/connectivity-tests/update @@ -20,6 +20,8 @@ SYNOPSIS | --destination-instance=DESTINATION_INSTANCE] [--clear-destination-ip-address | --destination-ip-address=DESTINATION_IP_ADDRESS] + [--clear-source-app-engine-version + | --source-app-engine-version=SOURCE_APP_ENGINE_VERSION] [--clear-source-cloud-function | --source-cloud-function=SOURCE_CLOUD_FUNCTION] [--clear-source-cloud-run-revision @@ -139,6 +141,14 @@ FLAGS internal IP. An IPv6 address is only allowed when the test's destination is a global load balancer VIP. + At most one of these can be specified: + + --clear-source-app-engine-version + Clear existing source App Engine version. + + --source-app-engine-version=SOURCE_APP_ENGINE_VERSION + App Engine version URI as the source endpoint. + At most one of these can be specified: --clear-source-cloud-function diff --git a/gcloud/beta/network-management/help b/gcloud/beta/network-management/help index b9ff3d29c..0afb74616 100644 --- a/gcloud/beta/network-management/help +++ b/gcloud/beta/network-management/help @@ -22,8 +22,10 @@ GROUPS (BETA) Manage Network Management operations. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: $ gcloud network-management + $ gcloud alpha network-management + diff --git a/gcloud/beta/notebooks/instances/create b/gcloud/beta/notebooks/instances/create index f322d13ca..947a54fcc 100644 --- a/gcloud/beta/notebooks/instances/create +++ b/gcloud/beta/notebooks/instances/create @@ -15,6 +15,8 @@ SYNOPSIS [--metadata=[KEY=VALUE,...]] [--post-startup-script=POST_STARTUP_SCRIPT] [--service-account=SERVICE_ACCOUNT] + [--no-shielded-integrity-monitoring] [--shielded-secure-boot] + [--no-shielded-vtpm] [--accelerator-core-count=ACCELERATOR_CORE_COUNT --accelerator-type=ACCELERATOR_TYPE] [--boot-disk-size=BOOT_DISK_SIZE --boot-disk-type=BOOT_DISK_TYPE] @@ -23,7 +25,9 @@ SYNOPSIS : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]] [--network=NETWORK : --no-proxy-access --no-public-ip [--subnet=SUBNET - : --subnet-region=SUBNET_REGION]] [GCLOUD_WIDE_FLAG ...] + : --subnet-region=SUBNET_REGION]] + [--reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; + default="TYPE_UNSPECIFIED"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Request for creating notebook instances. @@ -181,6 +185,17 @@ OPTIONAL FLAGS the instance. If not specified, the Compute Engine default service account is used. + --shielded-integrity-monitoring + Enable monitoring of the boot integrity of the instance. Enabled by + default, use --no-shielded-integrity-monitoring to disable. + + --shielded-secure-boot + Boot instance with secure boot enabled. Disabled by default. + + --shielded-vtpm + Boot instance with TPM (Trusted Platform Module) enabled. Enabled by + default, use --no-shielded-vtpm to disable. + The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the `machine_type` you have selected. @@ -307,6 +322,17 @@ OPTIONAL FLAGS specified name; ▫ provide the argument --subnet-region on the command line. + Specifies the reservation for the instance. + + --reservation=RESERVATION + The name of the reservation, required when + --reservation-affinity=SPECIFIC_RESERVATION. + + --reservation-affinity=RESERVATION_AFFINITY; default="TYPE_UNSPECIFIED" + The type of reservation for the instance. RESERVATION_AFFINITY must + be one of: TYPE_UNSPECIFIED, NO_RESERVATION, ANY_RESERVATION, + SPECIFIC_RESERVATION. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/notebooks/instances/diagnose b/gcloud/beta/notebooks/instances/diagnose new file mode 100644 index 000000000..7cf84819c --- /dev/null +++ b/gcloud/beta/notebooks/instances/diagnose @@ -0,0 +1,105 @@ +NAME + gcloud beta notebooks instances diagnose - request for diagnose instances + +SYNOPSIS + gcloud beta notebooks instances diagnose (INSTANCE : --location=LOCATION) + --gcs-bucket=GCS_BUCKET [--async] [--enable-copy-home-files] + [--enable-packet-capture] [--enable-repair] + [--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Request for diagnose notebook instances. + +EXAMPLES + To diagnose an instance, run: + + $ gcloud beta notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket + + To diagnose an instance with a relative path: + + $ gcloud beta notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket \ + --relative-path=logs + + To diagnose an instance, with packet capture: + + $ gcloud beta notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket \ + --enable-packet-capture + +POSITIONAL ARGUMENTS + Instance resource - User-defined unique name of this instance. The + instance name must be 1 to 63 characters long and contain only lowercase + letters, numeric characters, and dashes. The first character must be a + lowercase letter and the last character cannot be a dash. 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 instance 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. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. To + set the instance attribute: + ▸ provide the argument instance on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location of this environment + https://cloud.google.com/compute/docs/regions-zones/#locations. To + set the location attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property notebooks/location. + +REQUIRED FLAGS + --gcs-bucket=GCS_BUCKET + The Cloud Storage bucket where the log files generated from the + diagnose command will be stored. storage.buckets.writer permissions + must be given to project's service account or user credential. Format: + gs://{gcs_bucket} + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --enable-copy-home-files + Enables flag to copy all /home/jupyter folder contents + + --enable-packet-capture + Enables flag to capture packets from the instance for 30 seconds + + --enable-repair + Enables flag to repair service for instance + + --relative-path=RELATIVE_PATH + Defines the relative storage path in the Cloud Storage bucket where the + diagnostic logs will be written. Default path will be the root + directory of the Cloud Storage bucketFormat of full path: + gs://{gcs_bucket}/{relative_path}/ + +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 notebooks instances diagnose + + $ gcloud alpha notebooks instances diagnose + diff --git a/gcloud/beta/notebooks/instances/help b/gcloud/beta/notebooks/instances/help index 753656b28..ad7ed254a 100644 --- a/gcloud/beta/notebooks/instances/help +++ b/gcloud/beta/notebooks/instances/help @@ -27,6 +27,9 @@ COMMANDS describe (BETA) Request for describing instances. + diagnose + (BETA) Request for diagnose instances. + get-iam-policy (BETA) Get IAM policy for an instance. diff --git a/gcloud/beta/pubsub/lite-subscriptions/create b/gcloud/beta/pubsub/lite-subscriptions/create index 246abe351..76bffd647 100644 --- a/gcloud/beta/pubsub/lite-subscriptions/create +++ b/gcloud/beta/pubsub/lite-subscriptions/create @@ -6,7 +6,11 @@ SYNOPSIS gcloud beta pubsub lite-subscriptions create SUBSCRIPTION --topic=TOPIC [--delivery-requirement=DELIVERY_REQUIREMENT; default="deliver-immediately"] [--location=LOCATION] - [--starting-offset=STARTING_OFFSET; default="end"] + [--event-time=EVENT_TIME | --publish-time=PUBLISH_TIME + | --starting-offset=STARTING_OFFSET; default="end"] + [--export-pubsub-topic=EXPORT_PUBSUB_TOPIC + : --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + --export-desired-state=EXPORT_DESIRED_STATE; default="active"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -25,6 +29,13 @@ EXAMPLES --location=us-central1-a --topic=mytopic \ --starting-offset=beginning + To create a Pub/Sub Lite subscription that exports messages from a Pub/Sub + Lite topic to a Pub/Sub topic, run: + + $ gcloud beta pubsub lite-subscriptions create mysubscription \ + --location=us-central1-a --topic=mytopic \ + --export-pubsub-topic=pubsubtopic + POSITIONAL ARGUMENTS SUBSCRIPTION Subscription ID. @@ -58,11 +69,43 @@ OPTIONAL FLAGS ▸ provide the argument --location on the command line; ▸ provide the argument --zone on the command line. - --starting-offset=STARTING_OFFSET; default="end" - The offset at which a newly created or seeked subscription will start - receiving messages. A subscription can be initialized at the offset of - the oldest retained message (beginning), or at the current HEAD offset - (end). STARTING_OFFSET must be one of: beginning, end. + At most one of these can be specified: + + --event-time=EVENT_TIME + The event time to which you seek a subscription. The subscription + seeks to the first message with event time greater than or equal to + the specified event time. Messages missing an event time use publish + time as a fallback. As event times are user supplied, subsequent + messages may have event times less than the specified event time and + must be filtered by the client, if necessary. Run $ gcloud topic + datetimes for information on time formats. + + --publish-time=PUBLISH_TIME + The publish time to which you seek a subscription. Messages with + publish time greater than or equal to the specified time are + delivered after the seek operation. Run $ gcloud topic datetimes for + information on time formats. + + --starting-offset=STARTING_OFFSET; default="end" + The offset at which a newly created or seeked subscription starts + receiving messages. A subscription can be initialized at the offset + of the oldest retained message (beginning), or at the current HEAD + offset (end). STARTING_OFFSET must be one of: beginning, end. + + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC + The name of the destination Pub/Sub topic to which messages are + exported. Must be the topic's fully specified path if it is not in the + same project as the subscription to be created. + + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + The name of the Pub/Sub Lite topic to write messages that cannot be + exported. Must be in the same project and location as the subscription + to be created. Note that this is a Lite topic. + + --export-desired-state=EXPORT_DESIRED_STATE; default="active" + The desired state of the export. Process messages by setting the value + to ACTIVE or pause message processing by setting the value to PAUSED. + EXPORT_DESIRED_STATE must be one of: active, paused. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/pubsub/lite-subscriptions/seek b/gcloud/beta/pubsub/lite-subscriptions/seek index 8c9455be0..d76719b69 100644 --- a/gcloud/beta/pubsub/lite-subscriptions/seek +++ b/gcloud/beta/pubsub/lite-subscriptions/seek @@ -65,21 +65,22 @@ REQUIRED FLAGS Exactly one of these must be specified: --event-time=EVENT_TIME - The event time to seek a subscription to. Seeks to the first message - with event time greater than or equal to the specified event time. As - event times are user supplied, subsequent messages may have event - times less than the specified event time and should be filtered by - the client, if necessary. Messages missing an event time use publish - time as a fallback. Run $ gcloud topic datetimes for information on - time formats. + The event time to which you seek a subscription. The subscription + seeks to the first message with event time greater than or equal to + the specified event time. Messages missing an event time use publish + time as a fallback. As event times are user supplied, subsequent + messages may have event times less than the specified event time and + must be filtered by the client, if necessary. Run $ gcloud topic + datetimes for information on time formats. --publish-time=PUBLISH_TIME - The publish time to seek a subscription to. Messages with publish - time greater than or equal to this time will be delivered post-seek. - Run $ gcloud topic datetimes for information on time formats. + The publish time to which you seek a subscription. Messages with + publish time greater than or equal to the specified time are + delivered after the seek operation. Run $ gcloud topic datetimes for + information on time formats. --starting-offset=STARTING_OFFSET - The offset at which a newly created or seeked subscription will start + The offset at which a newly created or seeked subscription starts receiving messages. A subscription can be initialized at the offset of the oldest retained message (beginning), or at the current HEAD offset (end). STARTING_OFFSET must be one of: beginning, end. diff --git a/gcloud/beta/pubsub/lite-subscriptions/update b/gcloud/beta/pubsub/lite-subscriptions/update index 1b2ad6895..e6ef58f56 100644 --- a/gcloud/beta/pubsub/lite-subscriptions/update +++ b/gcloud/beta/pubsub/lite-subscriptions/update @@ -5,13 +5,16 @@ NAME SYNOPSIS gcloud beta pubsub lite-subscriptions update (SUBSCRIPTION : --location=LOCATION) - --delivery-requirement=DELIVERY_REQUIREMENT [GCLOUD_WIDE_FLAG ...] + (--delivery-requirement=DELIVERY_REQUIREMENT + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + --export-desired-state=EXPORT_DESIRED_STATE + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update a Pub/Sub Lite subscription. EXAMPLES - To update a Cloud Pub/Sub lite-subscription, run: + To update a Pub/Sub Lite subscription, run: $ gcloud beta pubsub lite-subscriptions update mysubscription \ --location=us-central1-a \ @@ -47,12 +50,29 @@ POSITIONAL ARGUMENTS ▸ provide the argument --zone on the command line. REQUIRED FLAGS - --delivery-requirement=DELIVERY_REQUIREMENT - When this subscription should send messages to subscribers relative to - messages persistence in storage. See - https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions - for more info. DELIVERY_REQUIREMENT must be one of: - deliver-after-stored, deliver-immediately. + At least one of these must be specified: + + --delivery-requirement=DELIVERY_REQUIREMENT + When this subscription should send messages to subscribers relative + to messages persistence in storage. See + https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions + for more info. DELIVERY_REQUIREMENT must be one of: + deliver-after-stored, deliver-immediately. + + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + The name of the Pub/Sub Lite topic to write messages that cannot be + exported. Must be in the same project and location as the + subscription to be created. Note that this is a Lite topic. + + --export-desired-state=EXPORT_DESIRED_STATE + The desired state of the export. Process messages by setting the + value to ACTIVE or pause message processing by setting the value to + PAUSED. EXPORT_DESIRED_STATE must be one of: active, paused. + + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC + The name of the destination Pub/Sub topic to which messages are + exported. Must be the topic's fully specified path if it is not in + the same project as the subscription to be created. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/recommender/insight-type-config/describe b/gcloud/beta/recommender/insight-type-config/describe index d9a86c438..612f95435 100644 --- a/gcloud/beta/recommender/insight-type-config/describe +++ b/gcloud/beta/recommender/insight-type-config/describe @@ -5,12 +5,12 @@ NAME SYNOPSIS gcloud beta recommender insight-type-config describe INSIGHT_TYPE --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Describe an insight type configuration based on a given entity - (project, organization), location, and insight type. + (project, organization, billing account), location, and insight type. EXAMPLES To describe an insight type configuration, run: @@ -30,6 +30,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/beta/recommender/insight-type-config/update b/gcloud/beta/recommender/insight-type-config/update index 768f605e0..916289bb1 100644 --- a/gcloud/beta/recommender/insight-type-config/update +++ b/gcloud/beta/recommender/insight-type-config/update @@ -5,13 +5,14 @@ NAME SYNOPSIS gcloud beta recommender insight-type-config update INSIGHT_TYPE --etag=ETAG --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [--annotations=KEY=VALUE,[KEY=VALUE,...]] [--config-file=CONFIG_FILE] - [--display-name=DISPLAY_NAME] [--validate-only] [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [--annotations=KEY=VALUE,[KEY=VALUE,...]] + [--config-file=CONFIG_FILE] [--display-name=DISPLAY_NAME] + [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update an insight type configuration based on a given entity - (project, organization), location, and insight type. + (project, organization, billing account), location, and insight type. EXAMPLES To update an insight type configuration, run: @@ -35,6 +36,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/beta/recommender/recommender-config/describe b/gcloud/beta/recommender/recommender-config/describe index 84b09683a..c9ac7032e 100644 --- a/gcloud/beta/recommender/recommender-config/describe +++ b/gcloud/beta/recommender/recommender-config/describe @@ -5,12 +5,12 @@ NAME SYNOPSIS gcloud beta recommender recommender-config describe RECOMMENDER --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Describe a recommender configuration based on a given entity - (project, organization), location, and recommender. + (project, organization, billing account), location, and recommender. EXAMPLES To describe a recommender configuration, run: @@ -30,6 +30,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/beta/recommender/recommender-config/update b/gcloud/beta/recommender/recommender-config/update index f1e77ea2b..8aeccafe1 100644 --- a/gcloud/beta/recommender/recommender-config/update +++ b/gcloud/beta/recommender/recommender-config/update @@ -5,13 +5,14 @@ NAME SYNOPSIS gcloud beta recommender recommender-config update RECOMMENDER --etag=ETAG --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [--annotations=KEY=VALUE,[KEY=VALUE,...]] [--config-file=CONFIG_FILE] - [--display-name=DISPLAY_NAME] [--validate-only] [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [--annotations=KEY=VALUE,[KEY=VALUE,...]] + [--config-file=CONFIG_FILE] [--display-name=DISPLAY_NAME] + [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Update a recommender configuration based on a given entity (project, - organization), location, and recommender. + organization, billing account), location, and recommender. EXAMPLES To update a recommender configuration, run: @@ -35,6 +36,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/beta/resource-config/bulk-export b/gcloud/beta/resource-config/bulk-export index 3f7fa5d3f..414e57b46 100644 --- a/gcloud/beta/resource-config/bulk-export +++ b/gcloud/beta/resource-config/bulk-export @@ -63,7 +63,7 @@ FLAGS --resource-format=RESOURCE_FORMAT Format of the configuration to export. Available configuration formats - are Kubernetes Resource Model (krm) or Terraform HCL (terraform). + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform. diff --git a/gcloud/beta/run/deploy b/gcloud/beta/run/deploy index 765f77b7d..b8270079a 100644 --- a/gcloud/beta/run/deploy +++ b/gcloud/beta/run/deploy @@ -213,7 +213,10 @@ FLAGS --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. + 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 @@ -378,7 +381,7 @@ FLAGS --[no-]cpu-boost Whether to allocate extra CPU to containers on startup. This can - reduce the percieved latency of a cold start request. Use --cpu-boost + reduce the perceived latency of a cold start request. Use --cpu-boost to enable and --no-cpu-boost to disable. --[no-]cpu-throttling diff --git a/gcloud/beta/run/help b/gcloud/beta/run/help index 624a7ce9b..2176c31ac 100644 --- a/gcloud/beta/run/help +++ b/gcloud/beta/run/help @@ -26,6 +26,9 @@ GROUPS domain-mappings (BETA) View and manage your Cloud Run domain mappings. + integrations + (BETA) View and manage your Cloud Run (fully managed) integrations. + jobs (BETA) View and manage your Cloud Run jobs. diff --git a/gcloud/beta/run/integrations/create b/gcloud/beta/run/integrations/create new file mode 100644 index 000000000..c78141e6e --- /dev/null +++ b/gcloud/beta/run/integrations/create @@ -0,0 +1,58 @@ +NAME + gcloud beta run integrations create - create a Cloud Run Integration + +SYNOPSIS + gcloud beta run integrations create --type=TYPE [--name=NAME] + [--parameters=[PARAMETER=VALUE,...]] [--region=REGION] + [--service=SERVICE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Run Integration. + +EXAMPLES + To create and attach a redis instance to a Cloud Run service + + $ gcloud beta run integrations create --type=redis \ + --service=myservice + + To attach a custom domain to a Cloud Run service + + $ gcloud beta run integrations create --type=custom-domains \ + --parameters='set-mapping=example.com/*:myservice' + +REQUIRED FLAGS + --type=TYPE + Type of the integration. To see available types and usage, use "gcloud + run integrations types list" command. + +OPTIONAL FLAGS + --name=NAME + Name of the integration. + + --parameters=[PARAMETER=VALUE,...] + Comma-separated list of parameter names and values. Names must be one + of the parameters shown when describing the integration type. Only + simple values can be specified with this flag. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + --service=SERVICE + Name of the Cloud Run service to attach to the integration. It is + required for some integrations. + +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. This + variant is also available: + + $ gcloud alpha run integrations create + diff --git a/gcloud/beta/run/integrations/delete b/gcloud/beta/run/integrations/delete new file mode 100644 index 000000000..9e5fdfd68 --- /dev/null +++ b/gcloud/beta/run/integrations/delete @@ -0,0 +1,39 @@ +NAME + gcloud beta run integrations delete - delete a Cloud Run Integration and + its associated resources + +SYNOPSIS + gcloud beta run integrations delete NAME [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Cloud Run Integration and its associated resources. + +EXAMPLES + To delete a redis integration and the associated resources + + $ gcloud beta run integrations delete my-redis-integration + +POSITIONAL ARGUMENTS + NAME + Name of the integration. + +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 + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations delete + diff --git a/gcloud/beta/run/integrations/describe b/gcloud/beta/run/integrations/describe new file mode 100644 index 000000000..314a8e296 --- /dev/null +++ b/gcloud/beta/run/integrations/describe @@ -0,0 +1,38 @@ +NAME + gcloud beta run integrations describe - describe a Cloud Run Integration + +SYNOPSIS + gcloud beta run integrations describe NAME [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Cloud Run Integration. + +EXAMPLES + To describe an integration + + $ gcloud beta run integrations describe my-redis-integration + +POSITIONAL ARGUMENTS + NAME + Name of the integration. + +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 + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations describe + diff --git a/gcloud/beta/run/integrations/help b/gcloud/beta/run/integrations/help new file mode 100644 index 000000000..7f13df071 --- /dev/null +++ b/gcloud/beta/run/integrations/help @@ -0,0 +1,57 @@ +NAME + gcloud beta run integrations - view and manage your Cloud Run + (fully managed) integrations + +SYNOPSIS + gcloud beta run integrations GROUP | COMMAND [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) This set of commands can be used to view and manage your Cloud Run + integrations. + +EXAMPLES + To list your existing integrations, run: + + $ gcloud beta run integrations 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: + + types + (BETA) View available Cloud Run (fully managed) integrations types. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a Cloud Run Integration. + + delete + (BETA) Delete a Cloud Run Integration and its associated resources. + + describe + (BETA) Describe a Cloud Run Integration. + + list + (BETA) List Cloud Run Integrations. + + update + (BETA) Update a Cloud Run Integration. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations + diff --git a/gcloud/beta/run/integrations/list b/gcloud/beta/run/integrations/list new file mode 100644 index 000000000..36c130859 --- /dev/null +++ b/gcloud/beta/run/integrations/list @@ -0,0 +1,82 @@ +NAME + gcloud beta run integrations list - list Cloud Run Integrations + +SYNOPSIS + gcloud beta run integrations list [--region=REGION] [--service=SERVICE] + [--type=TYPE] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Cloud Run Integrations. + +EXAMPLES + List all Cloud Run Integrations within the current project + + $ gcloud beta run integrations list + + List all Cloud Run Integrations of a particular type + + $ gcloud beta run integrations list --type=redis + + List all Cloud Run Integrations attached to a particular Service + + $ gcloud beta run integrations list --service=my-service + +FLAGS + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + --service=SERVICE + Filter Integrations by Name of Cloud Run service. + + --type=TYPE + Filter Integrations by Type of Integration. + +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 + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations list + diff --git a/gcloud/beta/run/integrations/types/describe b/gcloud/beta/run/integrations/types/describe new file mode 100644 index 000000000..29f3fe81e --- /dev/null +++ b/gcloud/beta/run/integrations/types/describe @@ -0,0 +1,39 @@ +NAME + gcloud beta run integrations types describe - describes a Cloud Run + Integration type + +SYNOPSIS + gcloud beta run integrations types describe TYPE [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describes a Cloud Run Integration type. + +EXAMPLES + To describe an integration type + + $ gcloud beta run integrations types describe [TYPE] + +POSITIONAL ARGUMENTS + TYPE + Type of the integration. + +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 + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations types describe + diff --git a/gcloud/beta/run/integrations/types/help b/gcloud/beta/run/integrations/types/help new file mode 100644 index 000000000..037a51c1c --- /dev/null +++ b/gcloud/beta/run/integrations/types/help @@ -0,0 +1,42 @@ +NAME + gcloud beta run integrations types - view available Cloud Run + (fully managed) integrations types + +SYNOPSIS + gcloud beta run integrations types COMMAND [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) This set of commands can be used to view Cloud Run integrations + types. + +EXAMPLES + To list available integrations types, run: + + $ gcloud beta run integrations types 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. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describes a Cloud Run Integration type. + + list + (BETA) Lists Cloud Run Integration Types. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations types + diff --git a/gcloud/beta/run/integrations/types/list b/gcloud/beta/run/integrations/types/list new file mode 100644 index 000000000..bdbae1db2 --- /dev/null +++ b/gcloud/beta/run/integrations/types/list @@ -0,0 +1,67 @@ +NAME + gcloud beta run integrations types list - lists Cloud Run Integration Types + +SYNOPSIS + gcloud beta run integrations types list [--region=REGION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Lists Cloud Run Integration Types. + +EXAMPLES + To list all integration types + + $ gcloud beta run integrations types list + +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. + + --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 + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run integrations types list + diff --git a/gcloud/beta/run/integrations/update b/gcloud/beta/run/integrations/update new file mode 100644 index 000000000..326214446 --- /dev/null +++ b/gcloud/beta/run/integrations/update @@ -0,0 +1,54 @@ +NAME + gcloud beta run integrations update - update a Cloud Run Integration + +SYNOPSIS + gcloud beta run integrations update NAME + [--parameters=[PARAMETER=VALUE,...]] [--region=REGION] + [--add-service=ADD_SERVICE | --remove-service=REMOVE_SERVICE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Cloud Run Integration. + +EXAMPLES + To update a redis integration to change the cache size + + $ gcloud beta run integrations update redis-integration \ + --parameters=memory-size-gb=5 + +POSITIONAL ARGUMENTS + NAME + Name of the integration. + +FLAGS + --parameters=[PARAMETER=VALUE,...] + Comma-separated list of parameter names and values. Names must be one + of the parameters shown when describing the integration type. Only + simple values can be specified with this flag. + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + At most one of these can be specified: + + --add-service=ADD_SERVICE + Name of the Cloud Run service to attach to the integration. + + --remove-service=REMOVE_SERVICE + Name of the Cloud Run service to remove from the integration. + +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. This + variant is also available: + + $ gcloud alpha run integrations update + diff --git a/gcloud/beta/run/jobs/create b/gcloud/beta/run/jobs/create index 2ad0cdf6d..4d88e296f 100644 --- a/gcloud/beta/run/jobs/create +++ b/gcloud/beta/run/jobs/create @@ -9,11 +9,12 @@ SYNOPSIS [--memory=MEMORY] [--parallelism=PARALLELISM] [--region=REGION] [--service-account=SERVICE_ACCOUNT] [--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]] - [--set-env-vars=[KEY=VALUE,...]] [--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] [GCLOUD_WIDE_FLAG ...] + [--async | --wait] + [--env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Deploys a new job to Google Cloud Run. @@ -91,7 +92,7 @@ OPTIONAL FLAGS List of label KEY=VALUE pairs to add. --max-retries=MAX_RETRIES - Number of times an task is allowed to restart in case of failure before + 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. @@ -109,21 +110,14 @@ OPTIONAL FLAGS --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. For the managed platform, - this is the email address of an IAM service account. For the - Kubernetes-based platforms (gke, kubernetes), this is the name of a - Kubernetes service account in the same namespace as the service. If not - provided, the revision will use the default service account of the - project, or default Kubernetes namespace service account respectively. + 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 :: for the instance. - --set-env-vars=[KEY=VALUE,...] - List of key-value pairs to set as environment variables. - --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 @@ -172,6 +166,18 @@ OPTIONAL FLAGS 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, diff --git a/gcloud/beta/run/jobs/update b/gcloud/beta/run/jobs/update index d262db6c2..5b74802a9 100644 --- a/gcloud/beta/run/jobs/update +++ b/gcloud/beta/run/jobs/update @@ -2,10 +2,10 @@ NAME gcloud beta run jobs update - update a Cloud Run Job SYNOPSIS - gcloud beta run jobs update [JOB] [--args=[ARG,...]] [--async] + gcloud beta run jobs update [JOB] [--args=[ARG,...]] [--breakglass=JUSTIFICATION] [--clear-vpc-connector] - [--command=[COMMAND,...]] [--cpu=CPU] [--image=IMAGE] [--key=KEY] - [--max-retries=MAX_RETRIES] [--memory=MEMORY] + [--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] @@ -14,6 +14,7 @@ SYNOPSIS | --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,...] @@ -57,10 +58,6 @@ FLAGS 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. - --async - Return immediately, without waiting for the operation in progress to - complete. - --breakglass=JUSTIFICATION Justification to bypass Binary Authorization policy constraints and allow the operation. See @@ -83,6 +80,9 @@ FLAGS (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). @@ -91,7 +91,7 @@ FLAGS CMEK key reference to encrypt the container with. --max-retries=MAX_RETRIES - Number of times an task is allowed to restart in case of failure before + 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. @@ -109,12 +109,8 @@ FLAGS --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. For the managed platform, - this is the email address of an IAM service account. For the - Kubernetes-based platforms (gke, kubernetes), this is the name of a - Kubernetes service account in the same namespace as the service. If not - provided, the revision will use the default service account of the - project, or default Kubernetes namespace service account respectively. + 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 @@ -166,6 +162,17 @@ FLAGS 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 @@ -183,7 +190,10 @@ FLAGS --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. + 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 diff --git a/gcloud/beta/run/revisions/help b/gcloud/beta/run/revisions/help index e58a0b7e1..4b4f4f485 100644 --- a/gcloud/beta/run/revisions/help +++ b/gcloud/beta/run/revisions/help @@ -2,7 +2,8 @@ NAME gcloud beta run revisions - view and manage your Cloud Run revisions SYNOPSIS - gcloud beta run revisions COMMAND [--platform=PLATFORM; default="managed"] + gcloud beta run revisions GROUP | COMMAND + [--platform=PLATFORM; default="managed"] [--region=REGION | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] @@ -97,6 +98,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + logs + (BETA) Read logs for Cloud Run (fully managed) revisions. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/run/revisions/logs/help b/gcloud/beta/run/revisions/logs/help new file mode 100644 index 000000000..3ac5a21af --- /dev/null +++ b/gcloud/beta/run/revisions/logs/help @@ -0,0 +1,110 @@ +NAME + gcloud beta run revisions logs - read logs for Cloud Run (fully managed) + revisions + +SYNOPSIS + gcloud beta run revisions logs COMMAND + [--platform=PLATFORM; default="managed"] + [--region=REGION + | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION + | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Read logs for Cloud Run (fully managed) revisions. + +FLAGS + --platform=PLATFORM; default="managed" + Target platform for running commands. Alternatively, set the property + [run/platform]. PLATFORM must be one of: + + managed + Fully managed version of Cloud Run. Use with the --region flag or + set the [run/region] property to specify a Cloud Run region. + gke + Cloud Run for Anthos on Google Cloud. Use with the --cluster and + --cluster-location flags or set the [run/cluster] and + [run/cluster_location] properties to specify a cluster in a given + zone. + kubernetes + Use a Knative-compatible kubernetes cluster. Use with the + --kubeconfig and --context flags to specify a kubeconfig file and + the context for connecting. + + Arguments to locate resources, depending on the platform used. + + At most one of these can be specified: + + Only applicable if connecting to Cloud Run (fully managed). Specify + --platform=managed to use: + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + Only applicable if connecting to Cloud Run for Anthos deployed on Google + Cloud. Specify --platform=gke to use: + + Cluster resource - Kubernetes Engine cluster to connect to. 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 --cluster on the command line with a fully + specified name; + ▫ set the property run/cluster with a fully specified name; + ▫ specify the cluster from a list of available clusters with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line; + ◇ set the property run/cluster; + ◇ specify the cluster from a list of available clusters. + + --cluster-location=CLUSTER_LOCATION + Zone in which the cluster is located. Alternatively, set the + property [run/cluster_location]. To set the location attribute: + ◇ provide the argument --cluster on the command line with a + fully specified name; + ◇ set the property run/cluster with a fully specified name; + ◇ specify the cluster from a list of available clusters with a + fully specified name; + ◇ provide the argument --cluster-location on the command line; + ◇ set the property run/cluster_location; + ◇ specify the cluster location from a list of available zones. + + Only applicable if connecting to Cloud Run for Anthos deployed on + VMware. Specify --platform=kubernetes to use: + + --context=CONTEXT + The name of the context in your kubectl config file to use for + connecting. + + --kubeconfig=KUBECONFIG + The absolute path to your kubectl config file. If not specified, + the colon- or semicolon-delimited list of paths specified by + $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to + ~/.kube/config. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + read + (BETA) Read logs for a revision. + + tail + (BETA) Tail logs for a revision. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run revisions logs + diff --git a/gcloud/beta/run/revisions/logs/read b/gcloud/beta/run/revisions/logs/read new file mode 100644 index 000000000..ac20bb492 --- /dev/null +++ b/gcloud/beta/run/revisions/logs/read @@ -0,0 +1,158 @@ +NAME + gcloud beta run revisions logs read - read logs for a revision + +SYNOPSIS + gcloud beta run revisions logs read REVISION + [--freshness=FRESHNESS; default="1d"] [--log-filter=LOG_FILTER] + [--order=ORDER; default="desc"] + [--platform=PLATFORM; default="managed"] + [--region=REGION + | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION + | --context=CONTEXT --kubeconfig=KUBECONFIG] [--limit=LIMIT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta run revisions logs read reads log entries. Log entries + matching --log-filter are returned in order of decreasing timestamps, + most-recent entries first. If the log entries come from multiple logs, then + entries from different logs might be intermingled in the results. + +EXAMPLES + To read log entries from for a Cloud Run revision, run: + + $ gcloud beta run revisions logs read my-revision + + To read log entries with severity ERROR or higher, run: + + $ gcloud beta run revisions logs read my-revision \ + --log-filter="severity>=ERROR" + + To read log entries written in a specific time window, run: + + $ gcloud beta run revisions logs read my-revision \ + --log-filter='timestamp<="2015-05-31T23:59:59Z" AND + timestamp>="2015-05-31T00:00:00Z"' + + To read up to 10 log entries in your revision payloads that include the + word SearchText and format the output in JSON format, run: + + $ gcloud beta run revisions logs read my-revision \ + --log-filter="textPayload:SearchText" --limit=10 --format=json + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + REVISION + Name for a Cloud Run revision. + +FLAGS + --freshness=FRESHNESS; default="1d" + Return entries that are not older than this value. Works only with DESC + ordering and filters without a timestamp. See $ gcloud topic datetimes + for information on duration formats. + + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --order=ORDER; default="desc" + Ordering of returned log entries based on timestamp field. ORDER must + be one of: desc, asc. + + --platform=PLATFORM; default="managed" + Target platform for running commands. Alternatively, set the property + [run/platform]. PLATFORM must be one of: + + managed + Fully managed version of Cloud Run. Use with the --region flag or + set the [run/region] property to specify a Cloud Run region. + gke + Cloud Run for Anthos on Google Cloud. Use with the --cluster and + --cluster-location flags or set the [run/cluster] and + [run/cluster_location] properties to specify a cluster in a given + zone. + kubernetes + Use a Knative-compatible kubernetes cluster. Use with the + --kubeconfig and --context flags to specify a kubeconfig file and + the context for connecting. + + Arguments to locate resources, depending on the platform used. + + At most one of these can be specified: + + Only applicable if connecting to Cloud Run (fully managed). Specify + --platform=managed to use: + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + Only applicable if connecting to Cloud Run for Anthos deployed on Google + Cloud. Specify --platform=gke to use: + + Cluster resource - Kubernetes Engine cluster to connect to. 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 --cluster on the command line with a fully + specified name; + ▫ set the property run/cluster with a fully specified name; + ▫ specify the cluster from a list of available clusters with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line; + ◇ set the property run/cluster; + ◇ specify the cluster from a list of available clusters. + + --cluster-location=CLUSTER_LOCATION + Zone in which the cluster is located. Alternatively, set the + property [run/cluster_location]. To set the location attribute: + ◇ provide the argument --cluster on the command line with a + fully specified name; + ◇ set the property run/cluster with a fully specified name; + ◇ specify the cluster from a list of available clusters with a + fully specified name; + ◇ provide the argument --cluster-location on the command line; + ◇ set the property run/cluster_location; + ◇ specify the cluster location from a list of available zones. + + Only applicable if connecting to Cloud Run for Anthos deployed on + VMware. Specify --platform=kubernetes to use: + + --context=CONTEXT + The name of the context in your kubectl config file to use for + connecting. + + --kubeconfig=KUBECONFIG + The absolute path to your kubectl config file. If not specified, + the colon- or semicolon-delimited list of paths specified by + $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to + ~/.kube/config. + +LIST COMMAND FLAGS + --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. + +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. This + variant is also available: + + $ gcloud alpha run revisions logs read + diff --git a/gcloud/beta/run/revisions/logs/tail b/gcloud/beta/run/revisions/logs/tail new file mode 100644 index 000000000..67ca0f376 --- /dev/null +++ b/gcloud/beta/run/revisions/logs/tail @@ -0,0 +1,127 @@ +NAME + gcloud beta run revisions logs tail - tail logs for a revision + +SYNOPSIS + gcloud beta run revisions logs tail REVISION [--log-filter=LOG_FILTER] + [--platform=PLATFORM; default="managed"] + [--region=REGION + | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION + | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta run revisions logs tail tails log-entries for a + particular Cloud Run revision in real time. The log entries are formatted + for consumption in a terminal. + +EXAMPLES + To tail log entries for a Cloud Run revision, run: + + $ gcloud beta run revisions logs tail my-revision + + To tail log entries with severity ERROR or higher, run: + + $ gcloud beta run revisions logs tail my-revision \ + --log-filter="severity>=ERROR" + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + REVISION + Name for a Cloud Run revision. + +FLAGS + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --platform=PLATFORM; default="managed" + Target platform for running commands. Alternatively, set the property + [run/platform]. PLATFORM must be one of: + + managed + Fully managed version of Cloud Run. Use with the --region flag or + set the [run/region] property to specify a Cloud Run region. + gke + Cloud Run for Anthos on Google Cloud. Use with the --cluster and + --cluster-location flags or set the [run/cluster] and + [run/cluster_location] properties to specify a cluster in a given + zone. + kubernetes + Use a Knative-compatible kubernetes cluster. Use with the + --kubeconfig and --context flags to specify a kubeconfig file and + the context for connecting. + + Arguments to locate resources, depending on the platform used. + + At most one of these can be specified: + + Only applicable if connecting to Cloud Run (fully managed). Specify + --platform=managed to use: + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + Only applicable if connecting to Cloud Run for Anthos deployed on Google + Cloud. Specify --platform=gke to use: + + Cluster resource - Kubernetes Engine cluster to connect to. 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 --cluster on the command line with a fully + specified name; + ▫ set the property run/cluster with a fully specified name; + ▫ specify the cluster from a list of available clusters with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line; + ◇ set the property run/cluster; + ◇ specify the cluster from a list of available clusters. + + --cluster-location=CLUSTER_LOCATION + Zone in which the cluster is located. Alternatively, set the + property [run/cluster_location]. To set the location attribute: + ◇ provide the argument --cluster on the command line with a + fully specified name; + ◇ set the property run/cluster with a fully specified name; + ◇ specify the cluster from a list of available clusters with a + fully specified name; + ◇ provide the argument --cluster-location on the command line; + ◇ set the property run/cluster_location; + ◇ specify the cluster location from a list of available zones. + + Only applicable if connecting to Cloud Run for Anthos deployed on + VMware. Specify --platform=kubernetes to use: + + --context=CONTEXT + The name of the context in your kubectl config file to use for + connecting. + + --kubeconfig=KUBECONFIG + The absolute path to your kubectl config file. If not specified, + the colon- or semicolon-delimited list of paths specified by + $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to + ~/.kube/config. + +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. This + variant is also available: + + $ gcloud alpha run revisions logs tail + diff --git a/gcloud/beta/run/services/help b/gcloud/beta/run/services/help index 36c926f1f..d46a7b5cf 100644 --- a/gcloud/beta/run/services/help +++ b/gcloud/beta/run/services/help @@ -2,7 +2,8 @@ NAME gcloud beta run services - view and manage your Cloud Run services SYNOPSIS - gcloud beta run services COMMAND [--platform=PLATFORM; default="managed"] + gcloud beta run services GROUP | COMMAND + [--platform=PLATFORM; default="managed"] [--region=REGION | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] @@ -99,6 +100,12 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. +GROUPS + GROUP is one of the following: + + logs + (BETA) Read logs for Cloud Run (fully managed) services. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/beta/run/services/logs/help b/gcloud/beta/run/services/logs/help new file mode 100644 index 000000000..3a44f9ef4 --- /dev/null +++ b/gcloud/beta/run/services/logs/help @@ -0,0 +1,110 @@ +NAME + gcloud beta run services logs - read logs for Cloud Run (fully managed) + services + +SYNOPSIS + gcloud beta run services logs COMMAND + [--platform=PLATFORM; default="managed"] + [--region=REGION + | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION + | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Read logs for Cloud Run (fully managed) services. + +FLAGS + --platform=PLATFORM; default="managed" + Target platform for running commands. Alternatively, set the property + [run/platform]. PLATFORM must be one of: + + managed + Fully managed version of Cloud Run. Use with the --region flag or + set the [run/region] property to specify a Cloud Run region. + gke + Cloud Run for Anthos on Google Cloud. Use with the --cluster and + --cluster-location flags or set the [run/cluster] and + [run/cluster_location] properties to specify a cluster in a given + zone. + kubernetes + Use a Knative-compatible kubernetes cluster. Use with the + --kubeconfig and --context flags to specify a kubeconfig file and + the context for connecting. + + Arguments to locate resources, depending on the platform used. + + At most one of these can be specified: + + Only applicable if connecting to Cloud Run (fully managed). Specify + --platform=managed to use: + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + Only applicable if connecting to Cloud Run for Anthos deployed on Google + Cloud. Specify --platform=gke to use: + + Cluster resource - Kubernetes Engine cluster to connect to. 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 --cluster on the command line with a fully + specified name; + ▫ set the property run/cluster with a fully specified name; + ▫ specify the cluster from a list of available clusters with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line; + ◇ set the property run/cluster; + ◇ specify the cluster from a list of available clusters. + + --cluster-location=CLUSTER_LOCATION + Zone in which the cluster is located. Alternatively, set the + property [run/cluster_location]. To set the location attribute: + ◇ provide the argument --cluster on the command line with a + fully specified name; + ◇ set the property run/cluster with a fully specified name; + ◇ specify the cluster from a list of available clusters with a + fully specified name; + ◇ provide the argument --cluster-location on the command line; + ◇ set the property run/cluster_location; + ◇ specify the cluster location from a list of available zones. + + Only applicable if connecting to Cloud Run for Anthos deployed on + VMware. Specify --platform=kubernetes to use: + + --context=CONTEXT + The name of the context in your kubectl config file to use for + connecting. + + --kubeconfig=KUBECONFIG + The absolute path to your kubectl config file. If not specified, + the colon- or semicolon-delimited list of paths specified by + $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to + ~/.kube/config. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + read + (BETA) Read logs for a service. + + tail + (BETA) Tail logs for a service. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha run services logs + diff --git a/gcloud/beta/run/services/logs/read b/gcloud/beta/run/services/logs/read new file mode 100644 index 000000000..56cf5f029 --- /dev/null +++ b/gcloud/beta/run/services/logs/read @@ -0,0 +1,158 @@ +NAME + gcloud beta run services logs read - read logs for a service + +SYNOPSIS + gcloud beta run services logs read SERVICE + [--freshness=FRESHNESS; default="1d"] [--log-filter=LOG_FILTER] + [--order=ORDER; default="desc"] + [--platform=PLATFORM; default="managed"] + [--region=REGION + | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION + | --context=CONTEXT --kubeconfig=KUBECONFIG] [--limit=LIMIT] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta run services logs read reads log entries. Log entries + matching --log-filter are returned according to the specified --order. If + the log entries come from multiple logs, then entries from different logs + might be intermingled in the results. + +EXAMPLES + To read log entries from for a Cloud Run Service, run: + + $ gcloud beta run services logs read my-service + + To read log entries with severity ERROR or higher, run: + + $ gcloud beta run services logs read my-service \ + --log-filter="severity>=ERROR" + + To read log entries written in a specific time window, run: + + $ gcloud beta run services logs read my-service \ + --log-filter='timestamp<="2015-05-31T23:59:59Z" AND + timestamp>="2015-05-31T00:00:00Z"' + + To read up to 10 log entries in your service payloads that include the word + SearchText and format the output in JSON format, run: + + $ gcloud beta run services logs read my-service \ + --log-filter="textPayload:SearchText" --limit=10 --format=json + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + SERVICE + Name for a Cloud Run service. + +FLAGS + --freshness=FRESHNESS; default="1d" + Return entries that are not older than this value. Works only with DESC + ordering and filters without a timestamp. See $ gcloud topic datetimes + for information on duration formats. + + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --order=ORDER; default="desc" + Ordering of returned log entries based on timestamp field. ORDER must + be one of: desc, asc. + + --platform=PLATFORM; default="managed" + Target platform for running commands. Alternatively, set the property + [run/platform]. PLATFORM must be one of: + + managed + Fully managed version of Cloud Run. Use with the --region flag or + set the [run/region] property to specify a Cloud Run region. + gke + Cloud Run for Anthos on Google Cloud. Use with the --cluster and + --cluster-location flags or set the [run/cluster] and + [run/cluster_location] properties to specify a cluster in a given + zone. + kubernetes + Use a Knative-compatible kubernetes cluster. Use with the + --kubeconfig and --context flags to specify a kubeconfig file and + the context for connecting. + + Arguments to locate resources, depending on the platform used. + + At most one of these can be specified: + + Only applicable if connecting to Cloud Run (fully managed). Specify + --platform=managed to use: + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + Only applicable if connecting to Cloud Run for Anthos deployed on Google + Cloud. Specify --platform=gke to use: + + Cluster resource - Kubernetes Engine cluster to connect to. 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 --cluster on the command line with a fully + specified name; + ▫ set the property run/cluster with a fully specified name; + ▫ specify the cluster from a list of available clusters with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line; + ◇ set the property run/cluster; + ◇ specify the cluster from a list of available clusters. + + --cluster-location=CLUSTER_LOCATION + Zone in which the cluster is located. Alternatively, set the + property [run/cluster_location]. To set the location attribute: + ◇ provide the argument --cluster on the command line with a + fully specified name; + ◇ set the property run/cluster with a fully specified name; + ◇ specify the cluster from a list of available clusters with a + fully specified name; + ◇ provide the argument --cluster-location on the command line; + ◇ set the property run/cluster_location; + ◇ specify the cluster location from a list of available zones. + + Only applicable if connecting to Cloud Run for Anthos deployed on + VMware. Specify --platform=kubernetes to use: + + --context=CONTEXT + The name of the context in your kubectl config file to use for + connecting. + + --kubeconfig=KUBECONFIG + The absolute path to your kubectl config file. If not specified, + the colon- or semicolon-delimited list of paths specified by + $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to + ~/.kube/config. + +LIST COMMAND FLAGS + --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. + +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. This + variant is also available: + + $ gcloud alpha run services logs read + diff --git a/gcloud/beta/run/services/logs/tail b/gcloud/beta/run/services/logs/tail new file mode 100644 index 000000000..00b4f1c99 --- /dev/null +++ b/gcloud/beta/run/services/logs/tail @@ -0,0 +1,127 @@ +NAME + gcloud beta run services logs tail - tail logs for a service + +SYNOPSIS + gcloud beta run services logs tail SERVICE [--log-filter=LOG_FILTER] + [--platform=PLATFORM; default="managed"] + [--region=REGION + | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION + | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) gcloud beta run services logs tail tails log-entries for a + particular Cloud Run service in real time. The log entries are formatted + for consumption in a terminal. + +EXAMPLES + To tail log entries for a Cloud Run Service, run: + + $ gcloud beta run services logs tail my-service + + To tail log entries with severity ERROR or higher, run: + + $ gcloud beta run services logs tail my-service \ + --log-filter="severity>=ERROR" + + Detailed information about filters can be found at: + https://cloud.google.com/logging/docs/view/advanced_filters + +POSITIONAL ARGUMENTS + SERVICE + Name for a Cloud Run service. + +FLAGS + --log-filter=LOG_FILTER + Filter expression that specifies the log entries to return. Detailed + information about filters can be found at: + https://cloud.google.com/logging/docs/view/logging-query-language + + --platform=PLATFORM; default="managed" + Target platform for running commands. Alternatively, set the property + [run/platform]. PLATFORM must be one of: + + managed + Fully managed version of Cloud Run. Use with the --region flag or + set the [run/region] property to specify a Cloud Run region. + gke + Cloud Run for Anthos on Google Cloud. Use with the --cluster and + --cluster-location flags or set the [run/cluster] and + [run/cluster_location] properties to specify a cluster in a given + zone. + kubernetes + Use a Knative-compatible kubernetes cluster. Use with the + --kubeconfig and --context flags to specify a kubeconfig file and + the context for connecting. + + Arguments to locate resources, depending on the platform used. + + At most one of these can be specified: + + Only applicable if connecting to Cloud Run (fully managed). Specify + --platform=managed to use: + + --region=REGION + Region in which the resource can be found. Alternatively, set the + property [run/region]. + + Only applicable if connecting to Cloud Run for Anthos deployed on Google + Cloud. Specify --platform=gke to use: + + Cluster resource - Kubernetes Engine cluster to connect to. 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 --cluster on the command line with a fully + specified name; + ▫ set the property run/cluster with a fully specified name; + ▫ specify the cluster from a list of available clusters with a + fully specified name; + ▫ provide the argument --project on the command line; + ▫ set the property core/project. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. + To set the cluster attribute: + ◇ provide the argument --cluster on the command line; + ◇ set the property run/cluster; + ◇ specify the cluster from a list of available clusters. + + --cluster-location=CLUSTER_LOCATION + Zone in which the cluster is located. Alternatively, set the + property [run/cluster_location]. To set the location attribute: + ◇ provide the argument --cluster on the command line with a + fully specified name; + ◇ set the property run/cluster with a fully specified name; + ◇ specify the cluster from a list of available clusters with a + fully specified name; + ◇ provide the argument --cluster-location on the command line; + ◇ set the property run/cluster_location; + ◇ specify the cluster location from a list of available zones. + + Only applicable if connecting to Cloud Run for Anthos deployed on + VMware. Specify --platform=kubernetes to use: + + --context=CONTEXT + The name of the context in your kubectl config file to use for + connecting. + + --kubeconfig=KUBECONFIG + The absolute path to your kubectl config file. If not specified, + the colon- or semicolon-delimited list of paths specified by + $KUBECONFIG will be used. If $KUBECONFIG is unset, this defaults to + ~/.kube/config. + +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. This + variant is also available: + + $ gcloud alpha run services logs tail + diff --git a/gcloud/beta/run/services/update b/gcloud/beta/run/services/update index b8ad740ef..4250a41cb 100644 --- a/gcloud/beta/run/services/update +++ b/gcloud/beta/run/services/update @@ -213,7 +213,7 @@ FLAGS --[no-]cpu-boost Whether to allocate extra CPU to containers on startup. This can - reduce the percieved latency of a cold start request. Use --cpu-boost + reduce the perceived latency of a cold start request. Use --cpu-boost to enable and --no-cpu-boost to disable. --[no-]cpu-throttling @@ -328,7 +328,10 @@ FLAGS --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. + 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 diff --git a/gcloud/beta/scc/assets/describe b/gcloud/beta/scc/assets/describe index a882cfe32..66b7eea04 100644 --- a/gcloud/beta/scc/assets/describe +++ b/gcloud/beta/scc/assets/describe @@ -33,15 +33,17 @@ EXAMPLES $ gcloud beta scc assets describe folders/456/assets/5678 POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/beta/scc/assets/group b/gcloud/beta/scc/assets/group index fe0afc126..e52f8c751 100644 --- a/gcloud/beta/scc/assets/group +++ b/gcloud/beta/scc/assets/group @@ -53,15 +53,17 @@ EXAMPLES --group-by="state_change" POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/beta/scc/assets/list b/gcloud/beta/scc/assets/list index cf3c0f26a..b17aa38ca 100644 --- a/gcloud/beta/scc/assets/list +++ b/gcloud/beta/scc/assets/list @@ -72,15 +72,17 @@ EXAMPLES $ gcloud beta scc assets list 123456 --compare-duration=86400s POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/beta/scc/findings/create b/gcloud/beta/scc/findings/create index 4c2478690..ae5b008fb 100644 --- a/gcloud/beta/scc/findings/create +++ b/gcloud/beta/scc/findings/create @@ -5,8 +5,8 @@ NAME SYNOPSIS gcloud beta scc findings create (FINDING : --organization=ORGANIZATION --source=SOURCE) - --category=CATEGORY --resource-name=RESOURCE_NAME - [--event-time=EVENT_TIME] [--external-uri=EXTERNAL_URI] + --category=CATEGORY --event-time=EVENT_TIME + --resource-name=RESOURCE_NAME [--external-uri=EXTERNAL_URI] [--source-properties=[SOURCE_PROPERTIES,...]] [--state=STATE] [GCLOUD_WIDE_FLAG ...] @@ -19,8 +19,9 @@ EXAMPLES $ gcloud beta scc findings create my-finding --organization=123456 \ --source=5678 --state=ACTIVE --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' Create an ACTIVE my-finding attached to example-project under project example-project and source 5678: @@ -28,8 +29,9 @@ EXAMPLES $ gcloud beta scc findings create \ projects/example-project/sources/5678/findings/my-finding \ --state=ACTIVE --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' Create an ACTIVE my-finding attached to example-project under folder 456 and source 5678: @@ -37,8 +39,9 @@ EXAMPLES $ gcloud beta scc findings create \ folders/456/sources/5678/findings/my-finding --state=ACTIVE \ --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' POSITIONAL ARGUMENTS Finding resource - The finding to be used for the SCC (Security Command @@ -83,19 +86,18 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --category=CATEGORY Taxonomy group within findings from a given source. Example: - XSS_FLASH_INJECTION + XSS_SCRIPTING + + --event-time=EVENT_TIME + Time at which the issue is detected or the finding is created, in the + following format: YYYY-MM-DDThh:mm:ss.ffffffZ. Example: + 2023-01-11T07:00:06.861Z --resource-name=RESOURCE_NAME Full resource name of the Google Cloud Platform resource this finding is for. OPTIONAL FLAGS - --event-time=EVENT_TIME - Time at which the event took place. For example, if the finding - represents an open firewall it would capture the time the open firewall - was detected. If event-time is not provided, it will default to UTC - version of NOW. For example 2019-02-28T07:00:00Z - --external-uri=EXTERNAL_URI URI that, if available, points to a web page outside of Cloud SCC (Security Command Center) where additional information about the diff --git a/gcloud/beta/scc/findings/group b/gcloud/beta/scc/findings/group index 65fd61211..f571760b4 100644 --- a/gcloud/beta/scc/findings/group +++ b/gcloud/beta/scc/findings/group @@ -55,15 +55,17 @@ EXAMPLES --group-by="state_change" --compare-duration=86400s POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/beta/scc/findings/list b/gcloud/beta/scc/findings/list index 68f99b8cf..3b669d5b4 100644 --- a/gcloud/beta/scc/findings/list +++ b/gcloud/beta/scc/findings/list @@ -65,15 +65,17 @@ EXAMPLES --filter="state=\"ACTIVE\"" --read-time="2019-01-01T01:00:00Z" POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/beta/scc/notifications/list b/gcloud/beta/scc/notifications/list index 97dd0895c..4b98863ce 100644 --- a/gcloud/beta/scc/notifications/list +++ b/gcloud/beta/scc/notifications/list @@ -25,15 +25,17 @@ EXAMPLES $ gcloud beta scc notifications list projects/789 POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/beta/services/api-keys/create b/gcloud/beta/services/api-keys/create new file mode 100644 index 000000000..0bc543c00 --- /dev/null +++ b/gcloud/beta/services/api-keys/create @@ -0,0 +1,116 @@ +NAME + gcloud beta services api-keys create - create an API key + +SYNOPSIS + gcloud beta services api-keys create [--annotations=[KEY=VALUE,...]] + [--async] [--display-name=DISPLAY_NAME] + [--api-target=service=SERVICE,[...] + --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT, + package_name=PACKAGE_NAME,...] + | --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] + | --allowed-ips=[ALLOWED_IPS,...] + | --allowed-referrers=[ALLOWED_REFERRERS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create an API key. + +EXAMPLES + To create a key with display name and allowed ips specified: + + $ gcloud beta services api-keys create --display-name="test name" \ + --allowed-ips=2620:15c:2c4:203:2776:1f90:6b3b:217,104.133.8.78 + + To create a key with annotations: + + $ gcloud beta services api-keys create --annotations=foo=bar,abc=def + + To create a key with allowed referrers restriction: + + $ gcloud beta services api-keys create \ + --allowed-referrers="https://www.example.com/*,http://sub.exampl\ + e.com/*" + + To create a key with allowed ios app bundle ids: + + $ gcloud beta services api-keys create --allowed-bundle-ids=my.app + + To create a key with allowed android application: + + $ gcloud beta services api-keys create \ + --allowed-application=sha1_fingerprint=foo1,\ + package_name=bar.foo \ + --allowed-application=sha1_fingerprint=foo2,package_name=foo.bar + + To create a key with allowed api targets (service name only): + + $ gcloud beta services api-keys create \ + --api-target=service=bar.service.com \ + --api-target=service=foo.service.com + + To create a keys with allowed api targets (service and methods are + specified): + + $ gcloud beta services api-keys create --flags-file=my-flags.yaml + + The content of 'my-flags.yaml' is as following: + + - --api-target: + service: + - "foo.service.com" + - --api-target: + service: + - "bar.service.com" + methods: + - "foomethod" + - "barmethod" + +FLAGS + --annotations=[KEY=VALUE,...] + Annotations are key resource. Specify annotations as a key-value + dictionary for small amounts of arbitrary client data. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + Display name of the key to create. + + --api-target=service=SERVICE,[...] + Repeatable. Specify service and optionally one or multiple specific + methods. Both fields are case insensitive. If you need to specify + methods, it should be specified with the --flags-file. See $ gcloud + topic flags-file for details. See the examples section for how to use + --api-target in --flags-file. + + At most one of these can be specified: + + --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT,package_name=PACKAGE_NAME,...] + Repeatable. Specify multiple allowed applications. The accepted keys + are sha1_fingerprint and package_name. + + --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] + iOS app's bundle ids that are allowed to use the key. + + --allowed-ips=[ALLOWED_IPS,...] + A list of the caller IP addresses that are allowed to make API calls + with this key. + + --allowed-referrers=[ALLOWED_REFERRERS,...] + A list of regular expressions for the referrer URLs that are allowed + to make API calls with this key. + +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. This + variant is also available: + + $ gcloud alpha services api-keys create + diff --git a/gcloud/beta/services/api-keys/delete b/gcloud/beta/services/api-keys/delete new file mode 100644 index 000000000..f934e3cd7 --- /dev/null +++ b/gcloud/beta/services/api-keys/delete @@ -0,0 +1,61 @@ +NAME + gcloud beta services api-keys delete - delete an API key + +SYNOPSIS + gcloud beta services api-keys delete (KEY : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + Delete an API Key : + + $ gcloud beta services api-keys delete \ + projects/myproject/locations/global/keys/1234 + + $ gcloud beta services api-keys delete 1234 + +POSITIONAL ARGUMENTS + Key resource - The name of the key 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 key 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. + + KEY + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the key. To set the location attribute: + ▸ provide the argument key on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location will default to global. + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha services api-keys delete + diff --git a/gcloud/beta/services/api-keys/describe b/gcloud/beta/services/api-keys/describe new file mode 100644 index 000000000..9b150972b --- /dev/null +++ b/gcloud/beta/services/api-keys/describe @@ -0,0 +1,69 @@ +NAME + gcloud beta services api-keys describe - describe an API key's metadata + +SYNOPSIS + gcloud beta services api-keys describe (KEY : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe an API key's metadata. + +EXAMPLES + To describe an API key using Key: + + $ gcloud beta services api-keys describe 1234 OR + $ gcloud beta services api-keys describe \ + projects/myproject/locations/global/keys/1234 + + To describe an API key with key and project: + + $ gcloud beta services api-keys describe 1234 --project=myproject + + To describe an API key with key, project, and location: + + $ gcloud beta services api-keys describe 1234 --project=myproject \ + --location=global + +POSITIONAL ARGUMENTS + Key resource - The name of the key 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 key 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. + + KEY + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the key. To set the location attribute: + ▸ provide the argument key on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location will default to global. + +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 services api-keys describe + + $ gcloud alpha services api-keys describe + diff --git a/gcloud/beta/services/api-keys/get-key-string b/gcloud/beta/services/api-keys/get-key-string new file mode 100644 index 000000000..d946c00c1 --- /dev/null +++ b/gcloud/beta/services/api-keys/get-key-string @@ -0,0 +1,60 @@ +NAME + gcloud beta services api-keys get-key-string - get the key string of an API + key + +SYNOPSIS + gcloud beta services api-keys get-key-string (KEY : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To get the key string of API key 1234, run: + + $ gcloud beta services api-keys get-key-string 1234 + + To get the key string of API key 1234 in project myproject using the fully + qualified API key name, run: + + $ gcloud beta services api-keys get-key-string \ + projects/myproject/locations/global/keys/1234 + +POSITIONAL ARGUMENTS + Key resource - The name of the key to retrieve key string. 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 key 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. + + KEY + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the key. To set the location attribute: + ▸ provide the argument key on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location will default to global. + +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. This + variant is also available: + + $ gcloud alpha services api-keys get-key-string + diff --git a/gcloud/beta/services/api-keys/help b/gcloud/beta/services/api-keys/help new file mode 100644 index 000000000..ca9a47aa7 --- /dev/null +++ b/gcloud/beta/services/api-keys/help @@ -0,0 +1,49 @@ +NAME + gcloud beta services api-keys - manage API keys + +SYNOPSIS + gcloud beta services api-keys COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage API keys. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create an API key. + + delete + (BETA) Delete an API key. + + describe + (BETA) Describe an API key's metadata. + + get-key-string + (BETA) Get the key string of an API key. + + list + (BETA) Lists API keys. + + lookup + (BETA) Look up resource name of a key string. + + undelete + (BETA) Undelete an API key. + + update + (BETA) Update an API key's metadata. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud services api-keys + + $ gcloud alpha services api-keys + diff --git a/gcloud/beta/services/api-keys/list b/gcloud/beta/services/api-keys/list new file mode 100644 index 000000000..c4eadaf00 --- /dev/null +++ b/gcloud/beta/services/api-keys/list @@ -0,0 +1,74 @@ +NAME + gcloud beta services api-keys list - lists API keys + +SYNOPSIS + gcloud beta services api-keys list [--show-deleted] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Lists the API keys of a given project. + +EXAMPLES + List keys of a given project: + + $ gcloud beta services api-keys list + + List keys of a given project, including keys that were soft-deleted in the + past 30 days.: + + $ gcloud beta services api-keys list --show-deleted \ + --project=my_project + +FLAGS + --show-deleted + Show soft-deleted keys by specifying this flag. + +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 + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud services api-keys list + + $ gcloud alpha services api-keys list + diff --git a/gcloud/beta/services/api-keys/lookup b/gcloud/beta/services/api-keys/lookup new file mode 100644 index 000000000..b03a96e85 --- /dev/null +++ b/gcloud/beta/services/api-keys/lookup @@ -0,0 +1,30 @@ +NAME + gcloud beta services api-keys lookup - look up resource name of a key + string + +SYNOPSIS + gcloud beta services api-keys lookup KEY_STRING [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + Look up resource name of a key string named my-key-string: + + $ gcloud beta services api-keys lookup my-key-string + +POSITIONAL ARGUMENTS + KEY_STRING + Key string of the key + +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. This + variant is also available: + + $ gcloud alpha services api-keys lookup + diff --git a/gcloud/beta/services/api-keys/undelete b/gcloud/beta/services/api-keys/undelete new file mode 100644 index 000000000..c82ba94fa --- /dev/null +++ b/gcloud/beta/services/api-keys/undelete @@ -0,0 +1,66 @@ +NAME + gcloud beta services api-keys undelete - undelete an API key + +SYNOPSIS + gcloud beta services api-keys undelete (KEY : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) API Keys that are deleted will be retained in the system for 30 + days. If a key is still within this retention window, it can be undeleted + with this command. + +EXAMPLES + UnDelete an API Key : + + $ gcloud beta services api-keys undelete \ + projects/myproject/locations/global/keys/1234 + + $ gcloud beta services api-keys undelete 1234 + +POSITIONAL ARGUMENTS + Key resource - The name of the key to undelete. 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 key 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. + + KEY + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the key. To set the location attribute: + ▸ provide the argument key on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location will default to global. + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha services api-keys undelete + diff --git a/gcloud/beta/services/api-keys/update b/gcloud/beta/services/api-keys/update new file mode 100644 index 000000000..6752fcacc --- /dev/null +++ b/gcloud/beta/services/api-keys/update @@ -0,0 +1,162 @@ +NAME + gcloud beta services api-keys update - update an API key's metadata + +SYNOPSIS + gcloud beta services api-keys update (KEY : --location=LOCATION) + [--annotations=[KEY=VALUE,...]] [--async] [--display-name=DISPLAY_NAME] + [--clear-annotations | --clear-restrictions + | --api-target=service=SERVICE,[...] + --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT, + package_name=PACKAGE_NAME,...] + | --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] + | --allowed-ips=[ALLOWED_IPS,...] + | --allowed-referrers=[ALLOWED_REFERRERS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update an API key's metadata. + +EXAMPLES + To remove all restrictions of the key: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id --clear-restrictions + + To update display name and set allowed ips as server key restrictions: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id --display-name="test name" \ + --allowed-ips=2620:15c:2c4:203:2776:1f90:6b3b:217,104.133.8.78 + + To update annoatations: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id --annotations=foo=bar,abc=def + + To update key's allowed referrers restriction: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id \ + --allowed-referrers="https://www.example.com/*,http://sub.exampl\ + e.com/*" + + To update key's allowed ios app bundle ids: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id --allowed-bundle-ids=my.app + + To update key's allowed android application: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id \ + --allowed-application=sha1_fingerprint=foo1,package_name=bar1 \ + --allowed-application=sha1_fingerprint=foo2,package_name=bar2 + + To update keys' allowed api target with multiple services: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id \ + --api-target=service=bar.service.com \ + --api-target=service=foo.service.com + + To update keys' allowed api target with service and method: + + $ gcloud beta services api-keys update \ + projects/myproject/keys/my-key-id --flags-file=my-flags.yaml + + The content of 'my-flags.yaml' is as following: + + - --api-target: + service: + - "foo.service.com" + - --api-target: + service: + - "bar.service.com" + methods: + - "foomethod" + - "barmethod" + +POSITIONAL ARGUMENTS + Key resource - The name of the key to update. 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 key 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. + + KEY + ID of the key or fully qualified identifier for the key. To set the + key attribute: + ▸ provide the argument key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Location of the key. To set the location attribute: + ▸ provide the argument key on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ location will default to global. + +FLAGS + --annotations=[KEY=VALUE,...] + Annotations are key resource. Specify annotations as a key-value + dictionary for small amounts of arbitrary client data. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --display-name=DISPLAY_NAME + Display name of the key to update. + + At most one of these can be specified: + + --clear-annotations + If set, clear all annotations on the key. + + --clear-restrictions + If set, clear all restrictions on the key. + + --api-target=service=SERVICE,[...] + Repeatable. Specify service and optionally one or multiple specific + methods. Both fields are case insensitive. If you need to specify + methods, it should be specified with the --flags-file. See $ gcloud + topic flags-file for details. See the examples section for how to use + --api-target in --flags-file. + + At most one of these can be specified: + + --allowed-application=[sha1_fingerprint=SHA1_FINGERPRINT,package_name=PACKAGE_NAME,...] + Repeatable. Specify multiple allowed applications. The accepted + keys are sha1_fingerprint and package_name. + + --allowed-bundle-ids=[ALLOWED_BUNDLE_IDS,...] + iOS app's bundle ids that are allowed to use the key. + + --allowed-ips=[ALLOWED_IPS,...] + A list of the caller IP addresses that are allowed to make API + calls with this key. + + --allowed-referrers=[ALLOWED_REFERRERS,...] + A list of regular expressions for the referrer URLs that are + allowed to make API calls with this key. + +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. This + variant is also available: + + $ gcloud alpha services api-keys update + diff --git a/gcloud/beta/services/help b/gcloud/beta/services/help index 0511ed008..76ecc60c1 100644 --- a/gcloud/beta/services/help +++ b/gcloud/beta/services/help @@ -29,6 +29,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + api-keys + (BETA) Manage API keys. + identity (BETA) Manage service identity. diff --git a/gcloud/beta/services/list b/gcloud/beta/services/list index 67cd69e6e..70aa41d1d 100644 --- a/gcloud/beta/services/list +++ b/gcloud/beta/services/list @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud beta services list [--available | --enabled] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] + [--limit=LIMIT] [--page-size=PAGE_SIZE; default=200] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command lists the services that are enabled or available to be @@ -44,12 +44,11 @@ LIST COMMAND FLAGS flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit. - --page-size=PAGE_SIZE + --page-size=PAGE_SIZE; default=200 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. + specifies the maximum number of resources per page. The default is 200. + 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 diff --git a/gcloud/beta/spanner/samples/run b/gcloud/beta/spanner/samples/run index 58d93380a..54c3b8b13 100644 --- a/gcloud/beta/spanner/samples/run +++ b/gcloud/beta/spanner/samples/run @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta spanner samples run APPNAME --instance-id=INSTANCE_ID [--no-cleanup] [--database-id=DATABASE_ID] - [--duration=DURATION; default="1h"] [GCLOUD_WIDE_FLAG ...] + [--duration=DURATION; default="1h"] [--skip-init] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Each Cloud Spanner sample application includes a backend gRPC @@ -44,6 +45,9 @@ OPTIONAL FLAGS Duration of time allowed to run the sample app before stopping the service. + --skip-init + Use an existing database instead of creating a new one. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/sql/export/bak b/gcloud/beta/sql/export/bak index a36ad9c3b..2a481224d 100644 --- a/gcloud/beta/sql/export/bak +++ b/gcloud/beta/sql/export/bak @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta sql export bak INSTANCE URI --database=DATABASE,[DATABASE,...], - -d DATABASE,[DATABASE,...] [--async] [GCLOUD_WIDE_FLAG ...] + -d DATABASE,[DATABASE,...] [--async] [--stripe_count=STRIPE_COUNT] + [--[no-]striped] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Export data from a Cloud SQL instance to a Google Cloud Storage @@ -37,6 +38,13 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --stripe_count=STRIPE_COUNT + Specifies the number of stripes to use for SQL Server exports. + + --[no-]striped + Whether SQL Server export should be striped. Use --striped to enable + and --no-striped to disable. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/sql/import/bak b/gcloud/beta/sql/import/bak index 26fbaca6b..3762ad6b0 100644 --- a/gcloud/beta/sql/import/bak +++ b/gcloud/beta/sql/import/bak @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud beta sql import bak INSTANCE URI --database=DATABASE, -d DATABASE - [--async] + [--async] [--[no-]striped] [--cert-path=CERT_PATH --pvk-path=PVK_PATH (--prompt-for-pvk-password | --pvk-password=PVK_PASSWORD)] [GCLOUD_WIDE_FLAG ...] @@ -50,6 +50,10 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --[no-]striped + Whether SQL Server import should be striped. Use --striped to enable + and --no-striped to disable. + Encryption info to support importing an encrypted .bak file --cert-path=CERT_PATH diff --git a/gcloud/beta/sql/instances/clone b/gcloud/beta/sql/instances/clone index f15f3f0c4..93ea2aed2 100644 --- a/gcloud/beta/sql/instances/clone +++ b/gcloud/beta/sql/instances/clone @@ -3,8 +3,10 @@ NAME SYNOPSIS gcloud beta sql instances clone SOURCE DESTINATION [--async] - [--point-in-time=POINT_IN_TIME | --bin-log-file-name=BIN_LOG_FILE_NAME - --bin-log-position=BIN_LOG_POSITION] [GCLOUD_WIDE_FLAG ...] + [--bin-log-file-name=BIN_LOG_FILE_NAME + --bin-log-position=BIN_LOG_POSITION | [--point-in-time=POINT_IN_TIME + : --restore-database-name=RESTORE_DATABASE_NAME]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta sql instances clone creates a clone of a Cloud SQL @@ -21,6 +23,10 @@ DESCRIPTION the instance to clone. If not specified, the current state of the instance is cloned. + For SQL Server: The point in time, if specified, defines a past state of + the instance to clone. If not specified, the current state of the instance + is cloned. + EXAMPLES To clone an instance from its current state (most recent binary log coordinates): @@ -43,6 +49,11 @@ EXAMPLES $ gcloud beta sql instances clone instance-foo instance-bar \ --point-in-time '2012-11-15T16:19:00.094Z' + To clone a SQL Server source instance at a specific point in time: + + $ gcloud beta sql instances clone instance-foo instance-bar \ + --point-in-time '2012-11-15T16:19:00.094Z' + POSITIONAL ARGUMENTS SOURCE Cloud SQL instance ID of the source. @@ -57,17 +68,6 @@ FLAGS At most one of these can be specified: - --point-in-time=POINT_IN_TIME - Represents the state of an instance at any given point in time inside - a transaction log file. For MySQL, the binary log file is used for - transaction logs. For PostgreSQL, the write-ahead log file is used - for transaction logs. To create a transaction log, enable - point-in-time recovery on the source instance. Instance should have - transaction logs accumulated upto the point in time they want to - restore upto. Uses RFC 3339 format in UTC timezone. If specified, - defines a past state of the instance to clone. For example, - '2012-11-15T16:19:00.094Z'. - Binary log coordinates for point-in-time recovery. --bin-log-file-name=BIN_LOG_FILE_NAME @@ -90,6 +90,26 @@ FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --point-in-time=POINT_IN_TIME + Represents the state of an instance at any given point in time inside + a transaction log file. For MySQL, the binary log file is used for + transaction logs. For PostgreSQL, the write-ahead log file is used + for transaction logs. For SQL Server, the log backup file is used for + such purpose. To create a transaction log, enable point-in-time + recovery on the source instance. Instance should have transaction + logs accumulated up to the point in time they want to restore up to. + Uses RFC 3339 format in UTC timezone. If specified, defines a past + state of the instance to clone. For example, + '2012-11-15T16:19:00.094Z'. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --restore-database-name=RESTORE_DATABASE_NAME + The name of the database to be restored for a point-in-time restore. + If set, the destination instance will only restore the specified + database. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/sql/instances/create b/gcloud/beta/sql/instances/create index 208447b7a..8e2387d2b 100644 --- a/gcloud/beta/sql/instances/create +++ b/gcloud/beta/sql/instances/create @@ -20,8 +20,8 @@ SYNOPSIS [--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE] [--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE] [--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] - [--enable-bin-log] [--enable-password-policy] - [--enable-point-in-time-recovery] + [--enable-bin-log] [--enable-google-private-path] + [--enable-password-policy] [--enable-point-in-time-recovery] [--failover-replica-name=FAILOVER_REPLICA_NAME] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] @@ -46,6 +46,7 @@ SYNOPSIS [--storage-auto-increase-limit=STORAGE_AUTO_INCREASE_LIMIT] [--storage-size=STORAGE_SIZE] [--storage-type=STORAGE_TYPE] [--tier=TIER, -t TIER] [--time-zone=TIME_ZONE] + [--timeout=TIMEOUT; default=3600] [--disk-encryption-key=DISK_ENCRYPTION_KEY : --disk-encryption-key-keyring=DISK_ENCRYPTION_KEY_KEYRING --disk-encryption-key-location=DISK_ENCRYPTION_KEY_LOCATION @@ -116,8 +117,7 @@ FLAGS --[no-]assign-ip Assign a public IP address to the instance. This is a public, externally available IPv4 address that you can use to connect to your - instance when properly authorized. Use --assign-ip to enable a public - IP and --no-assign-ip to disable it. Use --assign-ip to enable and + instance when properly authorized. Use --assign-ip to enable and --no-assign-ip to disable. --async @@ -202,9 +202,8 @@ FLAGS --[no-]deletion-protection Enable deletion protection on a Cloud SQL instance. Use - --deletion-protection to enable deletion protection on an instance and - --no-deletion-protection to disable it. Use --deletion-protection to - enable and --no-deletion-protection to disable. + --deletion-protection to enable and --no-deletion-protection to + disable. --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE Date when the deny maintenance period ends, that is 2021-01-10. @@ -220,6 +219,13 @@ FLAGS fraction of a second. Must have automatic backups enabled to use. Make sure storage can support at least 7 days of logs. + --enable-google-private-path + Enable a private path for Google Cloud services. This flag specifies + whether the instance is accessible to internal Google Cloud services + such as BigQuery. This is only applicable to MySQL and PostgreSQL + instances that don't use public IP. Currently, SQL Server isn't + supported. + --enable-password-policy Enable the password policy, which enforces user password management with the policies configured for the instance. This flag is only @@ -398,6 +404,12 @@ FLAGS --time-zone=TIME_ZONE Set a non-default time zone. Only available for SQL Server instances. + --timeout=TIMEOUT; default=3600 + Time to synchronously wait for the operation to complete, after which + the operation continues asynchronously. Ignored if --async flag is + specified. By default, set to 3600s. To wait indefinitely, set to + unlimited. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/beta/sql/instances/patch b/gcloud/beta/sql/instances/patch index 0ce33a1a0..86bdb1c13 100644 --- a/gcloud/beta/sql/instances/patch +++ b/gcloud/beta/sql/instances/patch @@ -17,8 +17,8 @@ SYNOPSIS [--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE] [--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] [--diff] [--[no-]enable-bin-log] [--[no-]enable-database-replication] - [--enable-password-policy] [--enable-point-in-time-recovery] - [--follow-gae-app=FOLLOW_GAE_APP] + [--enable-google-private-path] [--enable-password-policy] + [--enable-point-in-time-recovery] [--follow-gae-app=FOLLOW_GAE_APP] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] [--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH] @@ -81,8 +81,7 @@ FLAGS --[no-]assign-ip Assign a public IP address to the instance. This is a public, externally available IPv4 address that you can use to connect to your - instance when properly authorized. Use --assign-ip to enable a public - IP and --no-assign-ip to disable it. Use --assign-ip to enable and + instance when properly authorized. Use --assign-ip to enable and --no-assign-ip to disable. --async @@ -143,9 +142,8 @@ FLAGS --[no-]deletion-protection Enable deletion protection on a Cloud SQL instance. Use - --deletion-protection to enable deletion protection on an instance and - --no-deletion-protection to disable it. Use --deletion-protection to - enable and --no-deletion-protection to disable. + --deletion-protection to enable and --no-deletion-protection to + disable. --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE Date when the deny maintenance period ends, that is 2021-01-10. @@ -171,6 +169,13 @@ FLAGS --enable-database-replication to enable and --no-enable-database-replication to disable. + --enable-google-private-path + Enable a private path for Google Cloud services. This flag specifies + whether the instance is accessible to internal Google Cloud services + such as BigQuery. This is only applicable to MySQL and PostgreSQL + instances that don't use public IP. Currently, SQL Server isn't + supported. + --enable-password-policy Enable the password policy, which enforces user password management with the policies configured for the instance. This flag is only diff --git a/gcloud/beta/terraform/vet b/gcloud/beta/terraform/vet index 474c3c39a..1d8521b97 100644 --- a/gcloud/beta/terraform/vet +++ b/gcloud/beta/terraform/vet @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta terraform vet TERRAFORM_PLAN_JSON - --policy-library=POLICY_LIBRARY [GCLOUD_WIDE_FLAG ...] + --policy-library=POLICY_LIBRARY [--region=REGION] [--zone=ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Validate that a terraform plan complies with policies. @@ -25,6 +26,13 @@ REQUIRED FLAGS --policy-library=POLICY_LIBRARY Directory which contains a policy library +OPTIONAL FLAGS + --region=REGION + Default region to use for resources that do not have one set + + --zone=ZONE + Default zone to use for resources that do not have one set + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/topic/help b/gcloud/beta/topic/help new file mode 100644 index 000000000..1875c97bd --- /dev/null +++ b/gcloud/beta/topic/help @@ -0,0 +1,81 @@ +NAME + gcloud beta topic - gcloud supplementary help + +DESCRIPTION + (BETA) The gcloud beta topic command group provides supplementary help for + topics not directly associated with individual commands. + + More information on gcloud beta topic can be found by running: + + $ gcloud topic [TOPIC_NAME] + + For a list of available topics run: + + $ gcloud topic --help + +TOPICS + The supplementary help topics are: + + accessibility + (BETA) Reference for Accessibility features. + + arg-files + (BETA) Supplementary help for arg-files to be used with gcloud firebase + test. + + cli-trees + (BETA) CLI trees supplementary help. + + client-certificate + (BETA) Client certificate authorization supplementary help. + + command-conventions + (BETA) gcloud command conventions supplementary help. + + configurations + (BETA) Supplementary help for named configurations. + + datetimes + (BETA) Date/time input format supplementary help. + + endpoint-override + (BETA) gcloud endpoint override supplementary help. + + escaping + (BETA) List/dictionary-type argument escaping supplementary help. + + filters + (BETA) Resource filters supplementary help. + + flags-file + (BETA) --flags-file=YAML_FILE supplementary help. + + formats + (BETA) Resource formats supplementary help. + + gcloudignore + (BETA) Reference for .gcloudignore files. + + offline-help + (BETA) Setting up gcloud command offline help. + + projections + (BETA) Resource projections supplementary help. + + resource-keys + (BETA) Resource keys supplementary help. + + startup + (BETA) Supplementary help for gcloud startup options. + + uninstall + (BETA) Supplementary help for uninstalling Google Cloud CLI. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud topic + + $ gcloud alpha topic + diff --git a/gcloud/beta/workstations/clusters/create b/gcloud/beta/workstations/clusters/create new file mode 100644 index 000000000..3b41761cd --- /dev/null +++ b/gcloud/beta/workstations/clusters/create @@ -0,0 +1,89 @@ +NAME + gcloud beta workstations clusters create - create a workstation cluster + +SYNOPSIS + gcloud beta workstations clusters create (CLUSTER : --region=REGION) + [--async] [--enable-private-endpoint] [--network=NETWORK] + [--subnetwork=SUBNETWORK] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a workstation cluster. + +EXAMPLES + To create a public cluster my-cluster in region us-central1, run: + + $ gcloud beta workstations clusters create my-cluster \ + --region=us-central1 + + To create a private cluster 'my-private-cluster' associated with network + 'my-network' and subnetwork 'my-subnetwork'. run: + + $ gcloud beta workstations clusters create my-private-cluster \ + --region=us-central1 --enable-private-endpoint \ + --network='my-network' --subnetwork='my-subnetwork' + +POSITIONAL ARGUMENTS + Cluster resource - Arguments and flags that specify the cluster to create. + 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --enable-private-endpoint + Default is false. If specified, the cluster will be assigned an + internal IP address to the Cluster Gateway. This isolates the cluster's + workstations from public networks, but requires additional + configuration. Learn more: https://cloud.google.com/workstations/docs. + + --network=NETWORK + The network that instances created under the cluster will be associated + with. + + --subnetwork=SUBNETWORK + The subnetwork that instances created under the cluster will be + associated with. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations clusters create + diff --git a/gcloud/beta/workstations/clusters/delete b/gcloud/beta/workstations/clusters/delete new file mode 100644 index 000000000..84e8c639c --- /dev/null +++ b/gcloud/beta/workstations/clusters/delete @@ -0,0 +1,66 @@ +NAME + gcloud beta workstations clusters delete - delete a workstation cluster + +SYNOPSIS + gcloud beta workstations clusters delete (CLUSTER : --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a workstation cluster. + +EXAMPLES + To delete a cluster, run: + + $ gcloud beta workstations clusters delete WORKSTATION + +POSITIONAL ARGUMENTS + Cluster resource - The name of the cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations clusters delete + diff --git a/gcloud/beta/workstations/clusters/describe b/gcloud/beta/workstations/clusters/describe new file mode 100644 index 000000000..dfd96dc08 --- /dev/null +++ b/gcloud/beta/workstations/clusters/describe @@ -0,0 +1,61 @@ +NAME + gcloud beta workstations clusters describe - describe a cluster + +SYNOPSIS + gcloud beta workstations clusters describe (CLUSTER : --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a cluster. + +EXAMPLES + To describe a cluster, run: + + $ gcloud beta workstations clusters describe CLUSTER + +POSITIONAL ARGUMENTS + Cluster resource - The name of the cluster to display. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --region 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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations clusters describe + diff --git a/gcloud/beta/workstations/clusters/help b/gcloud/beta/workstations/clusters/help index 5532a5209..2a9bc411e 100644 --- a/gcloud/beta/workstations/clusters/help +++ b/gcloud/beta/workstations/clusters/help @@ -16,6 +16,15 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + create + (BETA) Create a workstation cluster. + + delete + (BETA) Delete a workstation cluster. + + describe + (BETA) Describe a cluster. + list (BETA) List workstation clusters. diff --git a/gcloud/beta/workstations/configs/create b/gcloud/beta/workstations/configs/create new file mode 100644 index 000000000..0f9ba7a23 --- /dev/null +++ b/gcloud/beta/workstations/configs/create @@ -0,0 +1,240 @@ +NAME + gcloud beta workstations configs create - create a workstation + configuration + +SYNOPSIS + gcloud beta workstations configs create + (CONFIG : --cluster=CLUSTER --region=REGION) [--async] + [--boot-disk-size=BOOT_DISK_SIZE; default=50] + [--container-args=[CONTAINER_ARGS,...]] + [--container-command=[CONTAINER_COMMAND,...]] + [--container-env=[CONTAINER_ENV,...]] + [--container-run-as-user=CONTAINER_RUN_AS_USER] + [--container-working-dir=CONTAINER_WORKING_DIR] + [--disable-public-ip-addresses] [--enable-confidential-compute] + [--idle-timeout=IDLE_TIMEOUT; default=7200] + [--machine-type=MACHINE_TYPE; default="e2-standard-4"] + [--network-tags=[NETWORK_TAGS,...]] + [--pd-disk-size=PD_DISK_SIZE; default=200] + [--pd-disk-type=PD_DISK_TYPE; default="pd-standard"] + [--pd-reclaim-policy=PD_RECLAIM_POLICY; default="delete"] + [--pool-size=POOL_SIZE] + [--running-timeout=RUNNING_TIMEOUT; default=7200] + [--service-account=SERVICE_ACCOUNT] [--shielded-integrity-monitoring] + [--shielded-secure-boot] [--shielded-vtpm] + [--container-custom-image=CONTAINER_CUSTOM_IMAGE + | --container-predefined-image=CONTAINER_PREDEFINED_IMAGE; + default="codeoss"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a workstation configuration. + +EXAMPLES + To create a configuration with the 'e2-standard-8' machine type and a + IntelliJ image, run: + + $ gcloud beta workstations configs create CONFIG \ + --machine-type=e2-standard-8 \ + --container-predefined-image=intellij + + To create a configuration with a Shielded VM instance that enables Secure + Boot, virtual trusted platform module (vTPM) and integrity monitoring, run: + + $ gcloud beta workstations configs create CONFIG \ + --machine-type=e2-standard-4 --shielded-secure-boot \ + --shielded-vtpm --shielded-integrity-monitoring + + To create a configuration with a non-default persistent disk containing + 10GB of PD SSD storage, run: $ gcloud beta workstations configs create CONFIG \ + --machine-type=e2-standard-4 --pd-disk-type=pd-ssd \ + --pd-disk-size=10 + +POSITIONAL ARGUMENTS + Config resource - The group of arguments defining a config 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 config 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. + + CONFIG + ID of the config or fully qualified identifier for the config. To set + the config attribute: + ▸ provide the argument config on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The cluster for the config. To set the cluster attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + The location for the config. To set the region attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --boot-disk-size=BOOT_DISK_SIZE; default=50 + Size of the boot disk in GB. + + --container-args=[CONTAINER_ARGS,...] + Arguments passed to the entrypoint. + + Example: + + $ gcloud beta workstations configs create \ + --container-args=arg_1,arg_2 + + --container-command=[CONTAINER_COMMAND,...] + If set, overrides the default ENTRYPOINT specified by the image. + + Example: + + $ gcloud beta workstations configs create \ + --container-command=executable,parameter_1,parameter_2 + + --container-env=[CONTAINER_ENV,...] + Environment variables passed to the container. + + Example: + + $ gcloud beta workstations configs create \ + --container-env=key1=value1,key2=value2 + + --container-run-as-user=CONTAINER_RUN_AS_USER + If set, overrides the USER specified in the image with the given uid. + + --container-working-dir=CONTAINER_WORKING_DIR + If set, overrides the default DIR specified by the image. + + --disable-public-ip-addresses + Default value is false. If set, instances will have no public IP + address. + + --enable-confidential-compute + Default value is false. If set, instances will have confidential + compute enabled. + + --idle-timeout=IDLE_TIMEOUT; default=7200 + How long (in seconds) to wait before automatically stopping an instance + that hasn't received any user traffic. A value of 0 indicates that this + instance should never time out due to idleness. + + --machine-type=MACHINE_TYPE; default="e2-standard-4" + Machine type determines the specifications of the Compute Engine + machines that the workstations created under this configuration will + run on. MACHINE_TYPE must be one of: e2-standard-2, e2-standard-4, + e2-standard-8, e2-standard-16, e2-standard-32, n2-standard-8, + n1-standard-4, t2d-standard-6, n2d-standard-2, n2d-standard-4, + n2d-standard-8, n2d-standard-16, n2d-standard-32. + + --network-tags=[NETWORK_TAGS,...] + Network tags to add to the Google Compute Engine machines backing the + Workstations. + + Example: + + $ gcloud beta workstations configs create --network-tags=tag_1,tag_2 + + --pd-disk-size=PD_DISK_SIZE; default=200 + Size of the persistent directory in GB. PD_DISK_SIZE must be one of: + 10, 50, 100, 200, 500, 1000. + + --pd-disk-type=PD_DISK_TYPE; default="pd-standard" + Type of the persistent directory. PD_DISK_TYPE must be one of: + pd-standard, pd-balanced, pd-ssd. + + --pd-reclaim-policy=PD_RECLAIM_POLICY; default="delete" + What should happen to the disk after the Workstation is deleted. + PD_RECLAIM_POLICY must be one of: + + delete + The persistent disk will be deleted with the Workstation. + retain + The persistent disk will be remain after the workstation is deleted + and the administrator must manually delete the disk. + + --pool-size=POOL_SIZE + Number of instances to pool for faster Workstation starup. + + --running-timeout=RUNNING_TIMEOUT; default=7200 + How long (in seconds) to wait before automatically stopping a + workstation after it started. A value of 0 indicates that workstations + using this config should never time out. + + --service-account=SERVICE_ACCOUNT + Email address of the service account that will be used on VM instances + used to support this config. This service account must have permission + to pull the specified container image. If not set, VMs will run without + a service account, in which case the image must be publicly accessible. + + --shielded-integrity-monitoring + Default value is false. If set, instances will have integrity + monitoring enabled. + + --shielded-secure-boot + Default value is false. If set, instances will have Secure Boot + enabled. + + --shielded-vtpm + Default value is false. If set, instances will have vTPM enabled. + + At most one of these can be specified: + + --container-custom-image=CONTAINER_CUSTOM_IMAGE + A docker image for the workstation. This image must be accessible by + the service account configured in this configuration + (--service-account). If no service account is defined, this image + must be public. + + --container-predefined-image=CONTAINER_PREDEFINED_IMAGE; default="codeoss" + Code editor on base images. CONTAINER_PREDEFINED_IMAGE must be one + of: + + base-image + Base image - no IDE + clion + CLion + codeoss + Code OSS + goland + GoLand + intellij + IntelliJ IDEA Ultimate + phpstorm + PhpStorm + pycharm + PyCharm Professional + rider + Rider + rubymine + RubyMine + webstorm + WebStorm + +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. This + variant is also available: + + $ gcloud alpha workstations configs create + diff --git a/gcloud/beta/workstations/configs/delete b/gcloud/beta/workstations/configs/delete new file mode 100644 index 000000000..77c2aaa64 --- /dev/null +++ b/gcloud/beta/workstations/configs/delete @@ -0,0 +1,76 @@ +NAME + gcloud beta workstations configs delete - delete a workstation + configuration + +SYNOPSIS + gcloud beta workstations configs delete + (CONFIG : --cluster=CLUSTER --region=REGION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a workstation configuration. + +EXAMPLES + To delete a configuration, run: + + $ gcloud beta workstations configs delete WORKSTATION + +POSITIONAL ARGUMENTS + Config resource - The name of the configuration 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 config 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. + + CONFIG + ID of the config or fully qualified identifier for the config. To set + the config attribute: + ▸ provide the argument config on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the config. + + To set the cluster attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + The name of the region of the config. + + To set the region attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations configs delete + diff --git a/gcloud/beta/workstations/configs/describe b/gcloud/beta/workstations/configs/describe new file mode 100644 index 000000000..8d32f1a24 --- /dev/null +++ b/gcloud/beta/workstations/configs/describe @@ -0,0 +1,69 @@ +NAME + gcloud beta workstations configs describe - describe a config + +SYNOPSIS + gcloud beta workstations configs describe + (CONFIG : --cluster=CLUSTER --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a config. + +EXAMPLES + To describe a config, run: + + $ gcloud beta workstations configs describe CONFIG + +POSITIONAL ARGUMENTS + Config resource - The name of the config to display. 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 config 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. + + CONFIG + ID of the config or fully qualified identifier for the config. To set + the config attribute: + ▸ provide the argument config on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the config. + + To set the cluster attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --region=REGION + The name of the region of the config. + + To set the region attribute: + ▸ provide the argument config on the command line with a fully + specified name; + ▸ provide the argument --region 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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations configs describe + diff --git a/gcloud/beta/workstations/configs/help b/gcloud/beta/workstations/configs/help new file mode 100644 index 000000000..f6844e16d --- /dev/null +++ b/gcloud/beta/workstations/configs/help @@ -0,0 +1,36 @@ +NAME + gcloud beta workstations configs - manage Cloud Workstations configuration + resources + +SYNOPSIS + gcloud beta workstations configs COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage Cloud Workstations configuration resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a workstation configuration. + + delete + (BETA) Delete a workstation configuration. + + describe + (BETA) Describe a config. + + list + (BETA) List workstation configurations. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations configs + diff --git a/gcloud/beta/workstations/configs/list b/gcloud/beta/workstations/configs/list new file mode 100644 index 000000000..5bd171449 --- /dev/null +++ b/gcloud/beta/workstations/configs/list @@ -0,0 +1,88 @@ +NAME + gcloud beta workstations configs list - list workstation configurations + +SYNOPSIS + gcloud beta workstations configs list (--cluster=CLUSTER : --region=REGION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List all workstation configurations under the specified cluster. + +EXAMPLES + To list workstation configurations, run: + + $ gcloud beta workstations configs list + +REQUIRED FLAGS + Cluster resource - The cluster of the configurations to display. 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 --cluster 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. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument --cluster on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --region=REGION + The name of the region of the cluster. + + To set the region attribute: + ▸ provide the argument --cluster on the command line with a fully + specified name; + ▸ provide the argument --region 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. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations configs list + diff --git a/gcloud/beta/workstations/create b/gcloud/beta/workstations/create new file mode 100644 index 000000000..fe35c5aa3 --- /dev/null +++ b/gcloud/beta/workstations/create @@ -0,0 +1,83 @@ +NAME + gcloud beta workstations create - create a workstation + +SYNOPSIS + gcloud beta workstations create + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a workstation. + +EXAMPLES + To create a workstation, run: + + $ gcloud beta workstations create WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - Arguments and flags that specify the workstation to + create. 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the workstation. + + To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The name of the config containing the workstation. + + To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The name of the region of the workstation. + + To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations create + diff --git a/gcloud/beta/workstations/delete b/gcloud/beta/workstations/delete new file mode 100644 index 000000000..08eabb2c0 --- /dev/null +++ b/gcloud/beta/workstations/delete @@ -0,0 +1,83 @@ +NAME + gcloud beta workstations delete - delete a workstation + +SYNOPSIS + gcloud beta workstations delete + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a workstation. + +EXAMPLES + To delete a workstation, run: + + $ gcloud beta workstations delete WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The name of the workstation 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the workstation. + + To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The name of the config containing the workstation. + + To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The name of the region of the workstation. + + To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations delete + diff --git a/gcloud/beta/workstations/describe b/gcloud/beta/workstations/describe new file mode 100644 index 000000000..a61d62b25 --- /dev/null +++ b/gcloud/beta/workstations/describe @@ -0,0 +1,78 @@ +NAME + gcloud beta workstations describe - describe a workstation + +SYNOPSIS + gcloud beta workstations describe + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a workstation. + +EXAMPLES + To describe a workstation, run: + + $ gcloud beta workstations describe WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The name of the workstation to display. 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The name of the cluster containing the workstation. + + To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The name of the config containing the workstation. + + To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The name of the region of the workstation. + + To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region 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 workstations/v1beta API. The full documentation for + this API can be found at: https://cloud.google.com/workstations + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations describe + diff --git a/gcloud/beta/workstations/help b/gcloud/beta/workstations/help index 7aef91859..ae94ce111 100644 --- a/gcloud/beta/workstations/help +++ b/gcloud/beta/workstations/help @@ -18,16 +18,34 @@ GROUPS clusters (BETA) Manage Cloud Workstations cluster resources. + configs + (BETA) Manage Cloud Workstations configuration resources. + COMMANDS COMMAND is one of the following: + create + (BETA) Create a workstation. + + delete + (BETA) Delete a workstation. + + describe + (BETA) Describe a workstation. + list (BETA) List workstations. + start + (BETA) Start a workstation. + start-tcp-tunnel - (BETA) Starts a tunnel through which a local process can forward TCP + (BETA) Start a tunnel through which a local process can forward TCP traffic to the workstation. + stop + (BETA) Stop a workstation. + NOTES This command is currently in beta and might change without notice. This variant is also available: diff --git a/gcloud/beta/workstations/list b/gcloud/beta/workstations/list index a7ea5a5fa..84ccb8c5b 100644 --- a/gcloud/beta/workstations/list +++ b/gcloud/beta/workstations/list @@ -8,7 +8,7 @@ SYNOPSIS [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List all workstations under the specified config. + (BETA) List all workstations under the specified configuration. EXAMPLES To list workstations, run: @@ -16,10 +16,10 @@ EXAMPLES $ gcloud beta workstations list REQUIRED FLAGS - Config resource - The config of the workstations to display. 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: + Config resource - The configuration of the workstations to display. 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 --config on the command line with a fully specified name; ◆ provide the argument --project on the command line; diff --git a/gcloud/beta/workstations/start b/gcloud/beta/workstations/start new file mode 100644 index 000000000..99d699ba9 --- /dev/null +++ b/gcloud/beta/workstations/start @@ -0,0 +1,73 @@ +NAME + gcloud beta workstations start - start a workstation + +SYNOPSIS + gcloud beta workstations start + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Start a workstation. + +EXAMPLES + To start a workstation, run + + $ gcloud beta workstations start WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The group of arguments defining a workstation 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The cluster for the workstation. To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The config for the workstation. To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The location for the workstation. To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations start + diff --git a/gcloud/beta/workstations/start-tcp-tunnel b/gcloud/beta/workstations/start-tcp-tunnel index d9e6a9fbb..48a0daccd 100644 --- a/gcloud/beta/workstations/start-tcp-tunnel +++ b/gcloud/beta/workstations/start-tcp-tunnel @@ -1,5 +1,5 @@ NAME - gcloud beta workstations start-tcp-tunnel - starts a tunnel through which a + gcloud beta workstations start-tcp-tunnel - start a tunnel through which a local process can forward TCP traffic to the workstation SYNOPSIS @@ -10,8 +10,8 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Starts a tunnel through which a local process can forward TCP - traffic to the workstation. + (BETA) Start a tunnel through which a local process can forward TCP traffic + to the workstation. EXAMPLES To start a tunnel to port 22 on a workstation, run: @@ -21,8 +21,8 @@ EXAMPLES my-workstation 22 POSITIONAL ARGUMENTS - Workstation resource - The workstation to which traffic should be sent. - The arguments in this group can be used to specify the attributes of this + Workstation resource - The group of arguments defining a workstation 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 workstation on the command line with a fully @@ -53,7 +53,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --config on the command line. --region=REGION - The region for the workstation. To set the region attribute: + The location for the workstation. To set the region attribute: ▸ provide the argument workstation on the command line with a fully specified name; ▸ provide the argument --region on the command line. diff --git a/gcloud/beta/workstations/stop b/gcloud/beta/workstations/stop new file mode 100644 index 000000000..2d83255fd --- /dev/null +++ b/gcloud/beta/workstations/stop @@ -0,0 +1,73 @@ +NAME + gcloud beta workstations stop - stop a workstation + +SYNOPSIS + gcloud beta workstations stop + (WORKSTATION : --cluster=CLUSTER --config=CONFIG --region=REGION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Stop a workstation. + +EXAMPLES + To stop a workstation, run + + $ gcloud beta workstations stop WORKSTATION + +POSITIONAL ARGUMENTS + Workstation resource - The group of arguments defining a workstation 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 workstation 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. + + WORKSTATION + ID of the workstation or fully qualified identifier for the + workstation. To set the workstation attribute: + ▸ provide the argument workstation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --cluster=CLUSTER + The cluster for the workstation. To set the cluster attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --cluster on the command line. + + --config=CONFIG + The config for the workstation. To set the config attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --config on the command line. + + --region=REGION + The location for the workstation. To set the region attribute: + ▸ provide the argument workstation on the command line with a fully + specified name; + ▸ provide the argument --region on the command line. + +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. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha workstations stop + diff --git a/gcloud/bigtable/instances/tables/create b/gcloud/bigtable/instances/tables/create new file mode 100644 index 000000000..a3c4a5f2b --- /dev/null +++ b/gcloud/bigtable/instances/tables/create @@ -0,0 +1,110 @@ +NAME + gcloud bigtable instances tables create - create a new Cloud Bigtable table + +SYNOPSIS + gcloud bigtable instances tables create (TABLE : --instance=INSTANCE) + --column-families=[COLUMN_FAMILIES,...] [--deletion-protection] + [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new Cloud Bigtable table. + +EXAMPLES + To create a table my-table in instance my-instance with a column family + my-family, run: + + $ gcloud bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" + + To create a table that has a column family named my-instance, a garbage + collection policy that lets data expire after 864,000 seconds, and initial + table splits on row keys car and key, run: + + $ gcloud bigtable instances tables create my-table \ + --instance=my-instance \ + --column-families="my-family:maxage=864000s" --splits=car,key + + To create a table my-table in instance my-instance that lets data in column + family my-family1 expire after 10 days and keeps a maximum of 5 cells per + column in column family my-family-2 if the data is less than 5 days old, + run: + + $ gcloud bigtable instances tables create my-table \ + --instance=my-instance \ + --column-families="my-family-1:maxage=10d,my-family-2:maxversion\ + s=5||maxage=5d" + + To create a deletion-protected table my-table in instance my-instance with + a column family my-family, run: + + $ gcloud bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --deletion-protection + + To create a table my-table without deletion protection in instance + my-instance with a column family my-family, run: + + $ gcloud bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --no-deletion-protection + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to create. 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --column-families=[COLUMN_FAMILIES,...] + A double-quote (") wrapped list of family name and corresponding + garbage collection rules concatenated by :, where the rules are + optional. For example: \ + "family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5" + +OPTIONAL FLAGS + --deletion-protection + Once specified, the table is deletion protected. + + --splits=[SPLITS,...] + Row keys where the table should initially be split. For example: + car,key + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable instances tables create + + $ gcloud beta bigtable instances tables create + diff --git a/gcloud/bigtable/instances/tables/delete b/gcloud/bigtable/instances/tables/delete new file mode 100644 index 000000000..45e441819 --- /dev/null +++ b/gcloud/bigtable/instances/tables/delete @@ -0,0 +1,61 @@ +NAME + gcloud bigtable instances tables delete - delete a Cloud Bigtable table + +SYNOPSIS + gcloud bigtable instances tables delete (TABLE : --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Cloud Bigtable table. + +EXAMPLES + To delete the table my-table in instance my-instance, run: + + $ gcloud bigtable instances tables delete my-table \ + --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance 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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable instances tables delete + + $ gcloud beta bigtable instances tables delete + diff --git a/gcloud/bigtable/instances/tables/describe b/gcloud/bigtable/instances/tables/describe index dea452212..840ee6db5 100644 --- a/gcloud/bigtable/instances/tables/describe +++ b/gcloud/bigtable/instances/tables/describe @@ -57,6 +57,9 @@ FLAGS Only populates name and fields related to the table's replication. schema Only populates name and fields related to the table's schema. + stats + Only populates name and fields related to the table's statistics + (e.g. TableStats and ColumnFamilyStats). GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/bigtable/instances/tables/help b/gcloud/bigtable/instances/tables/help index 458ba51a2..0b25d4fde 100644 --- a/gcloud/bigtable/instances/tables/help +++ b/gcloud/bigtable/instances/tables/help @@ -18,6 +18,12 @@ COMMANDS add-iam-policy-binding Add an IAM policy binding to a Cloud Bigtable table. + create + Create a new Cloud Bigtable table. + + delete + Delete a Cloud Bigtable table. + describe Retrieve information about a table. @@ -39,6 +45,9 @@ COMMANDS undelete Undelete a previously deleted Cloud Bigtable table. + update + Update an existing Cloud Bigtable table. + NOTES These variants are also available: diff --git a/gcloud/bigtable/instances/tables/restore b/gcloud/bigtable/instances/tables/restore index 78ddf9998..c5280a16a 100644 --- a/gcloud/bigtable/instances/tables/restore +++ b/gcloud/bigtable/instances/tables/restore @@ -21,12 +21,13 @@ EXAMPLES --source=backup1 --destination-instance=instance1 \ --destination=table2 - To restore table 'table2' from backup 'backup1' using relative names, run: + To restore table 'table2' from backup 'backup1' in a different project, + run: $ gcloud bigtable instances tables restore \ --source=projects/project1/instances/instance1/clusters/\ cluster1/backups/backup1 \ - --destination=projects/project1/instances/instance1/tables/\ + --destination=projects/project2/instances/instance2/tables/\ table2 REQUIRED FLAGS diff --git a/gcloud/bigtable/instances/tables/update b/gcloud/bigtable/instances/tables/update new file mode 100644 index 000000000..446ac2c6a --- /dev/null +++ b/gcloud/bigtable/instances/tables/update @@ -0,0 +1,76 @@ +NAME + gcloud bigtable instances tables update - update an existing Cloud Bigtable + table + +SYNOPSIS + gcloud bigtable instances tables update (TABLE : --instance=INSTANCE) + [--async] [--deletion-protection] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an existing new Cloud Bigtable table with the specified + configuration. + +EXAMPLES + To enable deletion protection, run: + + $ gcloud bigtable instances tables update my-table \ + --instance=my-instance --deletion-protection + + To disable deletion protection, run: + + $ gcloud bigtable instances tables update my-table \ + --instance=my-instance --no-deletion-protection + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to update. 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 table 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. + + TABLE + ID of the table or fully qualified identifier for the table. To set + the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deletion-protection + Once specified, the table is deletion protected. + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable instances tables update + + $ gcloud beta bigtable instances tables update + diff --git a/gcloud/builds/cancel b/gcloud/builds/cancel index 53f664406..47d40eb67 100644 --- a/gcloud/builds/cancel +++ b/gcloud/builds/cancel @@ -24,8 +24,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/builds/describe b/gcloud/builds/describe index 0bd5b2a1b..16d59e726 100644 --- a/gcloud/builds/describe +++ b/gcloud/builds/describe @@ -20,8 +20,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/builds/help b/gcloud/builds/help index b21448f73..e092d14f3 100644 --- a/gcloud/builds/help +++ b/gcloud/builds/help @@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + triggers + Create and manage build triggers for Google Cloud Build. + worker-pools Manage worker pools for Google Cloud Build. diff --git a/gcloud/builds/list b/gcloud/builds/list index e0fb661a1..64bdc152e 100644 --- a/gcloud/builds/list +++ b/gcloud/builds/list @@ -24,18 +24,17 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. 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. - With the exception of regex matching, this flag interacts with other - flags that are applied in this order: --flatten, --sort-by, --filter, - --limit. Any regex operations specified by --filter are applied - client-side, after --limit. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. --limit=LIMIT; default=50 Maximum number of resources to list. The default is 50. This flag diff --git a/gcloud/builds/log b/gcloud/builds/log index 1c35f5666..ba1f32c61 100644 --- a/gcloud/builds/log +++ b/gcloud/builds/log @@ -25,8 +25,9 @@ POSITIONAL ARGUMENTS FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --stream If a build is ongoing, stream the logs to stdout until the build diff --git a/gcloud/builds/submit b/gcloud/builds/submit index dda137381..318b0ece3 100644 --- a/gcloud/builds/submit +++ b/gcloud/builds/submit @@ -94,8 +94,9 @@ FLAGS --region=REGION The region of the Cloud Build Service to use. Must be set to a - supported region name (e.g. us-central1). If unset, builds/region is - used. If builds/region is unset,region is set to "global". + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to global. --substitutions=[KEY=VALUE,...] Parameters to be substituted in the build specification. @@ -168,9 +169,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - You can also run a build locally using the separate component: gcloud - components install cloud-build-local. - These variants are also available: $ gcloud alpha builds submit diff --git a/gcloud/builds/triggers/create/bitbucketserver b/gcloud/builds/triggers/create/bitbucketserver new file mode 100644 index 000000000..74a25eaa9 --- /dev/null +++ b/gcloud/builds/triggers/create/bitbucketserver @@ -0,0 +1,228 @@ +NAME + gcloud builds triggers create bitbucketserver - create a build trigger for + a Bitbucket Server repository + +SYNOPSIS + gcloud builds triggers create bitbucketserver + (--trigger-config=PATH + | [--bitbucket-server-config-resource=BITBUCKET_SERVER_CONFIG_RESOURCE --project-key=PROJECT_KEY --repo-slug=REPO_SLUG (--branch-pattern=REGEX | --tag-pattern=REGEX | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, + 1)]) (--build-config=PATH | --inline-config=PATH + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger for a Bitbucket Server repository. + +EXAMPLES + To create a push trigger for all branches: + + $ gcloud builds triggers create bitbucketserver \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --project-key="GoogleCloudPlatform" \ + --repo-slug="cloud-builders" \ + --bitbucket-server-config-resource="projects/1234/locations/glob\ + al/bitbucketServerConfigs/5678" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" + + To create a pull request trigger for main: + + $ gcloud builds triggers create bitbucketserver \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --project-key="GoogleCloudPlatform" \ + --repo-slug="cloud-builders" \ + --bitbucket-server-config-resource="projects/1234/locations/glob\ + al/bitbucketServerConfigs/5678" --pull-request-pattern="^main$" \ + --build-config="cloudbuild.yaml" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --bitbucket-server-config-resource=BITBUCKET_SERVER_CONFIG_RESOURCE + Bitbucket Server config resource name. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --project-key=PROJECT_KEY + Bitbucket Server project key. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --repo-slug=REPO_SLUG + Bitbucket Server repository slug. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --branch-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a branch that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --tag-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a tag that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, 1) + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + +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 builds triggers create bitbucketserver + + $ gcloud beta builds triggers create bitbucketserver + diff --git a/gcloud/builds/triggers/create/cloud-source-repositories b/gcloud/builds/triggers/create/cloud-source-repositories new file mode 100644 index 000000000..26da31544 --- /dev/null +++ b/gcloud/builds/triggers/create/cloud-source-repositories @@ -0,0 +1,185 @@ +NAME + gcloud builds triggers create cloud-source-repositories - create a build + trigger from a Cloud Source Repository + +SYNOPSIS + gcloud builds triggers create cloud-source-repositories + (--trigger-config=PATH | [--repo=REPO (--branch-pattern=REGEX + | --tag-pattern=REGEX) (--build-config=PATH | --inline-config=PATH + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger from a Cloud Source Repository. + +EXAMPLES + To create a push trigger for all branches: + + $ gcloud builds triggers create cloud-source-repositories \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" --repo="my-repo" \ + --branch-pattern=".*" --build-config="cloudbuild.yaml" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + Repo resource - Cloud Source Repository. 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 --repo on the command line with a fully + specified name; + ▫ set the property core/project. + + This must be specified. + + --repo=REPO + ID of the repo or fully qualified identifier for the repo. To set + the repo attribute: + ◇ provide the argument --repo on the command line. + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --branch-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a branch that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --tag-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a tag that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + +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 builds triggers create cloud-source-repositories + + $ gcloud beta builds triggers create cloud-source-repositories + diff --git a/gcloud/builds/triggers/create/github b/gcloud/builds/triggers/create/github new file mode 100644 index 000000000..83dbd2aad --- /dev/null +++ b/gcloud/builds/triggers/create/github @@ -0,0 +1,258 @@ +NAME + gcloud builds triggers create github - create a build trigger for a GitHub + repository + +SYNOPSIS + gcloud builds triggers create github + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; default="/" + --dockerfile-image=DOCKERFILE_IMAGE]) (--repository=REPOSITORY + | [--repo-name=REPO_NAME --repo-owner=REPO_OWNER + : --enterprise-config=ENTERPRISE_CONFIG]) : --description=DESCRIPTION + --ignored-files=[GLOB,...] --include-logs-with-status + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger for a GitHub repository. + +EXAMPLES + To create a push trigger with a 1st-gen repository for all branches: + + $ gcloud builds triggers create github --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repo-owner="GoogleCloudPlatform" \ + --repo-name="cloud-builders" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" + + To create a pull request trigger with a 1st-gen repository for master: + + $ gcloud builds triggers create github --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repo-owner="GoogleCloudPlatform" \ + --repo-name="cloud-builders" --pull-request-pattern="^master$" \ + --build-config="cloudbuild.yaml" + + To create a pull request trigger with a 2nd gen repository for master: + + $ gcloud builds triggers create github --name="my-trigger" \ + --repository=projects/my-project/locations/us-central1/\ + connections/my-conn/repositories/my-repo \ + --pull-request-pattern="^master$" \ + --build-config="cloudbuild.yaml" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --include-logs-with-status + Build logs will be sent back to GitHub as part of the checkrun + result. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --branch-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a branch that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --tag-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a tag that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + + Exactly one of these must be specified: + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + 1st-gen repository settings. + + --repo-name=REPO_NAME + Name of the GitHub Repository (1st gen). + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --repo-owner=REPO_OWNER + Owner of the GitHub Repository (1st gen). + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --enterprise-config=ENTERPRISE_CONFIG + Resource name of the GitHub Enterprise config that should be + applied to this installation. + + For example: + "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id} + +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 builds triggers create github + + $ gcloud beta builds triggers create github + diff --git a/gcloud/builds/triggers/create/gitlab-enterprise b/gcloud/builds/triggers/create/gitlab-enterprise new file mode 100644 index 000000000..cd4e9318e --- /dev/null +++ b/gcloud/builds/triggers/create/gitlab-enterprise @@ -0,0 +1,223 @@ +NAME + gcloud builds triggers create gitlab-enterprise - create a build trigger + for a GitLab Enterprise repository + +SYNOPSIS + gcloud builds triggers create gitlab-enterprise + (--trigger-config=PATH + | [--gitlab-config-resource=GITLAB_CONFIG_RESOURCE + --project-namespace=PROJECT_NAMESPACE (--branch-pattern=REGEX + | --tag-pattern=REGEX | [--pull-request-pattern=REGEX + : --comment-control=COMMENT_CONTROL; + default=CommentControlValueValuesEnum(COMMENTS_ENABLED, + 1)]) (--build-config=PATH | --inline-config=PATH + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger for a GitLab Enterprise repository. + +EXAMPLES + To create a push trigger for all branches: + + $ gcloud builds triggers create gitlab-enterprise \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --project-namespace="cloud-builders" \ + --gitlab-config-resource="projects/1234/locations/global/gitLabC\ + onfigs/5678" --branch-pattern=".*" --build-config="cloudbuild.yaml" + + To create a pull request trigger for main: + + $ gcloud builds triggers create gitlab-enterprise \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --project-namespace="cloud-builders" \ + --gitlab-config-resource="projects/1234/locations/global/gitLabC\ + onfigs/5678" --pull-request-pattern="^main$" \ + --build-config="cloudbuild.yaml" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --gitlab-config-resource=GITLAB_CONFIG_RESOURCE + GitLab config resource name. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --project-namespace=PROJECT_NAMESPACE + GitLab project namespace. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --branch-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a branch that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regex search for any incoming pushes. + For example, --tag-pattern=foo will match "foo", "foobar", and + "barfoo". Events on a tag that does not match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default=CommentControlValueValuesEnum(COMMENTS_ENABLED, 1) + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + +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 builds triggers create gitlab-enterprise + + $ gcloud beta builds triggers create gitlab-enterprise + diff --git a/gcloud/builds/triggers/create/help b/gcloud/builds/triggers/create/help new file mode 100644 index 000000000..013658786 --- /dev/null +++ b/gcloud/builds/triggers/create/help @@ -0,0 +1,46 @@ +NAME + gcloud builds triggers create - create build triggers for Google Cloud + Build + +SYNOPSIS + gcloud builds triggers create COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create build triggers for Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + bitbucketserver + Create a build trigger for a Bitbucket Server repository. + + cloud-source-repositories + Create a build trigger from a Cloud Source Repository. + + github + Create a build trigger for a GitHub repository. + + gitlab-enterprise + Create a build trigger for a GitLab Enterprise repository. + + manual + Create a build trigger with a manual trigger event. + + pubsub + Create a build trigger with a Pub/Sub trigger event. + + webhook + Create a build trigger with a Webhook trigger event. + +NOTES + These variants are also available: + + $ gcloud alpha builds triggers create + + $ gcloud beta builds triggers create + diff --git a/gcloud/builds/triggers/create/manual b/gcloud/builds/triggers/create/manual new file mode 100644 index 000000000..fe6eb6e2b --- /dev/null +++ b/gcloud/builds/triggers/create/manual @@ -0,0 +1,169 @@ +NAME + gcloud builds triggers create manual - create a build trigger with a manual + trigger event + +SYNOPSIS + gcloud builds triggers create manual + (--trigger-config=PATH | [(--build-config=PATH | --inline-config=PATH + | [--dockerfile=DOCKERFILE : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT + --substitutions=[KEY=VALUE,...] + --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger with a manual trigger event. + +EXAMPLES + To create a manual trigger that builds off branch my-branch in a GitHub + repository named my-repo: + + $ gcloud builds triggers create manual --name=my-manual-trigger \ + --build-config=cloudbuild.yaml \ + --repo=https://www.github.com/owner/repo --repo-type=GITHUB \ + --branch=my-branch + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + + Flags for repository information + + --repo=REPO + URI of the repository. Currently only HTTP URIs for GitHub and + Cloud Source Repositories are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --repo-type=REPO_TYPE + Type of the repository. Currently only GitHub and Cloud Source + Repository types are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + Exactly one of these must be specified: + + --branch=BRANCH + Branch to build. + + --tag=TAG + Tag to build. + +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 builds triggers create manual + + $ gcloud beta builds triggers create manual + diff --git a/gcloud/builds/triggers/create/pubsub b/gcloud/builds/triggers/create/pubsub new file mode 100644 index 000000000..7a0d6a6b3 --- /dev/null +++ b/gcloud/builds/triggers/create/pubsub @@ -0,0 +1,184 @@ +NAME + gcloud builds triggers create pubsub - create a build trigger with a + Pub/Sub trigger event + +SYNOPSIS + gcloud builds triggers create pubsub + (--trigger-config=PATH | [--topic=TOPIC (--build-config=PATH + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT + --subscription-filter=SUBSCRIPTION_FILTER + --substitutions=[KEY=VALUE,...] + --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger with a Pub/Sub trigger event. + +EXAMPLES + To create a Pub/Sub trigger that listens to topic my-topic and builds off + branch my-branch in a GitHub repository named my-repo: + + $ gcloud builds triggers create pubsub --name=my-pubsub-trigger \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --topic=projects/my-project/topics/my-topic \ + --repo=https://www.github.com/owner/repo --repo-type=GITHUB \ + --branch=my-branch + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --topic=TOPIC + The topic to which this trigger should subscribe. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --description=DESCRIPTION + Build trigger description. + + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --subscription-filter=SUBSCRIPTION_FILTER + CEL filter expression for the trigger. See + https://cloud.google.com/build/docs/filter-build-events-using-cel + for more details. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + + Flags for repository information + + --repo=REPO + URI of the repository. Currently only HTTP URIs for GitHub and + Cloud Source Repositories are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --repo-type=REPO_TYPE + Type of the repository. Currently only GitHub and Cloud Source + Repository types are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + Exactly one of these must be specified: + + --branch=BRANCH + Branch to build. + + --tag=TAG + Tag to build. + +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 builds triggers create pubsub + + $ gcloud beta builds triggers create pubsub + diff --git a/gcloud/builds/triggers/create/webhook b/gcloud/builds/triggers/create/webhook new file mode 100644 index 000000000..f92e1605b --- /dev/null +++ b/gcloud/builds/triggers/create/webhook @@ -0,0 +1,187 @@ +NAME + gcloud builds triggers create webhook - create a build trigger with a + Webhook trigger event + +SYNOPSIS + gcloud builds triggers create webhook + (--trigger-config=PATH | [--secret=SECRET (--build-config=PATH + | --inline-config=PATH | [--dockerfile=DOCKERFILE + : --dockerfile-dir=DOCKERFILE_DIR; + default="/" --dockerfile-image=DOCKERFILE_IMAGE]) + : --description=DESCRIPTION + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG --name=NAME + --region=REGION --require-approval --service-account=SERVICE_ACCOUNT + --subscription-filter=SUBSCRIPTION_FILTER + --substitutions=[KEY=VALUE,...] + --repo=REPO --repo-type=REPO_TYPE (--branch=BRANCH | --tag=TAG)]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger with a Webhook trigger event. + +EXAMPLES + To create a Webhook trigger that requires secret + projects/my-project/secrets/my-secret/versions/2 and builds off branch + my-branch in a GitHub repository named my-repo: + + $ gcloud builds triggers create webhook --name=my-webhook-trigger \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --secret=projects/my-project/secrets/my-secret/versions/2 \ + --repo=https://www.github.com/owner/repo --repo-type=GITHUB \ + --branch=my-branch + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --secret=SECRET + The full path of the secret version required to validate webhook + requests against this trigger. For example, + projects/my-project/secrets/my-secret/versions/1. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --description=DESCRIPTION + Build trigger description. + + --github-enterprise-config=GITHUB_ENTERPRISE_CONFIG + The resource name of the GitHub Enterprise config that should be + applied to this source. Format: + projects/{project}/locations/{location}/githubEnterpriseConfigs/{id} + or projects/{project}/githubEnterpriseConfigs/{id} + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. + + --require-approval + Require manual approval for triggered builds. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --subscription-filter=SUBSCRIPTION_FILTER + CEL filter expression for the trigger. See + https://cloud.google.com/build/docs/filter-build-events-using-cel + for more details. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers create ... --config config.yaml + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/cloud-build/docs/api/build-requests#substitutions + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + If not specified, + gcr.io/PROJECT/github.com/REPO_OWNER/REPO_NAME:$COMMIT_SHA will + be used. + + Use a build configuration (cloudbuild.yaml) file for building + multiple images in a single trigger. + + Flags for repository information + + --repo=REPO + URI of the repository. Currently only HTTP URIs for GitHub and + Cloud Source Repositories are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --repo-type=REPO_TYPE + Type of the repository. Currently only GitHub and Cloud Source + Repository types are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + Exactly one of these must be specified: + + --branch=BRANCH + Branch to build. + + --tag=TAG + Tag to build. + +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 builds triggers create webhook + + $ gcloud beta builds triggers create webhook + diff --git a/gcloud/builds/triggers/delete b/gcloud/builds/triggers/delete new file mode 100644 index 000000000..cd0cf4471 --- /dev/null +++ b/gcloud/builds/triggers/delete @@ -0,0 +1,57 @@ +NAME + gcloud builds triggers delete - delete a build trigger + +SYNOPSIS + gcloud builds triggers delete (TRIGGER : --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a build trigger. + +EXAMPLES + To delete a build trigger, run: + + $ gcloud builds triggers delete MY-TRIGGER + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. 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 TRIGGER 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. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. To + set the trigger attribute: + ▸ provide the argument TRIGGER 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 location for the trigger. To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/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 builds triggers delete + + $ gcloud beta builds triggers delete + diff --git a/gcloud/builds/triggers/describe b/gcloud/builds/triggers/describe new file mode 100644 index 000000000..9d8e385ba --- /dev/null +++ b/gcloud/builds/triggers/describe @@ -0,0 +1,58 @@ +NAME + gcloud builds triggers describe - get information about a particular + trigger + +SYNOPSIS + gcloud builds triggers describe (TRIGGER : --region=REGION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get information about the specified build trigger. + +EXAMPLES + To describe a build trigger, run: + + $ gcloud builds triggers describe MY-TRIGGER + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. 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 TRIGGER 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. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. To + set the trigger attribute: + ▸ provide the argument TRIGGER 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 location for the trigger. To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/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 builds triggers describe + + $ gcloud beta builds triggers describe + diff --git a/gcloud/builds/triggers/help b/gcloud/builds/triggers/help new file mode 100644 index 000000000..820ce1416 --- /dev/null +++ b/gcloud/builds/triggers/help @@ -0,0 +1,46 @@ +NAME + gcloud builds triggers - create and manage build triggers for Google Cloud + Build + +SYNOPSIS + gcloud builds triggers GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create and manage build triggers for Google Cloud Build. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + create + Create build triggers for Google Cloud Build. + +COMMANDS + COMMAND is one of the following: + + delete + Delete a build trigger. + + describe + Get information about a particular trigger. + + import + Import a build trigger. + + list + List Google Cloud Build triggers for a project. + + run + Run a build trigger. + +NOTES + These variants are also available: + + $ gcloud alpha builds triggers + + $ gcloud beta builds triggers + diff --git a/gcloud/builds/triggers/import b/gcloud/builds/triggers/import new file mode 100644 index 000000000..9806ab4cc --- /dev/null +++ b/gcloud/builds/triggers/import @@ -0,0 +1,43 @@ +NAME + gcloud builds triggers import - import a build trigger + +SYNOPSIS + gcloud builds triggers import --source=PATH [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + To import a trigger from a file: $ cat > trigger.yaml </ --all. POSITIONAL ARGUMENTS [SECTION/PROPERTY] @@ -86,6 +93,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -114,6 +133,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -124,6 +154,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -179,97 +214,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -278,69 +340,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -348,110 +432,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -459,29 +584,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -900,6 +1031,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -941,6 +1078,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1036,6 +1184,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1161,6 +1314,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/config/set b/gcloud/config/set index e460773b3..48387217d 100644 --- a/gcloud/config/set +++ b/gcloud/config/set @@ -96,6 +96,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -124,6 +136,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -134,6 +157,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -189,97 +217,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -288,69 +343,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -358,110 +435,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -469,29 +587,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -910,6 +1034,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -951,6 +1081,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1046,6 +1187,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1171,6 +1317,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/config/unset b/gcloud/config/unset index c60511686..47c4aedbb 100644 --- a/gcloud/config/unset +++ b/gcloud/config/unset @@ -57,6 +57,18 @@ AVAILABLE PROPERTIES custom_ca_certs_file Absolute path to a custom CA cert file. + default_format + Sets the default format for printing command resources. + core/default_format overrides the default yaml format. If the + command contains a command-specific output format, it takes + precedence over the core/default_format value. Use + --verbosity=debug flag to view the command-specific format. Both + core/format and --format also take precedence over + core/default_format. The supported formats are limited to: config, + default, disable, flattened, json, list, none, object, text. For + more details run $ gcloud topic formats. Run $ gcloud config set + --help to see more information about core/default_format + default_regional_backend_service If True, backend services in gcloud compute backend-services will be regional by default. Setting the --global flag is required for @@ -85,6 +97,17 @@ AVAILABLE PROPERTIES enable_feature_flags If True, remote config-file driven feature flags will be enabled. + format + Sets the format for printing all command resources. This overrides + the default command-specific human-friendly output format. Use + --verbosity=debug flag to view the command-specific format. If both + core/default_format and core/format are specified, core/format + takes precedence. If both core/format and --format are specified, + --format takes precedence. The supported formats are limited to: + config, default, disable, flattened, json, list, none, object, + text. For more details run $ gcloud topic formats. Run $ gcloud + config set --help to see more information about core/format + log_http If True, log HTTP requests and responses to the logs. To see logs in the terminal, adjust verbosity settings. Otherwise, logs are @@ -95,6 +118,11 @@ AVAILABLE PROPERTIES to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days. + parse_error_details + If True, gcloud will attempt to parse and interpret error details + in API originating errors. If False, gcloud will write flush error + details as is to stderr/log. + pass_credentials_to_gsutil If True, pass the configured Google Cloud CLI authentication to gsutil. @@ -150,97 +178,124 @@ AVAILABLE PROPERTIES api_endpoint_overrides accessapproval Overrides API endpoint for gcloud access-approval command group. + Defaults to https://accessapproval.googleapis.com/ accesscontextmanager Overrides API endpoint for gcloud access-context-manager command - group. + group. Defaults to https://accesscontextmanager.googleapis.com/ ai Overrides API endpoint for gcloud ai command group. aiplatform Overrides API endpoint for gcloud ai-platform command group. + Defaults to https://aiplatform.googleapis.com/ anthosevents - Overrides API endpoint for gcloud anthos command group. + Overrides API endpoint for gcloud anthos command group. Defaults to + https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa Overrides API endpoint for gcloud container fleet policycontroller - command group. + command group. Defaults to + https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway Overrides API endpoint for gcloud api-gateway command group. + Defaults to https://apigateway.googleapis.com/ apigee - Overrides API endpoint for gcloud apigee command group. + Overrides API endpoint for gcloud apigee command group. Defaults to + https://apigee.googleapis.com/ appengine - Overrides API endpoint for gcloud app command group. + Overrides API endpoint for gcloud app command group. Defaults to + https://appengine.googleapis.com/ artifactregistry - Overrides API endpoint for gcloud artifacts command group. + Overrides API endpoint for gcloud artifacts command group. Defaults + to https://artifactregistry.googleapis.com/ assuredworkloads - Overrides API endpoint for gcloud assured command group. + Overrides API endpoint for gcloud assured command group. Defaults + to https://assuredworkloads.googleapis.com/ baremetalsolution - Overrides API endpoint for gcloud bms command group. + Overrides API endpoint for gcloud bms command group. Defaults to + https://baremetalsolution.googleapis.com/ bigtableadmin - Overrides API endpoint for gcloud bigtable command group. + Overrides API endpoint for gcloud bigtable command group. Defaults + to https://bigtableadmin.googleapis.com/ certificatemanager Overrides API endpoint for gcloud certificate-manager command - group. + group. Defaults to https://certificatemanager.googleapis.com/ cloudasset - Overrides API endpoint for gcloud asset command group. + Overrides API endpoint for gcloud asset command group. Defaults to + https://cloudasset.googleapis.com/ cloudbilling - Overrides API endpoint for gcloud billing command group. + Overrides API endpoint for gcloud billing command group. Defaults + to https://cloudbilling.googleapis.com/ cloudbuild - Overrides API endpoint for gcloud builds command group. + Overrides API endpoint for gcloud builds command group. Defaults to + https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement Overrides API endpoint for gcloud commerce-procurement command - group. + group. Defaults to + https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger - Overrides API endpoint for gcloud debug command group. + Overrides API endpoint for gcloud debug command group. Defaults to + https://clouddebugger.googleapis.com/ clouddeploy - Overrides API endpoint for gcloud deploy command group. + Overrides API endpoint for gcloud deploy command group. Defaults to + https://clouddeploy.googleapis.com/ clouderrorreporting Overrides API endpoint for gcloud error-reporting command group. + Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions - Overrides API endpoint for gcloud functions command group. + Overrides API endpoint for gcloud functions command group. Defaults + to https://cloudfunctions.googleapis.com/ cloudidentity - Overrides API endpoint for gcloud identity command group. + Overrides API endpoint for gcloud identity command group. Defaults + to https://cloudidentity.googleapis.com/ cloudiot - Overrides API endpoint for gcloud iot command group. + Overrides API endpoint for gcloud iot command group. Defaults to + https://cloudiot.googleapis.com/ cloudkms - Overrides API endpoint for gcloud kms command group. + Overrides API endpoint for gcloud kms command group. Defaults to + https://cloudkms.googleapis.com/ cloudresourcemanager - Overrides API endpoint for gcloud projects command group. + Overrides API endpoint for gcloud projects command group. Defaults + to https://cloudresourcemanager.googleapis.com/ cloudscheduler - Overrides API endpoint for gcloud scheduler command group. + Overrides API endpoint for gcloud scheduler command group. Defaults + to https://cloudscheduler.googleapis.com/ cloudtasks - Overrides API endpoint for gcloud tasks command group. + Overrides API endpoint for gcloud tasks command group. Defaults to + https://cloudtasks.googleapis.com/ cloudtrace - Overrides API endpoint for gcloud trace command group. + Overrides API endpoint for gcloud trace command group. Defaults to + https://cloudtrace.googleapis.com/ composer - Overrides API endpoint for gcloud composer command group. + Overrides API endpoint for gcloud composer command group. Defaults + to https://composer.googleapis.com/ compute Overrides API endpoint for gcloud compute command group. For @@ -249,69 +304,91 @@ AVAILABLE PROPERTIES config Overrides API endpoint for gcloud blueprints command group. + Defaults to https://config.googleapis.com/ container - Overrides API endpoint for gcloud container command group. + Overrides API endpoint for gcloud container command group. Defaults + to https://container.googleapis.com/ datacatalog Overrides API endpoint for gcloud data-catalog command group. + Defaults to https://datacatalog.googleapis.com/ dataflow - Overrides API endpoint for gcloud dataflow command group. + Overrides API endpoint for gcloud dataflow command group. Defaults + to https://dataflow.googleapis.com/ datafusion Overrides API endpoint for gcloud data-fusion command group. + Defaults to https://datafusion.googleapis.com/ datamigration Overrides API endpoint for gcloud database-migration command group. + Defaults to https://datamigration.googleapis.com/ datapipelines Overrides API endpoint for gcloud datapipelines command group. + Defaults to https://datapipelines.googleapis.com/ dataplex - Overrides API endpoint for gcloud dataplex command group. + Overrides API endpoint for gcloud dataplex command group. Defaults + to https://dataplex.googleapis.com/ dataproc - Overrides API endpoint for gcloud dataproc command group. + Overrides API endpoint for gcloud dataproc command group. Defaults + to https://dataproc.googleapis.com/ datastore - Overrides API endpoint for gcloud datastore command group. + Overrides API endpoint for gcloud datastore command group. Defaults + to https://datastore.googleapis.com/ datastream Overrides API endpoint for gcloud datastream command group. + Defaults to https://datastream.googleapis.com/ deploymentmanager Overrides API endpoint for gcloud deployment-manager command group. + Defaults to https://deploymentmanager.googleapis.com/ dns - Overrides API endpoint for gcloud dns command group. + Overrides API endpoint for gcloud dns command group. Defaults to + https://dns.googleapis.com/dns/v1/ domains - Overrides API endpoint for gcloud domains command group. + Overrides API endpoint for gcloud domains command group. Defaults + to https://domains.googleapis.com/ edgecontainer Overrides API endpoint for gcloud edge-container command group. + Defaults to https://edgecontainer.googleapis.com/ eventarc - Overrides API endpoint for gcloud eventarc command group. + Overrides API endpoint for gcloud eventarc command group. Defaults + to https://eventarc.googleapis.com/ eventarcpublishing Overrides API endpoint for gcloud eventarc publish command group. + Defaults to https://eventarcpublishing.googleapis.com/ events - Overrides API endpoint for gcloud events command group. + Overrides API endpoint for gcloud events command group. Defaults to + https://events.googleapis.com/ file - Overrides API endpoint for gcloud filestore command group. + Overrides API endpoint for gcloud filestore command group. Defaults + to https://file.googleapis.com/ firestore - Overrides API endpoint for gcloud firestore command group. + Overrides API endpoint for gcloud firestore command group. Defaults + to https://firestore.googleapis.com/ gameservices - Overrides API endpoint for gcloud gamer command group. + Overrides API endpoint for gcloud gamer command group. Defaults to + https://gameservices.googleapis.com/ genomics - Overrides API endpoint for gcloud genomics command group. + Overrides API endpoint for gcloud genomics command group. Defaults + to https://genomics.googleapis.com/ gkemulticloud Overrides API endpoint for gcloud container aws, gcloud container @@ -319,110 +396,151 @@ AVAILABLE PROPERTIES healthcare Overrides API endpoint for gcloud healthcare command group. + Defaults to https://healthcare.googleapis.com/ iam - Overrides API endpoint for gcloud iam command group. + Overrides API endpoint for gcloud iam command group. Defaults to + https://iam.googleapis.com/ iap - Overrides API endpoint for gcloud iap command group. + Overrides API endpoint for gcloud iap command group. Defaults to + https://iap.googleapis.com/ ids - Overrides API endpoint for gcloud ids command group. + Overrides API endpoint for gcloud ids command group. Defaults to + https://ids.googleapis.com/ krmapihosting Overrides API endpoint for gcloud anthos config controller command - group. + group. Defaults to https://krmapihosting.googleapis.com/ language Overrides API endpoint for gcloud ml language command group. + Defaults to https://language.googleapis.com/ lifesciences Overrides API endpoint for gcloud lifesciences command group. + Defaults to https://lifesciences.googleapis.com/ logging - Overrides API endpoint for gcloud logging command group. + Overrides API endpoint for gcloud logging command group. Defaults + to https://logging.googleapis.com/ + + looker + Overrides API endpoint for gcloud looker command group. Defaults to + https://looker.googleapis.com/ managedidentities Overrides API endpoint for gcloud active-directory command group. + Defaults to https://managedidentities.googleapis.com/ mediaasset - Overrides API endpoint for gcloud media command group. + Overrides API endpoint for gcloud media command group. Defaults to + https://mediaasset.googleapis.com/ memcache - Overrides API endpoint for gcloud memcache command group. + Overrides API endpoint for gcloud memcache command group. Defaults + to https://memcache.googleapis.com/ metastore - Overrides API endpoint for gcloud metastore command group. + Overrides API endpoint for gcloud metastore command group. Defaults + to https://metastore.googleapis.com/ monitoring Overrides API endpoint for gcloud monitoring command group. + Defaults to https://monitoring.googleapis.com/ + + netapp + Overrides API endpoint for gcloud netapp command group. Defaults to + https://netapp.googleapis.com/ networkconnectivity Overrides API endpoint for gcloud network-connectivity command - group. + group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement Overrides API endpoint for gcloud network-management command group. + Defaults to https://networkmanagement.googleapis.com/ networksecurity Overrides API endpoint for gcloud network-security command group. + Defaults to https://networksecurity.googleapis.com/ networkservices Overrides API endpoint for gcloud network-services command group. + Defaults to https://networkservices.googleapis.com/ notebooks - Overrides API endpoint for gcloud notebooks command group. + Overrides API endpoint for gcloud notebooks command group. Defaults + to https://notebooks.googleapis.com/ orgpolicy Overrides API endpoint for gcloud org-policies command group. + Defaults to https://orgpolicy.googleapis.com/ policyanalyzer Overrides API endpoint for policy-intelligence command group. + Defaults to https://policyanalyzer.googleapis.com/ privateca - Overrides API endpoint for gcloud privateca command group. + Overrides API endpoint for gcloud privateca command group. Defaults + to https://privateca.googleapis.com/ publicca - Overrides API endpoint for gcloud publicca command group. + Overrides API endpoint for gcloud publicca command group. Defaults + to https://publicca.googleapis.com/ pubsub - Overrides API endpoint for gcloud pubsub command group. + Overrides API endpoint for gcloud pubsub command group. Defaults to + https://pubsub.googleapis.com/ recaptchaenterprise - Overrides API endpoint for gcloud recaptcha command group. + Overrides API endpoint for gcloud recaptcha command group. Defaults + to https://recaptchaenterprise.googleapis.com/ recommender Overrides API endpoint for gcloud recommender command group. + Defaults to https://recommender.googleapis.com/ redis - Overrides API endpoint for gcloud redis command group. + Overrides API endpoint for gcloud redis command group. Defaults to + https://redis.googleapis.com/ resourcesettings Overrides API endpoint for gcloud resource-settings command group. + Defaults to https://resourcesettings.googleapis.com/ run - Overrides API endpoint for gcloud run command group. + Overrides API endpoint for gcloud run command group. Defaults to + https://run.googleapis.com/ runtimeconfig Overrides API endpoint for gcloud runtime-config command group. + Defaults to https://runtimeconfig.googleapis.com/ sddc Overrides API endpoint for gcloud vmware sddc command group. + Defaults to https://sddc.googleapis.com/ secretmanager - Overrides API endpoint for gcloud secrets command group. + Overrides API endpoint for gcloud secrets command group. Defaults + to https://secretmanager.googleapis.com/ securitycenter - Overrides API endpoint for gcloud scc command group. + Overrides API endpoint for gcloud scc command group. Defaults to + https://securitycenter.googleapis.com/ servicedirectory Overrides API endpoint for gcloud service-directory command group. + Defaults to https://servicedirectory.googleapis.com/ servicemanagement - Overrides API endpoint for gcloud endpoints command group. + Overrides API endpoint for gcloud endpoints command group. Defaults + to https://servicemanagement.googleapis.com/ sourcerepo - Overrides API endpoint for gcloud source command group. + Overrides API endpoint for gcloud source command group. Defaults to + https://sourcerepo.googleapis.com/ spanner Overrides API endpoint for gcloud spanner command group. For @@ -430,29 +548,35 @@ AVAILABLE PROPERTIES https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech - Overrides API endpoint for gcloud ml speech command group. + Overrides API endpoint for gcloud ml speech command group. Defaults + to https://speech.googleapis.com/ sql Overrides API endpoint for gcloud sql command group. storage - Overrides API endpoint for gcloud storage command group. + Overrides API endpoint for gcloud storage command group. Defaults + to https://storage.googleapis.com/storage/v1/ testing Overrides API endpoint for gcloud firebase test command group. + Defaults to https://testing.googleapis.com/ vision - Overrides API endpoint for gcloud ml vision command group. + Overrides API endpoint for gcloud ml vision command group. Defaults + to https://vision.googleapis.com/ vmwareengine - Overrides API endpoint for gcloud vmware command group. + Overrides API endpoint for gcloud vmware command group. Defaults to + https://vmwareengine.googleapis.com/ workflowexecutions Overrides API endpoint for gcloud workflows executions command - group. + group. Defaults to https://workflowexecutions.googleapis.com/ workflows - Overrides API endpoint for gcloud workflows command group. + Overrides API endpoint for gcloud workflows command group. Defaults + to https://workflows.googleapis.com/ app cloud_build_timeout @@ -871,6 +995,12 @@ AVAILABLE PROPERTIES resources. When a --location flag is required but not provided, the command will fall back to this value. + looker + region + Default region to use when working with Cloud Looker resources. + When a region is required but not provided by a flag, the command + will fall back to this value, if set. + media_asset location Default location to use when working with Cloud Media Asset @@ -912,6 +1042,17 @@ AVAILABLE PROPERTIES Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota. + netapp + location + Default location to use when working with Cloud NetApp Files + resources. When a location value is required but not provided, the + command will fall back to this value, if set. + + region + Default region to use when working with Cloud NetApp Files regions. + When a --region flag is required but not provided, the command will + fall back to this value, if set. + notebooks location Default location to use when working with Notebook resources. When @@ -1007,6 +1148,11 @@ AVAILABLE PROPERTIES internal IP as an instance in the current subnet. Defaults to True. storage + additional_headers + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. + header1=value1,header2=value2. + base_retry_delay Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier. @@ -1132,6 +1278,10 @@ AVAILABLE PROPERTIES Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold. + suggest_transfer + If True, logs messages about when Storage Transfer Service might be + a better tool than gcloud storage. + thread_count The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use diff --git a/gcloud/container/attached/clusters/delete b/gcloud/container/attached/clusters/delete new file mode 100644 index 000000000..c9f6e4f6c --- /dev/null +++ b/gcloud/container/attached/clusters/delete @@ -0,0 +1,76 @@ +NAME + gcloud container attached clusters delete - delete a registered + AttachedCluster resource + +SYNOPSIS + gcloud container attached clusters delete (CLUSTER : --location=LOCATION) + [--allow-missing] [--async] [--ignore-errors] [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a registered AttachedCluster resource. + +EXAMPLES + To delete an AttachedCluster resource named my-cluster managed in location + us-west1, run: + + $ gcloud container attached clusters delete my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --ignore-errors + Force delete an Attached cluster. Deletion of Attached cluster will + succeed even if errors occur during deleting in-cluster resources. + Using this parameter may result in orphaned resources in the cluster. + + --validate-only + Validate the cluster to delete, but don't actually perform it. + +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 variant is also available: + + $ gcloud alpha container attached clusters delete + diff --git a/gcloud/container/attached/clusters/describe b/gcloud/container/attached/clusters/describe new file mode 100644 index 000000000..8bb08b525 --- /dev/null +++ b/gcloud/container/attached/clusters/describe @@ -0,0 +1,56 @@ +NAME + gcloud container attached clusters describe - describe an Attached cluster + +SYNOPSIS + gcloud container attached clusters describe (CLUSTER : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe an Attached cluster. + +EXAMPLES + To describe a cluster named my-cluster managed in location us-west1, run: + + $ gcloud container attached clusters describe my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 variant is also available: + + $ gcloud alpha container attached clusters describe + diff --git a/gcloud/container/attached/clusters/generate-install-manifest b/gcloud/container/attached/clusters/generate-install-manifest new file mode 100644 index 000000000..c1cdef351 --- /dev/null +++ b/gcloud/container/attached/clusters/generate-install-manifest @@ -0,0 +1,81 @@ +NAME + gcloud container attached clusters generate-install-manifest - generate + Install Manifest for an Attached cluster + +SYNOPSIS + gcloud container attached clusters generate-install-manifest + (CLUSTER : --location=LOCATION) --platform-version=PLATFORM_VERSION + [--output-file=OUTPUT_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Generate Install Manifest for an Attached cluster. + +EXAMPLES + To generate install manifest for cluster named my-cluster managed in + location us-west1, run: + + $ gcloud container attached clusters generate-install-manifest \ + my-cluster --location=us-west1 \ + --platform-version=PLATFORM_VERSION + + To store the manifest in a file named manifest.yaml, run: + + $ gcloud container attached clusters generate-install-manifest \ + my-cluster --location=us-west1 \ + --platform-version=PLATFORM_VERSION --output-file=manifest.yaml + +POSITIONAL ARGUMENTS + Cluster resource - cluster to generate install manifest. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +REQUIRED FLAGS + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + +OPTIONAL FLAGS + --output-file=OUTPUT_FILE + Path to the output file to store manifest. + +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 variant is also available: + + $ gcloud alpha container attached clusters generate-install-manifest + diff --git a/gcloud/container/attached/clusters/get-credentials b/gcloud/container/attached/clusters/get-credentials new file mode 100644 index 000000000..cdce1b4f0 --- /dev/null +++ b/gcloud/container/attached/clusters/get-credentials @@ -0,0 +1,82 @@ +NAME + gcloud container attached clusters get-credentials - get credentials of an + Attached cluster + +SYNOPSIS + gcloud container attached clusters get-credentials + (CLUSTER : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Fetch credentials for a running Attached cluster. + + This command updates a kubeconfig file with appropriate credentials and + endpoint information to point kubectl at a specific Attached cluster. + + By default, credentials are written to HOME/.kube/config. You can provide + an alternate path by setting the KUBECONFIG environment variable. If + KUBECONFIG contains multiple paths, the first one is used. + + This command enables switching to a specific cluster, when working with + multiple clusters. It can also be used to access a previously created + cluster from a new workstation. + + By default, the command will configure kubectl to automatically refresh its + credentials using the same identity as the gcloud command-line tool. If you + are running kubectl as part of an application, it is recommended to use + application default credentials + (https://cloud.google.com/docs/authentication/production). To configure a + kubeconfig file to use application default credentials, set the + container/use_application_default_credentials Google Cloud CLI property + (https://cloud.google.com/sdk/docs/properties) to true before running the + command. + + See https://cloud.google.com/kubernetes-engine/docs/kubectl for kubectl + documentation. + +EXAMPLES + To get credentials of a cluster named my-cluster managed in location + us-west1, run: + + $ gcloud container attached clusters get-credentials my-cluster \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to get credentials. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 variant is also available: + + $ gcloud alpha container attached clusters get-credentials + diff --git a/gcloud/container/attached/clusters/help b/gcloud/container/attached/clusters/help new file mode 100644 index 000000000..2ff1cc7d7 --- /dev/null +++ b/gcloud/container/attached/clusters/help @@ -0,0 +1,46 @@ +NAME + gcloud container attached clusters - create and manage Attached clusters + +SYNOPSIS + gcloud container attached clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create and manage Attached clusters. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + delete + Delete a registered AttachedCluster resource. + + describe + Describe an Attached cluster. + + generate-install-manifest + Generate Install Manifest for an Attached cluster. + + get-credentials + Get credentials of an Attached cluster. + + import + Import fleet membership for an Attached cluster. + + list + List Attached clusters. + + register + Register an Attached cluster. + + update + Update an Attached cluster. + +NOTES + This variant is also available: + + $ gcloud alpha container attached clusters + diff --git a/gcloud/container/attached/clusters/import b/gcloud/container/attached/clusters/import new file mode 100644 index 000000000..064dd1ba8 --- /dev/null +++ b/gcloud/container/attached/clusters/import @@ -0,0 +1,127 @@ +NAME + gcloud container attached clusters import - import fleet membership for an + Attached cluster + +SYNOPSIS + gcloud container attached clusters import --distribution=DISTRIBUTION + --platform-version=PLATFORM_VERSION + (--context=CONTEXT : --kubeconfig=KUBECONFIG) + (--fleet-membership=FLEET_MEMBERSHIP + : --fleet-membership-location=FLEET_MEMBERSHIP_LOCATION; + default="global") [--async] [--location=LOCATION] [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import fleet membership for an Attached cluster. + +EXAMPLES + To import the fleet membership of an attached cluster in fleet + FLEET_MEMBERSHIP managed in location us-west1, run: + + $ gcloud container attached clusters import --location=us-west1 \ + --platform-version=PLATFORM_VERSION \ + --fleet-membership=FLEET_MEMBERSHIP \ + --distribution=DISTRIBUTION --context=CLUSTER_CONTEXT \ + --kubeconfig=KUBECONFIG_PATH + +REQUIRED FLAGS + --distribution=DISTRIBUTION + Set the base platform type of the cluster to attach. + + Examples: + + $ gcloud container attached clusters import --distribution=aks + $ gcloud container attached clusters import --distribution=eks + + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + + kubectl config + + This must be specified. + + --context=CONTEXT + Context to use in the kubeconfig. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kubeconfig=KUBECONFIG + Path to the kubeconfig file. + + If not provided, the default at ~/.kube/config will be used. + + Fleet membership resource - Membership of the registered cluster. + Membership can be the membership ID or the full resource name. 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 --fleet-membership 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. + + --fleet-membership=FLEET_MEMBERSHIP + ID of the fleet_membership or fully qualified identifier for the + fleet_membership. To set the fleet_membership attribute: + ▸ provide the argument --fleet-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --fleet-membership-location=FLEET_MEMBERSHIP_LOCATION; default="global" + Google Cloud location for the fleet_membership. To set the location + attribute: + ▸ provide the argument --fleet-membership on the command line with + a fully specified name; + ▸ provide the argument --fleet-membership-location on the command + line; + ▸ set the property container_attached/location. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + Location resource - Google Cloud location to import attached cluster.. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + + --validate-only + Validate the cluster to import, but don't actually perform it. + +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 variant is also available: + + $ gcloud alpha container attached clusters import + diff --git a/gcloud/container/attached/clusters/list b/gcloud/container/attached/clusters/list new file mode 100644 index 000000000..7ff499e3d --- /dev/null +++ b/gcloud/container/attached/clusters/list @@ -0,0 +1,78 @@ +NAME + gcloud container attached clusters list - list Attached clusters + +SYNOPSIS + gcloud container attached clusters list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Attached clusters. + +EXAMPLES + To lists all clusters managed in location us-west1, run: + + $ gcloud container attached clusters list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list. 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 + This variant is also available: + + $ gcloud alpha container attached clusters list + diff --git a/gcloud/container/attached/clusters/register b/gcloud/container/attached/clusters/register new file mode 100644 index 000000000..7c47008c0 --- /dev/null +++ b/gcloud/container/attached/clusters/register @@ -0,0 +1,171 @@ +NAME + gcloud container attached clusters register - register an Attached cluster + +SYNOPSIS + gcloud container attached clusters register (CLUSTER : --location=LOCATION) + --distribution=DISTRIBUTION --fleet-project=FLEET_PROJECT + --platform-version=PLATFORM_VERSION + (--context=CONTEXT : --kubeconfig=KUBECONFIG) + (--has-private-issuer | --issuer-url=ISSUER_URL) + [--admin-users=[USER,...]] [--annotations=ANNOTATION,[ANNOTATION,...]] + [--description=DESCRIPTION] [--enable-managed-prometheus] + [--logging=COMPONENT,[COMPONENT,...]] [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Register an Attached cluster. + +EXAMPLES + Register a cluster to a fleet. + + To register a cluster with a private OIDC issuer, run: + + $ gcloud container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --has-private-issuer + + To register a cluster with a public OIDC issuer, run: + + $ gcloud container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --issuer-url=https://ISSUER_URL + + To specify a kubeconfig file, run: + + $ gcloud container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --has-private-issuer \ + --kubeconfig=KUBECONFIG_PATH + + To register and set cluster admin users, run: + + $ gcloud container attached clusters register my-cluster \ + --location=us-west1 --platform-version=PLATFORM_VERSION \ + --fleet-project=FLEET_PROJECT_NUM --distribution=DISTRIBUTION \ + --context=CLUSTER_CONTEXT --issuer-url=https://ISSUER_URL \ + --admin-users=USER1,USER2 + +POSITIONAL ARGUMENTS + Cluster resource - cluster to register. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +REQUIRED FLAGS + --distribution=DISTRIBUTION + Set the base platform type of the cluster to attach. + + Examples: + + $ gcloud container attached clusters register --distribution=aks + $ gcloud container attached clusters register --distribution=eks + + --fleet-project=FLEET_PROJECT + ID or number of the Fleet host project where the cluster is registered. + + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + + kubectl config + + This must be specified. + + --context=CONTEXT + Context to use in the kubeconfig. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --kubeconfig=KUBECONFIG + Path to the kubeconfig file. + + If not provided, the default at ~/.kube/config will be used. + + OIDC config + + Exactly one of these must be specified: + + --has-private-issuer + Indicates no publicly routable OIDC discovery endpoint exists for the + Kubernetes service account token issuer. + + If this flag is set, gcloud will read the issuer URL and JWKs from + the cluster's api server. + + --issuer-url=ISSUER_URL + Issuer url of the cluster to attach. + +OPTIONAL FLAGS + --admin-users=[USER,...] + Users that can perform operations as a cluster administrator. + + There is no way to completely remove admin users after setting. + + --annotations=ANNOTATION,[ANNOTATION,...] + Annotations for the cluster. + + --description=DESCRIPTION + Description for the cluster. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + + --logging=COMPONENT,[COMPONENT,...] + Set the components that have logging enabled. + + Examples: + + $ gcloud container attached clusters register --logging=SYSTEM + $ gcloud container attached clusters register \ + --logging=SYSTEM,WORKLOAD + $ gcloud container attached clusters register --logging=NONE + + COMPONENT must be one of: NONE, SYSTEM, WORKLOAD. + + --validate-only + Validate the cluster to create, but don't actually perform it. + +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 variant is also available: + + $ gcloud alpha container attached clusters register + diff --git a/gcloud/container/attached/clusters/update b/gcloud/container/attached/clusters/update new file mode 100644 index 000000000..fae079ff0 --- /dev/null +++ b/gcloud/container/attached/clusters/update @@ -0,0 +1,114 @@ +NAME + gcloud container attached clusters update - update an Attached cluster + +SYNOPSIS + gcloud container attached clusters update (CLUSTER : --location=LOCATION) + [--admin-users=[USER,...]] [--annotations=ANNOTATION,[ANNOTATION,...]] + [--async] [--clear-description] [--description=DESCRIPTION] + [--logging=COMPONENT,[COMPONENT,...]] + [--platform-version=PLATFORM_VERSION] [--validate-only] + [--disable-managed-prometheus | --enable-managed-prometheus] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an Attached cluster. + +EXAMPLES + To update a cluster named my-cluster managed in location us-west1, run: + + $ gcloud container attached clusters update my-cluster \ + --location=us-west1 --description=testcluster + +POSITIONAL ARGUMENTS + Cluster resource - cluster to update. 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 cluster 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. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +FLAGS + --admin-users=[USER,...] + Users that can perform operations as a cluster administrator. + + There is no way to completely remove admin users after setting. + + --annotations=ANNOTATION,[ANNOTATION,...] + Annotations for the cluster. + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --clear-description + Clear the description for the cluster. + + --description=DESCRIPTION + Description for the cluster. + + --logging=COMPONENT,[COMPONENT,...] + Set the components that have logging enabled. + + Examples: + + $ gcloud container attached clusters update --logging=SYSTEM + $ gcloud container attached clusters update --logging=SYSTEM,WORKLOAD + $ gcloud container attached clusters update --logging=NONE + + COMPONENT must be one of: NONE, SYSTEM, WORKLOAD. + + --platform-version=PLATFORM_VERSION + Platform version to use for the cluster. + + To retrieve a list of valid versions, run: + + $ gcloud alpha container attached get-server-config \ + --location=LOCATION + + Replace LOCATION with the target Google Cloud location for the cluster. + + --validate-only + Validate the update of the cluster, but don't actually perform it. + + Monitoring Config + + At most one of these can be specified: + + --disable-managed-prometheus + Disable managed collection for Managed Service for Prometheus. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + +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 variant is also available: + + $ gcloud alpha container attached clusters update + diff --git a/gcloud/container/attached/get-server-config b/gcloud/container/attached/get-server-config new file mode 100644 index 000000000..64d0e05af --- /dev/null +++ b/gcloud/container/attached/get-server-config @@ -0,0 +1,48 @@ +NAME + gcloud container attached get-server-config - get Anthos Multi-Cloud server + configuration for Attached clusters + +SYNOPSIS + gcloud container attached get-server-config [--location=LOCATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get Anthos Multi-Cloud server configuration for Attached clusters. + +EXAMPLES + To return supported Attached cluster valid platform versions in location + us-west1, run: + + $ gcloud container attached get-server-config --location=us-west1 + +FLAGS + Location resource - Google Cloud location to get server configuration. + 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 variant is also available: + + $ gcloud alpha container attached get-server-config + diff --git a/gcloud/container/attached/help b/gcloud/container/attached/help new file mode 100644 index 000000000..25f22aa48 --- /dev/null +++ b/gcloud/container/attached/help @@ -0,0 +1,35 @@ +NAME + gcloud container attached - manage Attached clusters for running containers + +SYNOPSIS + gcloud container attached GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Attached clusters for running containers. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + clusters + Create and manage Attached clusters. + + operations + Manage Anthos Multi-Cloud long running operations for Attached + clusters. + +COMMANDS + COMMAND is one of the following: + + get-server-config + Get Anthos Multi-Cloud server configuration for Attached clusters. + +NOTES + This variant is also available: + + $ gcloud alpha container attached + diff --git a/gcloud/container/attached/operations/describe b/gcloud/container/attached/operations/describe new file mode 100644 index 000000000..81f84351a --- /dev/null +++ b/gcloud/container/attached/operations/describe @@ -0,0 +1,57 @@ +NAME + gcloud container attached operations describe - describe an operation + +SYNOPSIS + gcloud container attached operations describe + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe an operation. + +EXAMPLES + To describe an operation in location us-west1, run: + + $ gcloud container attached operations describe OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 variant is also available: + + $ gcloud alpha container attached operations describe + diff --git a/gcloud/container/attached/operations/help b/gcloud/container/attached/operations/help new file mode 100644 index 000000000..ede760e17 --- /dev/null +++ b/gcloud/container/attached/operations/help @@ -0,0 +1,32 @@ +NAME + gcloud container attached operations - manage Anthos Multi-Cloud long + running operations for Attached clusters + +SYNOPSIS + gcloud container attached operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Anthos Multi-Cloud long running operations for Attached clusters. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe an operation. + + list + List operations. + + wait + Wait for an operation to complete. + +NOTES + This variant is also available: + + $ gcloud alpha container attached operations + diff --git a/gcloud/container/attached/operations/list b/gcloud/container/attached/operations/list new file mode 100644 index 000000000..9d1934576 --- /dev/null +++ b/gcloud/container/attached/operations/list @@ -0,0 +1,79 @@ +NAME + gcloud container attached operations list - list operations + +SYNOPSIS + gcloud container attached operations list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List operations. + +EXAMPLES + To list all operations in location us-west1, run: + + $ gcloud container attached operations list --location=us-west1 + +FLAGS + Location resource - Google Cloud location to list operations. 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 --location on the command line with a fully + specified name; + ◆ set the property container_attached/location with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 + This variant is also available: + + $ gcloud alpha container attached operations list + diff --git a/gcloud/container/attached/operations/wait b/gcloud/container/attached/operations/wait new file mode 100644 index 000000000..eec41a501 --- /dev/null +++ b/gcloud/container/attached/operations/wait @@ -0,0 +1,58 @@ +NAME + gcloud container attached operations wait - wait for an operation to + complete + +SYNOPSIS + gcloud container attached operations wait + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Wait for an operation to complete. + +EXAMPLES + To wait for an operation in location us-west1 to complete, run: + + $ gcloud container attached operations wait OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to wait for. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_attached/location. + +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 variant is also available: + + $ gcloud alpha container attached operations wait + diff --git a/gcloud/container/aws/clusters/delete b/gcloud/container/aws/clusters/delete index b1f5f30ad..228c71a87 100644 --- a/gcloud/container/aws/clusters/delete +++ b/gcloud/container/aws/clusters/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud container aws clusters delete (CLUSTER : --location=LOCATION) - [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete an Anthos cluster on AWS. @@ -41,6 +41,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_aws/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/container/aws/node-pools/create b/gcloud/container/aws/node-pools/create index c75d4ca29..2638f47e7 100644 --- a/gcloud/container/aws/node-pools/create +++ b/gcloud/container/aws/node-pools/create @@ -18,7 +18,10 @@ SYNOPSIS [--root-volume-type=ROOT_VOLUME_TYPE] [--security-group-ids=[SECURITY_GROUP_ID,...]] [--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] [--tags=TAG,[TAG,...]] - [--validate-only] [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] + [--validate-only] + [--autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY + : --autoscaling-metrics=[AUTOSCALING_METRIC,...]] + [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] [--proxy-secret-arn=PROXY_SECRET_ARN --proxy-secret-version-id=PROXY_SECRET_VERSION_ID] [GCLOUD_WIDE_FLAG ...] @@ -135,6 +138,21 @@ OPTIONAL FLAGS --validate-only Validate the node pool to create, but don't actually perform it. + Node pool autoscaling metrics collection + + --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY + Frequency at which EC2 Auto Scaling sends aggregated data to AWS + CloudWatch. The only valid value is "1Minute". + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --autoscaling-metrics=[AUTOSCALING_METRIC,...] + Autoscaling metrics to enable. For a list of valid metrics, refer to + https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html. + If granularity is specified but not any metrics, all metrics are + enabled. + Node pool autoscaling --max-nodes=MAX_NODES diff --git a/gcloud/container/aws/node-pools/delete b/gcloud/container/aws/node-pools/delete index 64a61929b..5dd8e857f 100644 --- a/gcloud/container/aws/node-pools/delete +++ b/gcloud/container/aws/node-pools/delete @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud container aws node-pools delete - (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async] - [--validate-only] [GCLOUD_WIDE_FLAG ...] + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete a node pool in an Anthos cluster on AWS. @@ -52,6 +52,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_aws/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/container/aws/node-pools/update b/gcloud/container/aws/node-pools/update index 16faace0b..df8848340 100644 --- a/gcloud/container/aws/node-pools/update +++ b/gcloud/container/aws/node-pools/update @@ -12,11 +12,15 @@ SYNOPSIS [--root-volume-size=ROOT_VOLUME_SIZE] [--root-volume-type=ROOT_VOLUME_TYPE] [--validate-only] [--annotations=ANNOTATION,[ANNOTATION,...] | --clear-annotations] + [--clear-autoscaling-metrics + | --autoscaling-metrics=[AUTOSCALING_METRIC,...] + --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY] [--clear-proxy-config | --proxy-secret-arn=PROXY_SECRET_ARN --proxy-secret-version-id=PROXY_SECRET_VERSION_ID] [--clear-security-group-ids | --security-group-ids=[SECURITY_GROUP_ID,...]] [--clear-ssh-ec2-key-pair | --ssh-ec2-key-pair=SSH_EC2_KEY_PAIR] + [--clear-tags | --tags=TAG,[TAG,...]] [--max-nodes=MAX_NODES --min-nodes=MIN_NODES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -107,6 +111,27 @@ FLAGS --clear-annotations Clear the annotations for the node pool. + Node pool autoscaling metrics collection + + At most one of these can be specified: + + --clear-autoscaling-metrics + Clear the cloudwatch autoscaling metrics collection associated with + the nodepool. + + Update existing cloudwatch autoscaling metrics collection parameters + + --autoscaling-metrics=[AUTOSCALING_METRIC,...] + Autoscaling metrics to enable. For a list of valid metrics, refer + to + https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html. + If granularity is specified but not any metrics, all metrics are + enabled. + + --autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY + Frequency at which EC2 Auto Scaling sends aggregated data to AWS + CloudWatch. The only valid value is "1Minute". + Proxy config At most one of these can be specified: @@ -146,6 +171,19 @@ FLAGS Name of the EC2 key pair authorized to login to the node pool's nodes. + Tags + + At most one of these can be specified: + + --clear-tags + Clear any tags associated with the node pool's nodes. + + --tags=TAG,[TAG,...] + Applies the given tags (comma separated) on the node pool. Example: + + $ gcloud container aws node-pools update EXAMPLE_NODE_POOL \ + --tags=tag1=one,tag2=two + Node pool autoscaling --max-nodes=MAX_NODES diff --git a/gcloud/container/aws/operations/cancel b/gcloud/container/aws/operations/cancel new file mode 100644 index 000000000..06acc13ce --- /dev/null +++ b/gcloud/container/aws/operations/cancel @@ -0,0 +1,57 @@ +NAME + gcloud container aws operations cancel - cancel an operation + +SYNOPSIS + gcloud container aws operations cancel (OPERATION_ID : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Cancel an operation. + +EXAMPLES + To cancel an operation in location us-west1, run: + + $ gcloud container aws operations cancel OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to cancel. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the name attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_aws/location. + +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 variant is also available: + + $ gcloud alpha container aws operations cancel + diff --git a/gcloud/container/aws/operations/help b/gcloud/container/aws/operations/help index 1d5d90f92..466813971 100644 --- a/gcloud/container/aws/operations/help +++ b/gcloud/container/aws/operations/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + cancel + Cancel an operation. + describe Describe an operation. diff --git a/gcloud/container/azure/clients/delete b/gcloud/container/azure/clients/delete index 9522cd5d1..387c62eb8 100644 --- a/gcloud/container/azure/clients/delete +++ b/gcloud/container/azure/clients/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud container azure clients delete (CLIENT : --location=LOCATION) - [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete an Azure client. @@ -40,6 +40,11 @@ POSITIONAL ARGUMENTS ▸ provide the argument --location on the command line; ▸ set the property container_azure/location. +FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/container/azure/clusters/create b/gcloud/container/azure/clusters/create index 2e65f314c..dbff7d176 100644 --- a/gcloud/container/azure/clusters/create +++ b/gcloud/container/azure/clusters/create @@ -3,13 +3,14 @@ NAME SYNOPSIS gcloud container azure clusters create (CLUSTER : --location=LOCATION) - --azure-region=AZURE_REGION --client=CLIENT - --cluster-version=CLUSTER_VERSION --fleet-project=FLEET_PROJECT + --azure-region=AZURE_REGION --cluster-version=CLUSTER_VERSION + --fleet-project=FLEET_PROJECT --pod-address-cidr-blocks=POD_ADDRESS_CIDR_BLOCKS --resource-group-id=RESOURCE_GROUP_ID --service-address-cidr-blocks=SERVICE_ADDRESS_CIDR_BLOCKS --ssh-public-key=SSH_PUBLIC_KEY --vnet-id=VNET_ID - [--admin-users=USER,[USER,...]] + (--client=CLIENT : --azure-application-id=AZURE_APPLICATION_ID + --azure-tenant-id=AZURE_TENANT_ID) [--admin-users=USER,[USER,...]] [--annotations=ANNOTATION,[ANNOTATION,...]] [--async] [--config-encryption-key-id=CONFIG_ENCRYPTION_KEY_ID] [--config-encryption-public-key=CONFIG_ENCRYPTION_PUBLIC_KEY] @@ -71,26 +72,6 @@ REQUIRED FLAGS Azure location to deploy the cluster. Refer to your Azure subscription for available locations. - Client resource - Azure client to use for cluster creation. 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 --client on the command line with a fully - specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. To set the location attribute: - ◆ provide the argument --client on the command line with a fully - specified name; - ◆ provide the argument --location on the command line; - ◆ set the property container_azure/location. - - This must be specified. - - --client=CLIENT - ID of the client or fully qualified identifier for the client. To set - the client attribute: - ▸ provide the argument --client on the command line. - --cluster-version=CLUSTER_VERSION Kubernetes version to use for the cluster. @@ -114,6 +95,42 @@ REQUIRED FLAGS --vnet-id=VNET_ID ID of the Azure Virtual Network to associate with the cluster. + Authentication configuration + + Exactly one of these must be specified: + + Client resource - Azure client to use for cluster creation. 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 --client on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the location attribute: + ▸ provide the argument --client on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_azure/location. + + --client=CLIENT + ID of the client or fully qualified identifier for the client. To + set the client attribute: + ▫ provide the argument --client on the command line. + + Azure services authentication + + --azure-application-id=AZURE_APPLICATION_ID + ID of the Azure Application to manage Azure resources. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --azure-tenant-id=AZURE_TENANT_ID + ID of the Azure Tenant to manage Azure resources. + + This flag argument must be specified if any of the other arguments + in this group are specified. + OPTIONAL FLAGS --admin-users=USER,[USER,...] Users that can perform operations as a cluster administrator. If not diff --git a/gcloud/container/azure/clusters/delete b/gcloud/container/azure/clusters/delete index 6cb911de2..3b6a9012f 100644 --- a/gcloud/container/azure/clusters/delete +++ b/gcloud/container/azure/clusters/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud container azure clusters delete (CLUSTER : --location=LOCATION) - [--async] [GCLOUD_WIDE_FLAG ...] + [--allow-missing] [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete an Anthos cluster on Azure. @@ -42,6 +42,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_azure/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/container/azure/clusters/update b/gcloud/container/azure/clusters/update index b61c9c7f7..ef90d63bd 100644 --- a/gcloud/container/azure/clusters/update +++ b/gcloud/container/azure/clusters/update @@ -3,13 +3,14 @@ NAME SYNOPSIS gcloud container azure clusters update (CLUSTER : --location=LOCATION) - --client=CLIENT [--admin-users=USER,[USER,...]] [--async] + [--admin-users=USER,[USER,...]] [--async] [--cluster-version=CLUSTER_VERSION] [--logging=COMPONENT,[COMPONENT,...]] [--ssh-public-key=SSH_PUBLIC_KEY] [--validate-only] [--vm-size=VM_SIZE] [--annotations=ANNOTATION,[ANNOTATION,...] | --clear-annotations] [--clear-description | --description=DESCRIPTION] - [GCLOUD_WIDE_FLAG ...] + [--client=CLIENT : --azure-application-id=AZURE_APPLICATION_ID + --azure-tenant-id=AZURE_TENANT_ID] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update an Anthos cluster on Azure. @@ -49,23 +50,6 @@ POSITIONAL ARGUMENTS ▸ set the property container_azure/location. FLAGS - Client resource - Azure client to use for cluster 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 --client on the command line with a fully - specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. To set the location attribute: - ◆ provide the argument --client on the command line with a fully - specified name; - ◆ provide the argument --location on the command line; - ◆ set the property container_azure/location. - - --client=CLIENT - ID of the client or fully qualified identifier for the client. To set - the client attribute: - ▸ provide the argument --client on the command line. - --admin-users=USER,[USER,...] Users that can perform operations as a cluster administrator. @@ -115,6 +99,36 @@ FLAGS --description=DESCRIPTION Description for the cluster. + Authentication configuration + + At most one of these can be specified: + + Client resource - Azure client to use for cluster 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 --client on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the location attribute: + ▸ provide the argument --client on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_azure/location. + + --client=CLIENT + ID of the client or fully qualified identifier for the client. To + set the client attribute: + ▫ provide the argument --client on the command line. + + Azure services authentication + + --azure-application-id=AZURE_APPLICATION_ID + ID of the Azure Application to manage Azure resources. + + --azure-tenant-id=AZURE_TENANT_ID + ID of the Azure Tenant to manage Azure resources. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/container/azure/node-pools/delete b/gcloud/container/azure/node-pools/delete index d7a203e34..930724f53 100644 --- a/gcloud/container/azure/node-pools/delete +++ b/gcloud/container/azure/node-pools/delete @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud container azure node-pools delete - (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--async] - [GCLOUD_WIDE_FLAG ...] + (NODE_POOL : --cluster=CLUSTER --location=LOCATION) [--allow-missing] + [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete a node pool in an Anthos cluster on Azure. @@ -52,6 +52,10 @@ POSITIONAL ARGUMENTS ▸ set the property container_azure/location. FLAGS + --allow-missing + Allow idempotent deletion of cluster. The request will still succeed in + case the cluster does not exist. + --async Return immediately, without waiting for the operation in progress to complete. diff --git a/gcloud/container/azure/operations/cancel b/gcloud/container/azure/operations/cancel new file mode 100644 index 000000000..31b35191f --- /dev/null +++ b/gcloud/container/azure/operations/cancel @@ -0,0 +1,57 @@ +NAME + gcloud container azure operations cancel - cancel an operation + +SYNOPSIS + gcloud container azure operations cancel + (OPERATION_ID : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Cancel an operation. + +EXAMPLES + To cancel an operation in location us-west1, run: + + $ gcloud container azure operations cancel OPERATION_ID \ + --location=us-west1 + +POSITIONAL ARGUMENTS + Operation resource - operation to cancel. 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 operation_id 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. + + OPERATION_ID + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation_id on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location for the operation. To set the location + attribute: + ▸ provide the argument operation_id on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property container_azure/location. + +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 variant is also available: + + $ gcloud alpha container azure operations cancel + diff --git a/gcloud/container/azure/operations/help b/gcloud/container/azure/operations/help index 26a11f6d4..3a8930d90 100644 --- a/gcloud/container/azure/operations/help +++ b/gcloud/container/azure/operations/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + cancel + Cancel an operation. + describe Describe an operation. diff --git a/gcloud/container/clusters/create b/gcloud/container/clusters/create index 4b56be5a3..82324aee0 100644 --- a/gcloud/container/clusters/create +++ b/gcloud/container/clusters/create @@ -22,17 +22,19 @@ SYNOPSIS [--disk-type=DISK_TYPE] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-cloud-logging] [--enable-cloud-monitoring] [--enable-cloud-run-alpha] [--enable-confidential-nodes] - [--enable-cost-allocation] [--enable-dataplane-v2] [--enable-gvnic] + [--enable-cost-allocation] [--enable-dataplane-v2] + [--enable-google-cloud-access] [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] [--enable-l4-ilb-subsetting] - [--enable-legacy-authorization] [--enable-master-global-access] - [--enable-network-policy] [--enable-service-externalips] - [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] - [--enable-vertical-pod-autoscaling] [--gateway-api=GATEWAY_API] - [--image-type=IMAGE_TYPE] [--issue-client-certificate] - [--labels=[KEY=VALUE,...]] [--local-ssd-count=LOCAL_SSD_COUNT] - [--logging=[COMPONENT,...]] [--logging-variant=LOGGING_VARIANT] + [--enable-legacy-authorization] [--enable-managed-prometheus] + [--enable-master-global-access] [--enable-network-policy] + [--enable-service-externalips] [--enable-shielded-nodes] + [--enable-stackdriver-kubernetes] [--enable-vertical-pod-autoscaling] + [--gateway-api=GATEWAY_API] [--image-type=IMAGE_TYPE] + [--ipv6-access-type=IPV6_ACCESS_TYPE] [--issue-client-certificate] + [--labels=[KEY=VALUE,...]] [--logging=[COMPONENT,...]] + [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-nodes-per-pool=MAX_NODES_PER_POOL] [--max-pods-per-node=MAX_PODS_PER_NODE] @@ -46,12 +48,13 @@ SYNOPSIS [--node-version=NODE_VERSION] [--notification-config=[pubsub=ENABLED|DISABLED, pubsub-topic=TOPIC,...]] [--num-nodes=NUM_NODES; default=3] - [--preemptible] + [--placement-type=PLACEMENT_TYPE] [--preemptible] + [--private-endpoint-subnetwork=NAME] [--private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE] [--release-channel=CHANNEL] [--security-group=SECURITY_GROUP] [--services-ipv4-cidr=CIDR] [--services-secondary-range-name=NAME] [--shielded-integrity-monitoring] [--shielded-secure-boot] [--spot] - [--subnetwork=SUBNETWORK] + [--stack-type=STACK_TYPE] [--subnetwork=SUBNETWORK] [--system-config-from-file=SYSTEM_CONFIG_FROM_FILE] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] [--workload-metadata=WORKLOAD_METADATA] [--workload-pool=WORKLOAD_POOL] @@ -88,6 +91,9 @@ SYNOPSIS [--enable-private-endpoint --enable-private-nodes --master-ipv4-cidr=MASTER_IPV4_CIDR] [--enable-tpu --tpu-ipv4-cidr=CIDR] + [--ephemeral-storage-local-ssd=[count=COUNT] + | --local-nvme-ssd-block=[count=COUNT] + | --local-ssd-count=LOCAL_SSD_COUNT] [--maintenance-window=START_TIME | --maintenance-window-end=TIME_STAMP --maintenance-window-recurrence=RRULE --maintenance-window-start=TIME_STAMP] @@ -402,6 +408,11 @@ FLAGS Enables the new eBPF dataplane for GKE clusters that is required for network security, scalability and visibility features. + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --enable-gvnic Enable the use of GVNIC for this cluster. Requires re-creation of nodes using either a node-pool upgrade or node-pool creation. @@ -456,6 +467,9 @@ FLAGS permissions instead, create or update your cluster with the option --no-enable-legacy-authorization. + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + --enable-master-global-access Use with private clusters to allow access to the master's private endpoint from any Google Cloud region or on-premises environment @@ -518,6 +532,10 @@ FLAGS $ gcloud container get-server-config + --ipv6-access-type=IPV6_ACCESS_TYPE + IPv6 access type of the subnetwork. Defaults to 'external'. + IPV6_ACCESS_TYPE must be one of: external, internal. + --issue-client-certificate Issue a TLS client certificate with admin permissions. @@ -535,19 +553,9 @@ FLAGS $ gcloud container clusters create example-cluster \ --labels=label_a=value1,label_b=,label_c=value3 - --local-ssd-count=LOCAL_SSD_COUNT - The number of local SSD disks to provision on each node, formatted and - mounted in the filesystem. - - Local SSDs have a fixed 375 GB capacity per device. The number of disks - that can be attached to an instance is limited by the maximum number of - disks available on a machine, which differs by compute zone. See - https://cloud.google.com/compute/docs/disks/local-ssd for more - information. - --logging=[COMPONENT,...] Set the components that have logging enabled. Valid component values - are: SYSTEM, WORKLOAD, NONE + are: SYSTEM, WORKLOAD, API_SERVER, CONTROLLER_MANAGER, SCHEDULER, NONE For more information, look at https://cloud.google.com/stackdriver/docs/solutions/gke/installing#available-logs @@ -555,7 +563,8 @@ FLAGS Examples: $ gcloud container clusters create --logging=SYSTEM - $ gcloud container clusters create --logging=SYSTEM,WORKLOAD + $ gcloud container clusters create \ + --logging=SYSTEM,API_SERVER,WORKLOAD $ gcloud container clusters create --logging=NONE --logging-variant=LOGGING_VARIANT @@ -787,6 +796,22 @@ FLAGS --num-nodes=NUM_NODES; default=3 The number of nodes to be created in each of the cluster's zones. + --placement-type=PLACEMENT_TYPE + Placement type allows to define the type of node placement within the + default node pool of this cluster. + + UNSPECIFIED - No requirements on the placement of nodes. This is the + default option. + + COMPACT - GKE will attempt to place the nodes in a close proximity to + each other. This helps to reduce the communication latency between the + nodes, but imposes additional limitations on the node pool size. + + $ gcloud container clusters create example-cluster \ + --placement-type=COMPACT + + PLACEMENT_TYPE must be one of: UNSPECIFIED, COMPACT. + --preemptible Create nodes using preemptible VM instances in the new cluster. @@ -797,6 +822,10 @@ FLAGS https://cloud.google.com/kubernetes-engine/docs/preemptible-vm for more information on how to use Preemptible VMs with Kubernetes Engine. + --private-endpoint-subnetwork=NAME + Sets the subnetwork GKE uses to provision the control plane's private + endpoint. + --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE Sets the type of private access to Google services over IPv6. @@ -901,6 +930,10 @@ FLAGS New nodes, including ones created by resize or recreate, will use spot VM instances. + --stack-type=STACK_TYPE + IP stack type of the node VMs. STACK_TYPE must be one of: ipv4, + ipv4-ipv6. + --subnetwork=SUBNETWORK The Google Compute Engine subnetwork (https://cloud.google.com/compute/docs/subnetworks) to which the @@ -1031,7 +1064,7 @@ FLAGS --cluster-dns-scope=CLUSTER_DNS_SCOPE DNS scope for the Cloud DNS zone created - valid only with - --cluster-dns=clouddns + --cluster-dns=clouddns. Defaults to cluster. CLUSTER_DNS_SCOPE must be one of: @@ -1281,7 +1314,8 @@ FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the node @@ -1415,6 +1449,54 @@ FLAGS Can not be specified unless '--enable-tpu' and '--enable-ip-alias' are also specified. + At most one of these can be specified: + + --ephemeral-storage-local-ssd=[count=COUNT] + Parameters for the ephemeral storage filesystem. If unspecified, + ephemeral storage is backed by the boot disk. + + Examples: + + $ gcloud container clusters create example_cluster \ + --ephemeral-storage-local-ssd count=2 + + 'count' specifies the number of local SSDs to use to back ephemeral + storage. Local SDDs use NVMe interfaces and each is 375 GB in size. + Setting 'count=0' disables using local SSDs as ephemeral storage. + + See https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-nvme-ssd-block=[count=COUNT] + Adds the requested local SSDs on all nodes in default node pool(s) in + the new cluster. + + Examples: + + $ gcloud container clusters create example_cluster \ + --local-nvme-ssd-block count=2 + + 'count' must be between 1-8 + + New nodes, including ones created by resize or recreate, will have these + local SSDs. + + Local SSDs have a fixed 375 GB capacity per device. The number of disks + that can be attached to an instance is limited by the maximum number of + disks available on a machine, which differs by compute zone. See + https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-ssd-count=LOCAL_SSD_COUNT + The number of local SSD disks to provision on each node, formatted + and mounted in the filesystem. + + Local SSDs have a fixed 375 GB capacity per device. The number of + disks that can be attached to an instance is limited by the maximum + number of disks available on a machine, which differs by compute + zone. See https://cloud.google.com/compute/docs/disks/local-ssd for + more information. + One of either maintenance-window or the group of maintenance-window flags can be set. diff --git a/gcloud/container/clusters/create-auto b/gcloud/container/clusters/create-auto index 150769159..ac6218d04 100644 --- a/gcloud/container/clusters/create-auto +++ b/gcloud/container/clusters/create-auto @@ -11,10 +11,11 @@ SYNOPSIS [--cluster-secondary-range-name=NAME] [--cluster-version=CLUSTER_VERSION] [--create-subnetwork=[KEY=VALUE,...]] - [--database-encryption-key=DATABASE_ENCRYPTION_KEY] [--network=NETWORK] - [--release-channel=CHANNEL] [--security-group=SECURITY_GROUP] - [--services-ipv4-cidr=CIDR] [--services-secondary-range-name=NAME] - [--subnetwork=SUBNETWORK] + [--database-encryption-key=DATABASE_ENCRYPTION_KEY] + [--enable-google-cloud-access] [--network=NETWORK] + [--private-endpoint-subnetwork=NAME] [--release-channel=CHANNEL] + [--security-group=SECURITY_GROUP] [--services-ipv4-cidr=CIDR] + [--services-secondary-range-name=NAME] [--subnetwork=SUBNETWORK] [--enable-master-authorized-networks --master-authorized-networks=NETWORK,[NETWORK,...]] [--enable-private-endpoint @@ -154,11 +155,20 @@ FLAGS For more information, see https://cloud.google.com/kubernetes-engine/docs/how-to/encrypting-secrets. + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --network=NETWORK The Compute Engine Network that the cluster will connect to. Google Kubernetes Engine will use this network when creating routes and firewalls for the clusters. Defaults to the 'default' network. + --private-endpoint-subnetwork=NAME + Sets the subnetwork GKE uses to provision the control plane's private + endpoint. + --release-channel=CHANNEL Release channel a cluster is subscribed to. diff --git a/gcloud/container/clusters/update b/gcloud/container/clusters/update index ed54dfe5e..5f46644e5 100644 --- a/gcloud/container/clusters/update +++ b/gcloud/container/clusters/update @@ -10,11 +10,12 @@ SYNOPSIS | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling - | --enable-cost-allocation | --enable-identity-service - | --enable-image-streaming | --enable-intra-node-visibility - | --enable-l4-ilb-subsetting | --enable-legacy-authorization - | --enable-master-authorized-networks | --enable-master-global-access - | --enable-network-policy | --enable-service-externalips + | --enable-cost-allocation | --enable-google-cloud-access + | --enable-identity-service | --enable-image-streaming + | --enable-intra-node-visibility | --enable-l4-ilb-subsetting + | --enable-legacy-authorization | --enable-master-authorized-networks + | --enable-master-global-access | --enable-network-policy + | --enable-private-endpoint | --enable-service-externalips | --enable-shielded-nodes | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling | --gateway-api=GATEWAY_API | --generate-password | --logging-variant=LOGGING_VARIANT @@ -24,8 +25,8 @@ SYNOPSIS | --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE | --release-channel=CHANNEL | --remove-labels=[KEY,...] | --security-group=SECURITY_GROUP | --set-password - | --start-credential-rotation | --start-ip-rotation - | --update-addons=[ADDON=ENABLED|DISABLED,...] + | --stack-type=STACK_TYPE | --start-credential-rotation + | --start-ip-rotation | --update-addons=[ADDON=ENABLED|DISABLED,...] | --update-labels=[KEY=VALUE,...] | --workload-pool=WORKLOAD_POOL | --binauthz-evaluation-mode=BINAUTHZ_EVALUATION_MODE | --enable-binauthz | --clear-maintenance-window @@ -42,7 +43,8 @@ SYNOPSIS --enable-resource-consumption-metering --resource-usage-bigquery-dataset=RESOURCE_USAGE_BIGQUERY_DATASET | --cluster-dns=CLUSTER_DNS --cluster-dns-domain=CLUSTER_DNS_DOMAIN - --cluster-dns-scope=CLUSTER_DNS_SCOPE | [--enable-autoprovisioning + --cluster-dns-scope=CLUSTER_DNS_SCOPE | --disable-managed-prometheus + | --enable-managed-prometheus | [--enable-autoprovisioning : --autoprovisioning-config-file=AUTOPROVISIONING_CONFIG_FILE | --autoprovisioning-image-type=AUTOPROVISIONING_IMAGE_TYPE --autoprovisioning-locations=ZONE,[ZONE,...] @@ -178,7 +180,8 @@ REQUIRED FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --enable-cost-allocation Enable the cost management feature. @@ -190,6 +193,11 @@ REQUIRED FLAGS Use --no-enable-cost-allocation to disable this feature. + --enable-google-cloud-access + When you enable Google Cloud Access, any public IP addresses owned by + Google Cloud can reach the public control plane endpoint of your + cluster. + --enable-identity-service Enable Identity Service component on the cluster. @@ -250,6 +258,10 @@ REQUIRED FLAGS addon must first be enabled on the master by using --update-addons=NetworkPolicy=ENABLED flag. + --enable-private-endpoint + Enables cluster's control plane to be accessible using private IP + address only. + --enable-service-externalips Enables use of services with externalIPs field. @@ -445,6 +457,10 @@ REQUIRED FLAGS Set the basic auth password to the specified value, keeping the existing username. + --stack-type=STACK_TYPE + IP stack type of the node VMs. STACK_TYPE must be one of: ipv4, + ipv4-ipv6. + --start-credential-rotation Start the rotation of IP and credentials for this cluster. For example: @@ -667,7 +683,7 @@ REQUIRED FLAGS --cluster-dns-scope=CLUSTER_DNS_SCOPE DNS scope for the Cloud DNS zone created - valid only with - --cluster-dns=clouddns + --cluster-dns=clouddns. Defaults to cluster. CLUSTER_DNS_SCOPE must be one of: @@ -676,6 +692,14 @@ REQUIRED FLAGS vpc Configures the Cloud DNS zone to be private to the VPC Network. + At most one of these can be specified: + + --disable-managed-prometheus + Disable managed collection for Managed Service for Prometheus. + + --enable-managed-prometheus + Enable managed collection for Managed Service for Prometheus. + Node autoprovisioning --enable-autoprovisioning @@ -909,7 +933,8 @@ REQUIRED FLAGS --logging=[COMPONENT,...] Set the components that have logging enabled. Valid component values - are: SYSTEM, WORKLOAD, NONE + are: SYSTEM, WORKLOAD, API_SERVER, CONTROLLER_MANAGER, SCHEDULER, + NONE For more information, look at https://cloud.google.com/stackdriver/docs/solutions/gke/installing#available-logs @@ -917,7 +942,8 @@ REQUIRED FLAGS Examples: $ gcloud container clusters update --logging=SYSTEM - $ gcloud container clusters update --logging=SYSTEM,WORKLOAD + $ gcloud container clusters update \ + --logging=SYSTEM,API_SERVER,WORKLOAD $ gcloud container clusters update --logging=NONE --monitoring=[COMPONENT,...] diff --git a/gcloud/container/fleet/features/list b/gcloud/container/fleet/features/list index 6e2107379..0635d600b 100644 --- a/gcloud/container/fleet/features/list +++ b/gcloud/container/fleet/features/list @@ -7,15 +7,15 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List enabled Hub features in a project. + List enabled fleet features in a project. EXAMPLES - To list all enabled Hub features in a project, run: + To list all enabled fleet features in a project, run: $ gcloud container fleet features list FLAGS - Location resource - The location to list Features under. + Location resource - The location to list features under. 'global' is the only supported value. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be diff --git a/gcloud/container/fleet/help b/gcloud/container/fleet/help index 5b6cb7c32..0aa743669 100644 --- a/gcloud/container/fleet/help +++ b/gcloud/container/fleet/help @@ -58,7 +58,7 @@ GROUPS Manage Multi-cluster Ingress Feature. memberships - Manage memberships of all your GKE and other Kubernetes cluster with + Manage memberships of all your GKE and other Kubernetes clusters with fleets. mesh diff --git a/gcloud/container/fleet/identity-service/apply b/gcloud/container/fleet/identity-service/apply index 22ce18bdf..1272248a5 100644 --- a/gcloud/container/fleet/identity-service/apply +++ b/gcloud/container/fleet/identity-service/apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud container fleet identity-service apply --config=CONFIG - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Applies the authentication configuration to the Identity Service feature @@ -26,8 +26,29 @@ REQUIRED FLAGS The path to the identity-service.yaml config file. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/fleet/identity-service/delete b/gcloud/container/fleet/identity-service/delete index 3ad481fbe..d6af23d9b 100644 --- a/gcloud/container/fleet/identity-service/delete +++ b/gcloud/container/fleet/identity-service/delete @@ -3,8 +3,8 @@ NAME Service Feature Spec for the given membership SYNOPSIS - gcloud container fleet identity-service delete [--membership=MEMBERSHIP] - [GCLOUD_WIDE_FLAG ...] + gcloud container fleet identity-service delete + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Removes the Identity Service Feature Spec for the given membership. @@ -16,8 +16,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/fleet/ingress/enable b/gcloud/container/fleet/ingress/enable index cdd6d1cbd..d3b25bf3e 100644 --- a/gcloud/container/fleet/ingress/enable +++ b/gcloud/container/fleet/ingress/enable @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud container fleet ingress enable - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command enables Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/fleet/ingress/update b/gcloud/container/fleet/ingress/update index 9f02bdfc9..33eb483d9 100644 --- a/gcloud/container/fleet/ingress/update +++ b/gcloud/container/fleet/ingress/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud container fleet ingress update - [--config-membership=CONFIG_MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command updates Multi-cluster Ingress Feature in a fleet. @@ -16,9 +17,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/fleet/memberships/describe b/gcloud/container/fleet/memberships/describe index e7488792a..09fa0619a 100644 --- a/gcloud/container/fleet/memberships/describe +++ b/gcloud/container/fleet/memberships/describe @@ -6,12 +6,12 @@ SYNOPSIS (MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Describe a membership in Fleet. + Describe a membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud container fleet memberships list diff --git a/gcloud/container/fleet/memberships/get-credentials b/gcloud/container/fleet/memberships/get-credentials index 5b65d8530..9864463b0 100644 --- a/gcloud/container/fleet/memberships/get-credentials +++ b/gcloud/container/fleet/memberships/get-credentials @@ -3,31 +3,64 @@ NAME a fleet-registered cluster to be used in Connect Gateway SYNOPSIS - gcloud container fleet memberships get-credentials MEMBERSHIP - [GCLOUD_WIDE_FLAG ...] + gcloud container fleet memberships get-credentials + (MEMBERSHIP_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud container fleet memberships get-credentials updates the kubeconfig file with the appropriate credentials and endpoint information to send - kubectl commands to a fleet-registered and connected cluster through - Connect Gateway Service. + kubectl commands to a fleet-registered and -connected cluster through the + Connect Gateway service. It takes a project, passed through by set defaults or flags. By default, credentials are written to $HOME/.kube/config. You can provide an alternate path by setting the KUBECONFIG environment variable. If KUBECONFIG contains multiple paths, the first one is used. - Upon success, this command will switch current context to the target - cluster, when working with multiple clusters. + Upon success, this command will switch the current context to the target + cluster if other contexts are already present in the kubeconfig file. EXAMPLES - Get gateway kubeconfig for a registered cluster: + Get the Gateway kubeconfig for a globally registered cluster: $ gcloud container fleet memberships get-credentials my-cluster + $ gcloud container fleet memberships get-credentials my-cluster \ + --location=global + + Get the Gateway kubeconfig for a cluster registered in us-central1: + + $ gcloud container fleet memberships get-credentials my-cluster \ + --location=us-central1 POSITIONAL ARGUMENTS - MEMBERSHIP - The membership name used to locate a cluster in your project. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/fleet/memberships/help b/gcloud/container/fleet/memberships/help index a8e6043b2..93ce17e3a 100644 --- a/gcloud/container/fleet/memberships/help +++ b/gcloud/container/fleet/memberships/help @@ -1,12 +1,12 @@ NAME gcloud container fleet memberships - manage memberships of all your GKE and - other Kubernetes cluster with fleets + other Kubernetes clusters with fleets SYNOPSIS - gcloud container fleet memberships COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud container fleet memberships GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Manage memberships of all your GKE and other Kubernetes cluster with + Manage memberships of all your GKE and other Kubernetes clusters with fleets. GCLOUD WIDE FLAGS @@ -37,7 +37,7 @@ COMMANDS Register a cluster with a fleet. unregister - Unregister a cluster from Fleet. + Unregister a cluster from a fleet. update Update a membership. diff --git a/gcloud/container/fleet/memberships/register b/gcloud/container/fleet/memberships/register index cf9ae5ae6..28198c66c 100644 --- a/gcloud/container/fleet/memberships/register +++ b/gcloud/container/fleet/memberships/register @@ -101,7 +101,7 @@ EXAMPLES $ gcloud container fleet memberships register my-cluster \ --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --install-connect-agent --version=20220819-00-00 \ --service-account-key-file=/tmp/keyfile.json Register a GKE cluster and output a manifest that can be used to install the diff --git a/gcloud/container/fleet/memberships/unregister b/gcloud/container/fleet/memberships/unregister index 8dc22e54f..8347aa9cc 100644 --- a/gcloud/container/fleet/memberships/unregister +++ b/gcloud/container/fleet/memberships/unregister @@ -1,9 +1,10 @@ NAME - gcloud container fleet memberships unregister - unregister a cluster from - Fleet + gcloud container fleet memberships unregister - unregister a cluster from a + fleet SYNOPSIS - gcloud container fleet memberships unregister MEMBERSHIP_NAME + gcloud container fleet memberships unregister + (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] @@ -64,9 +65,34 @@ EXAMPLES --uninstall-connect-agent POSITIONAL ARGUMENTS - MEMBERSHIP_NAME - The membership name that you choose to uniquely represents the cluster - being registered on the fleet. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. REQUIRED FLAGS Cluster identifier. diff --git a/gcloud/container/fleet/memberships/update b/gcloud/container/fleet/memberships/update index cb99ad99d..f760e6416 100644 --- a/gcloud/container/fleet/memberships/update +++ b/gcloud/container/fleet/memberships/update @@ -8,12 +8,12 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Update an existing membership in Fleet. + Update an existing membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud container fleet memberships list diff --git a/gcloud/container/fleet/mesh/update b/gcloud/container/fleet/mesh/update index 4338385c6..98a0c94d3 100644 --- a/gcloud/container/fleet/mesh/update +++ b/gcloud/container/fleet/mesh/update @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud container fleet mesh update (--control-plane=CONTROL_PLANE --management=MANAGEMENT) - [--memberships=MEMBERSHIPS] [GCLOUD_WIDE_FLAG ...] + [--memberships=[MEMBERSHIPS,...] : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update the Service Mesh Feature Spec of a Membership. @@ -30,9 +31,30 @@ REQUIRED FLAGS automatic, manual. OPTIONAL FLAGS - --memberships=MEMBERSHIPS - Membership names to update, separated by commas if multiple are - supplied. + Membership resource - The group of arguments defining one or more + memberships. 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 --memberships on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --memberships=[MEMBERSHIPS,...] + IDs of the memberships or fully qualified identifiers for the + memberships. To set the memberships attribute: + ▸ provide the argument --memberships on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the memberships. To set the location attribute: + ▸ provide the argument --memberships on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/help b/gcloud/container/help index 55b302de9..028ca7eeb 100644 --- a/gcloud/container/help +++ b/gcloud/container/help @@ -26,6 +26,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + attached + Manage Attached clusters for running containers. + aws Deploy and manage clusters of machines on AWS for running containers. diff --git a/gcloud/container/hub/features/list b/gcloud/container/hub/features/list index e5f9ddda9..9185ac964 100644 --- a/gcloud/container/hub/features/list +++ b/gcloud/container/hub/features/list @@ -7,15 +7,15 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List enabled Hub features in a project. + List enabled fleet features in a project. EXAMPLES - To list all enabled Hub features in a project, run: + To list all enabled fleet features in a project, run: $ gcloud container hub features list FLAGS - Location resource - The location to list Features under. + Location resource - The location to list features under. 'global' is the only supported value. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be diff --git a/gcloud/container/hub/help b/gcloud/container/hub/help index 78743ea04..6bd361371 100644 --- a/gcloud/container/hub/help +++ b/gcloud/container/hub/help @@ -58,7 +58,7 @@ GROUPS Manage Multi-cluster Ingress Feature. memberships - Manage memberships of all your GKE and other Kubernetes cluster with + Manage memberships of all your GKE and other Kubernetes clusters with fleets. mesh diff --git a/gcloud/container/hub/identity-service/apply b/gcloud/container/hub/identity-service/apply index 6237195dd..0f051abf5 100644 --- a/gcloud/container/hub/identity-service/apply +++ b/gcloud/container/hub/identity-service/apply @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud container hub identity-service apply --config=CONFIG - [--membership=MEMBERSHIP] [GCLOUD_WIDE_FLAG ...] + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Applies the authentication configuration to the Identity Service feature @@ -26,8 +26,29 @@ REQUIRED FLAGS The path to the identity-service.yaml config file. OPTIONAL FLAGS - --membership=MEMBERSHIP - The Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/hub/identity-service/delete b/gcloud/container/hub/identity-service/delete index 874d5af55..4e288ee14 100644 --- a/gcloud/container/hub/identity-service/delete +++ b/gcloud/container/hub/identity-service/delete @@ -3,8 +3,8 @@ NAME Feature Spec for the given membership SYNOPSIS - gcloud container hub identity-service delete [--membership=MEMBERSHIP] - [GCLOUD_WIDE_FLAG ...] + gcloud container hub identity-service delete + [--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Removes the Identity Service Feature Spec for the given membership. @@ -16,8 +16,29 @@ EXAMPLES --membership=MEMBERSHIP_NAME FLAGS - --membership=MEMBERSHIP - Membership name provided during registration. + Membership resource - The group of arguments defining a membership. 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 --membership on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --membership=MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --membership on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/hub/ingress/enable b/gcloud/container/hub/ingress/enable index ba3e2725b..9d51ec0d7 100644 --- a/gcloud/container/hub/ingress/enable +++ b/gcloud/container/hub/ingress/enable @@ -2,7 +2,8 @@ NAME gcloud container hub ingress enable - enable Multi-cluster Ingress Feature SYNOPSIS - gcloud container hub ingress enable [--config-membership=CONFIG_MEMBERSHIP] + gcloud container hub ingress enable + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -15,9 +16,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/hub/ingress/update b/gcloud/container/hub/ingress/update index 3d415a926..dca22bd60 100644 --- a/gcloud/container/hub/ingress/update +++ b/gcloud/container/hub/ingress/update @@ -2,7 +2,8 @@ NAME gcloud container hub ingress update - update Multi-cluster Ingress Feature SYNOPSIS - gcloud container hub ingress update [--config-membership=CONFIG_MEMBERSHIP] + gcloud container hub ingress update + [--config-membership=CONFIG_MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -15,9 +16,29 @@ EXAMPLES --config-membership=CONFIG_MEMBERSHIP FLAGS - --config-membership=CONFIG_MEMBERSHIP - Membership resource representing the cluster which hosts the - MultiClusterIngress and MultiClusterService CustomResourceDefinitions. + Membership resource - The group of arguments defining a membership. 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 --config-membership on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --config-membership=CONFIG_MEMBERSHIP + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument --config-membership on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the membership. To set the location attribute: + ▸ provide the argument --config-membership on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/hub/memberships/describe b/gcloud/container/hub/memberships/describe index 54603bb63..24e47b3eb 100644 --- a/gcloud/container/hub/memberships/describe +++ b/gcloud/container/hub/memberships/describe @@ -6,12 +6,12 @@ SYNOPSIS (MEMBERSHIP : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Describe a membership in Fleet. + Describe a membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud container hub memberships list diff --git a/gcloud/container/hub/memberships/get-credentials b/gcloud/container/hub/memberships/get-credentials index d4b512a77..a8b1d1224 100644 --- a/gcloud/container/hub/memberships/get-credentials +++ b/gcloud/container/hub/memberships/get-credentials @@ -3,31 +3,64 @@ NAME fleet-registered cluster to be used in Connect Gateway SYNOPSIS - gcloud container hub memberships get-credentials MEMBERSHIP - [GCLOUD_WIDE_FLAG ...] + gcloud container hub memberships get-credentials + (MEMBERSHIP_NAME : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud container hub memberships get-credentials updates the kubeconfig file with the appropriate credentials and endpoint information to send - kubectl commands to a fleet-registered and connected cluster through - Connect Gateway Service. + kubectl commands to a fleet-registered and -connected cluster through the + Connect Gateway service. It takes a project, passed through by set defaults or flags. By default, credentials are written to $HOME/.kube/config. You can provide an alternate path by setting the KUBECONFIG environment variable. If KUBECONFIG contains multiple paths, the first one is used. - Upon success, this command will switch current context to the target - cluster, when working with multiple clusters. + Upon success, this command will switch the current context to the target + cluster if other contexts are already present in the kubeconfig file. EXAMPLES - Get gateway kubeconfig for a registered cluster: + Get the Gateway kubeconfig for a globally registered cluster: $ gcloud container hub memberships get-credentials my-cluster + $ gcloud container hub memberships get-credentials my-cluster \ + --location=global + + Get the Gateway kubeconfig for a cluster registered in us-central1: + + $ gcloud container hub memberships get-credentials my-cluster \ + --location=us-central1 POSITIONAL ARGUMENTS - MEMBERSHIP - The membership name used to locate a cluster in your project. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/hub/memberships/help b/gcloud/container/hub/memberships/help index ba86fdb59..ceb4730b1 100644 --- a/gcloud/container/hub/memberships/help +++ b/gcloud/container/hub/memberships/help @@ -1,12 +1,12 @@ NAME gcloud container hub memberships - manage memberships of all your GKE and - other Kubernetes cluster with fleets + other Kubernetes clusters with fleets SYNOPSIS - gcloud container hub memberships COMMAND [GCLOUD_WIDE_FLAG ...] + gcloud container hub memberships GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Manage memberships of all your GKE and other Kubernetes cluster with + Manage memberships of all your GKE and other Kubernetes clusters with fleets. GCLOUD WIDE FLAGS @@ -37,7 +37,7 @@ COMMANDS Register a cluster with a fleet. unregister - Unregister a cluster from Fleet. + Unregister a cluster from a fleet. update Update a membership. diff --git a/gcloud/container/hub/memberships/register b/gcloud/container/hub/memberships/register index 4a86da69f..9f7f6b763 100644 --- a/gcloud/container/hub/memberships/register +++ b/gcloud/container/hub/memberships/register @@ -100,7 +100,7 @@ EXAMPLES $ gcloud container hub memberships register my-cluster \ --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --install-connect-agent --version=20220819-00-00 \ --service-account-key-file=/tmp/keyfile.json Register a GKE cluster and output a manifest that can be used to install the diff --git a/gcloud/container/hub/memberships/unregister b/gcloud/container/hub/memberships/unregister index 3f9c58c78..ea4312459 100644 --- a/gcloud/container/hub/memberships/unregister +++ b/gcloud/container/hub/memberships/unregister @@ -1,9 +1,10 @@ NAME - gcloud container hub memberships unregister - unregister a cluster from - Fleet + gcloud container hub memberships unregister - unregister a cluster from a + fleet SYNOPSIS - gcloud container hub memberships unregister MEMBERSHIP_NAME + gcloud container hub memberships unregister + (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] @@ -64,9 +65,34 @@ EXAMPLES --uninstall-connect-agent POSITIONAL ARGUMENTS - MEMBERSHIP_NAME - The membership name that you choose to uniquely represents the cluster - being registered on the fleet. + Membership resource - The group of arguments defining a membership. 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 MEMBERSHIP_NAME 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. + + MEMBERSHIP_NAME + ID of the membership or fully qualified identifier for the + membership. To set the membership attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location of the membership resource, e.g. us-central1. If not + specified, defaults to global. + + To set the location attribute: + ▸ provide the argument MEMBERSHIP_NAME on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. REQUIRED FLAGS Cluster identifier. diff --git a/gcloud/container/hub/memberships/update b/gcloud/container/hub/memberships/update index 54b1ffff8..7300e3b30 100644 --- a/gcloud/container/hub/memberships/update +++ b/gcloud/container/hub/memberships/update @@ -7,12 +7,12 @@ SYNOPSIS [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Update an existing membership in Fleet. + Update an existing membership in a fleet. EXAMPLES First retrieve the ID of the membership using the command below. The output of this command lists all the fleet's members, with their unique IDs in the - Names column: + NAME column: $ gcloud container hub memberships list diff --git a/gcloud/container/hub/mesh/update b/gcloud/container/hub/mesh/update index 9b393871d..dd93d427f 100644 --- a/gcloud/container/hub/mesh/update +++ b/gcloud/container/hub/mesh/update @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud container hub mesh update (--control-plane=CONTROL_PLANE --management=MANAGEMENT) - [--memberships=MEMBERSHIPS] [GCLOUD_WIDE_FLAG ...] + [--memberships=[MEMBERSHIPS,...] : --location=LOCATION] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update the Service Mesh Feature Spec of a Membership. @@ -30,9 +31,30 @@ REQUIRED FLAGS automatic, manual. OPTIONAL FLAGS - --memberships=MEMBERSHIPS - Membership names to update, separated by commas if multiple are - supplied. + Membership resource - The group of arguments defining one or more + memberships. 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 --memberships on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --memberships=[MEMBERSHIPS,...] + IDs of the memberships or fully qualified identifiers for the + memberships. To set the memberships attribute: + ▸ provide the argument --memberships on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Location for the memberships. To set the location attribute: + ▸ provide the argument --memberships on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkehub/location. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/container/node-pools/create b/gcloud/container/node-pools/create index d7f1d83ea..8529c5720 100644 --- a/gcloud/container/node-pools/create +++ b/gcloud/container/node-pools/create @@ -8,14 +8,14 @@ SYNOPSIS gpu-partition-size=GPU_PARTITION_SIZE, gpu-sharing-strategy=GPU_SHARING_STRATEGY, max-shared-clients-per-gpu=MAX_SHARED_CLIENTS_PER_GPU],...]] - [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] + [--async] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] [--enable-gvnic] - [--enable-image-streaming] [--enable-surge-upgrade] - [--image-type=IMAGE_TYPE] [--local-ssd-count=LOCAL_SSD_COUNT] - [--logging-variant=LOGGING_VARIANT] + [--enable-image-streaming] [--enable-private-nodes] + [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] + [--labels=[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] [--max-surge-upgrade=MAX_SURGE_UPGRADE; default=1] @@ -28,19 +28,23 @@ SYNOPSIS [--node-locations=ZONE,[ZONE,...]] [--node-pool-soak-duration=NODE_POOL_SOAK_DURATION] [--node-taints=[NODE_TAINT,...]] [--node-version=NODE_VERSION] - [--num-nodes=NUM_NODES; default=3] [--preemptible] - [--sandbox=[type=TYPE]] [--shielded-integrity-monitoring] - [--shielded-secure-boot] [--spot] + [--num-nodes=NUM_NODES; default=3] [--placement-type=PLACEMENT_TYPE] + [--preemptible] [--sandbox=[type=TYPE]] + [--shielded-integrity-monitoring] [--shielded-secure-boot] [--spot] [--standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, batch-percent=BATCH_NODE_PERCENTAGE, batch-soak-duration=BATCH_SOAK_DURATION,...]] [--system-config-from-file=SYSTEM_CONFIG_FROM_FILE] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] + [--windows-os-version=WINDOWS_OS_VERSION] [--workload-metadata=WORKLOAD_METADATA] [--create-pod-ipv4-range=[KEY=VALUE,...] | --pod-ipv4-range=NAME] [--enable-autoscaling --location-policy=LOCATION_POLICY --max-nodes=MAX_NODES --min-nodes=MIN_NODES --total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES] + [--ephemeral-storage-local-ssd=[count=COUNT] + | --local-nvme-ssd-block=[count=COUNT] + | --local-ssd-count=LOCAL_SSD_COUNT] [--region=REGION | --zone=ZONE, -z ZONE] [--reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY] [--scopes=[SCOPE,...]; @@ -99,6 +103,10 @@ FLAGS (Optional) The max number of containers allowed to share each GPU on the node. This field is used together with gpu-sharing-strategy. + --async + Return immediately, without waiting for the operation in progress to + complete. + --boot-disk-kms-key=BOOT_DISK_KMS_KEY The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form @@ -166,6 +174,13 @@ FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-private-nodes + Enables provisioning nodes with private IP addresses only. + + The control plane still communicates with all nodes through private IP + addresses only, regardless of whether private nodes are enabled or + disabled. + --enable-surge-upgrade Changes node pool upgrade strategy to surge upgrade. @@ -182,15 +197,14 @@ FLAGS $ gcloud container get-server-config - --local-ssd-count=LOCAL_SSD_COUNT - The number of local SSD disks to provision on each node, formatted and - mounted in the filesystem. + --labels=[KEY=VALUE,...] + Labels to apply to the Google Cloud resources of node pools in the + Kubernetes Engine cluster. These are unrelated to Kubernetes labels. - Local SSDs have a fixed 375 GB capacity per device. The number of disks - that can be attached to an instance is limited by the maximum number of - disks available on a machine, which differs by compute zone. See - https://cloud.google.com/compute/docs/disks/local-ssd for more - information. + Examples: + + $ gcloud container node-pools create node-pool-1 \ + --cluster=example-cluster --labels=label1=value1,label2=value2 --logging-variant=LOGGING_VARIANT Specifies the logging variant that will be deployed on all the nodes in @@ -404,6 +418,22 @@ FLAGS --num-nodes=NUM_NODES; default=3 The number of nodes in the node pool in each of the cluster's zones. + --placement-type=PLACEMENT_TYPE + Placement type allows to define the type of node placement within this + node pool. + + UNSPECIFIED - No requirements on the placement of nodes. This is the + default option. + + COMPACT - GKE will attempt to place the nodes in a close proximity to + each other. This helps to reduce the communication latency between the + nodes, but imposes additional limitations on the node pool size. + + $ gcloud container node-pools create node-pool-1 \ + --cluster=example-cluster --placement-type=COMPACT + + PLACEMENT_TYPE must be one of: UNSPECIFIED, COMPACT. + --preemptible Create nodes using preemptible VM instances in the new node pool. @@ -517,6 +547,14 @@ FLAGS The number of visible threads per physical core for each node. To disable simultaneous multithreading (SMT) set this to 1. + --windows-os-version=WINDOWS_OS_VERSION + Specifies the Windows Server Image to use when creating a Windows node + pool. Valid variants can be "ltsc2019", "ltsc2022". It means using + LTSC2019 server image or LTSC2022 server image. If the node pool + doesn't specify a Windows Server Image Os version, then Ltsc2019 will + be the default one to use. WINDOWS_OS_VERSION must be one of: ltsc2019, + ltsc2022. + --workload-metadata=WORKLOAD_METADATA Type of metadata server available to pods running in the node pool. WORKLOAD_METADATA must be one of: @@ -593,7 +631,8 @@ FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or the - default node pool if --node-pool is not provided. + default node pool if --node-pool is not provided. If not already, + --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the node @@ -634,6 +673,54 @@ FLAGS --node-pool (or default node pool if unspecified) can scale. Ignored unless --enable-autoscaling is also specified. + At most one of these can be specified: + + --ephemeral-storage-local-ssd=[count=COUNT] + Parameters for the ephemeral storage filesystem. If unspecified, + ephemeral storage is backed by the boot disk. + + Examples: + + $ gcloud container node-pools create node-pool-1 --cluster=example \ + cluster --ephemeral-storage-local-ssd count=2 + + 'count' specifies the number of local SSDs to use to back ephemeral + storage. Local SDDs use NVMe interfaces and each is 375 GB in size. + Setting 'count=0' disables using local SSDs as ephemeral storage. + + See https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-nvme-ssd-block=[count=COUNT] + Adds the requested local SSDs on all nodes in default node pool(s) in + the new cluster. + + Examples: + + $ gcloud container node-pools create node-pool-1 --cluster=example \ + cluster --local-nvme-ssd-block count=2 + + 'count' must be between 1-8 + + New nodes, including ones created by resize or recreate, will have these + local SSDs. + + Local SSDs have a fixed 375 GB capacity per device. The number of disks + that can be attached to an instance is limited by the maximum number of + disks available on a machine, which differs by compute zone. See + https://cloud.google.com/compute/docs/disks/local-ssd for more + information. + + --local-ssd-count=LOCAL_SSD_COUNT + The number of local SSD disks to provision on each node, formatted + and mounted in the filesystem. + + Local SSDs have a fixed 375 GB capacity per device. The number of + disks that can be attached to an instance is limited by the maximum + number of disks available on a machine, which differs by compute + zone. See https://cloud.google.com/compute/docs/disks/local-ssd for + more information. + At most one of these can be specified: --region=REGION diff --git a/gcloud/container/node-pools/delete b/gcloud/container/node-pools/delete index 1d3c76a0f..743005ca3 100644 --- a/gcloud/container/node-pools/delete +++ b/gcloud/container/node-pools/delete @@ -8,9 +8,12 @@ SYNOPSIS DESCRIPTION gcloud container node-pools delete deletes a node pool from a Google - Kubernetes Engine cluster. This command does not gracefully drain the nodes - prior to deleting them. Use "kubectl drain NODE_NAME" to drain each node to - have containers running on these nodes terminate gracefully. + Kubernetes Engine (GKE) cluster. When you delete a node pool, GKE drains + all the nodes in the node pool. The draining process involves GKE evicting + Pods on each node in the node pool. Each node in a node pool is drained by + evicting Pods with an allotted graceful termination period of MAX_POD. + MAX_POD is the maximum terminationGracePeriodSeconds set on the Pods + scheduled to the node with a cap of one hour. EXAMPLES To delete the "node-pool-1" node pool from the cluster "sample-cluster", diff --git a/gcloud/container/node-pools/update b/gcloud/container/node-pools/update index e1336ab88..84ad7a71e 100644 --- a/gcloud/container/node-pools/update +++ b/gcloud/container/node-pools/update @@ -5,15 +5,16 @@ NAME SYNOPSIS gcloud container node-pools update NAME (--enable-confidential-nodes | --enable-gvnic - | --enable-image-streaming | --logging-variant=LOGGING_VARIANT + | --enable-image-streaming | --enable-private-nodes + | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] | --system-config-from-file=SYSTEM_CONFIG_FROM_FILE - | --tags=[TAG,...] | --workload-metadata=WORKLOAD_METADATA - | --enable-autoprovisioning --enable-autoscaling - --location-policy=LOCATION_POLICY --max-nodes=MAX_NODES - --min-nodes=MIN_NODES + | --tags=[TAG,...] | --windows-os-version=WINDOWS_OS_VERSION + | --workload-metadata=WORKLOAD_METADATA | --enable-autoprovisioning + --enable-autoscaling --location-policy=LOCATION_POLICY + --max-nodes=MAX_NODES --min-nodes=MIN_NODES --total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES | --enable-autorepair --enable-autoupgrade | --enable-blue-green-upgrade --enable-surge-upgrade @@ -22,8 +23,9 @@ SYNOPSIS --node-pool-soak-duration=NODE_POOL_SOAK_DURATION --standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT, batch-percent=BATCH_NODE_PERCENTAGE, - batch-soak-duration=BATCH_SOAK_DURATION,...]) [--cluster=CLUSTER] - [--region=REGION | --zone=ZONE, -z ZONE] [GCLOUD_WIDE_FLAG ...] + batch-soak-duration=BATCH_SOAK_DURATION,...]) [--async] + [--cluster=CLUSTER] [--region=REGION | --zone=ZONE, -z ZONE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud container node-pools update updates a node pool in a Google @@ -54,6 +56,22 @@ REQUIRED FLAGS --enable-image-streaming Specifies whether to enable image streaming on node pool. + --enable-private-nodes + Enables provisioning nodes with private IP addresses only. + + The control plane still communicates with all nodes through private + IP addresses only, regardless of whether private nodes are enabled or + disabled. + + --labels=[KEY=VALUE,...] + Labels to apply to the Google Cloud resources of node pools in the + Kubernetes Engine cluster. These are unrelated to Kubernetes labels. + + Examples: + + $ gcloud container node-pools update node-pool-1 \ + --cluster=example-cluster --labels=label1=value1,label2=value2 + --logging-variant=LOGGING_VARIANT Specifies the logging variant that will be deployed on all the nodes in the node pool. If the node pool doesn't specify a logging variant, @@ -188,6 +206,14 @@ REQUIRED FLAGS https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/create for examples. + --windows-os-version=WINDOWS_OS_VERSION + Specifies the Windows Server Image to use when creating a Windows + node pool. Valid variants can be "ltsc2019", "ltsc2022". It means + using LTSC2019 server image or LTSC2022 server image. If the node + pool doesn't specify a Windows Server Image Os version, then Ltsc2019 + will be the default one to use. WINDOWS_OS_VERSION must be one of: + ltsc2019, ltsc2022. + --workload-metadata=WORKLOAD_METADATA Type of metadata server available to pods running in the node pool. WORKLOAD_METADATA must be one of: @@ -216,7 +242,8 @@ REQUIRED FLAGS Enables autoscaling for a node pool. Enables autoscaling in the node pool specified by --node-pool or - the default node pool if --node-pool is not provided. + the default node pool if --node-pool is not provided. If not + already, --max-nodes or --total-max-nodes must also be set. --location-policy=LOCATION_POLICY Location policy specifies the algorithm used when scaling-up the @@ -345,6 +372,10 @@ REQUIRED FLAGS batch-soak-duration=60s OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + --cluster=CLUSTER The name of the cluster. Overrides the default container/cluster property value for this command invocation. diff --git a/gcloud/data-catalog/entries/create b/gcloud/data-catalog/entries/create index 95c0a748f..a44ff5420 100644 --- a/gcloud/data-catalog/entries/create +++ b/gcloud/data-catalog/entries/create @@ -95,9 +95,10 @@ REQUIRED FLAGS pattern must be specified. --type=TYPE - Type of the entry. TYPE must be one of: cluster, database, - data-source-connection, data-stream, entry-type-unspecified, - fileset, lake, model, routine, service, table, zone. + Type of the entry. TYPE must be one of: cluster, dashboard, + database, database-schema, data-source-connection, data-stream, + entry-type-unspecified, explore, fileset, lake, look, model, + routine, service, table, zone. This flag argument must be specified if any of the other arguments in this group are specified. diff --git a/gcloud/database-migration/connection-profiles/create/alloydb b/gcloud/database-migration/connection-profiles/create/alloydb new file mode 100644 index 000000000..473bc42df --- /dev/null +++ b/gcloud/database-migration/connection-profiles/create/alloydb @@ -0,0 +1,109 @@ +NAME + gcloud database-migration connection-profiles create alloydb - create a + Database Migration Service connection profile for AlloyDB + +SYNOPSIS + gcloud database-migration connection-profiles create alloydb + (CONNECTION_PROFILE : --region=REGION) --cpu-count=CPU_COUNT + --password=PASSWORD --primary-id=PRIMARY_ID [--no-async] + [--cluster-labels=[KEY=VALUE,...]] [--database-flags=[FLAG=VALUE,...]] + [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] + [--network=NETWORK] [--primary-labels=[KEY=VALUE,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Database Migration Service destination connection profile for + AlloyDB. This will create an AlloyDB cluster and primary instance. + +EXAMPLES + To create a connection profile for AlloyDB: + + $ gcloud database-migration connection-profiles create alloydb \ + my-profile --region=us-central1 --password=my_password \ + --primary-id=my-primary --cpu-count=2 + +POSITIONAL ARGUMENTS + Connection profile resource - The connection profile to create. 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 connection_profile 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. + + CONNECTION_PROFILE + ID of the connection_profile or fully qualified identifier for the + connection_profile. To set the connection_profile attribute: + ▸ provide the argument connection_profile 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 connection_profile. To set the region + attribute: + ▸ provide the argument connection_profile on the command line with + a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + --cpu-count=CPU_COUNT + Whole number value indicating how many vCPUs the machine should + contain. Each vCPU count corresponds to a N2 high-mem machine: + (https://cloud.google.com/compute/docs/general-purpose-machines#n2_machines). + CPU_COUNT must be one of: 2, 4, 8, 16, 32, 64. + + --password=PASSWORD + Initial password for the 'postgres' user. + + --primary-id=PRIMARY_ID + The ID of the primary instance for this AlloyDB cluster. + +OPTIONAL FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --cluster-labels=[KEY=VALUE,...] + The resource labels for an AlloyDB cluster. An object containing a list + of "key": "value" pairs. + + --database-flags=[FLAG=VALUE,...] + Comma-separated list of database flags to set on the AlloyDB primary + instance. Use an equals sign to separate the flag name and value. Flags + without values, like skip_grant_tables, can be written out without a + value, e.g., skip_grant_tables=. Use on/off values for booleans. View + AlloyDB's documentation for allowed flags (e.g., --database-flags + max_allowed_packet=55555,skip_grant_tables=,log_output=1). + + --display-name=DISPLAY_NAME + A user-friendly name for the connection profile. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --network=NETWORK + The VPC network from which the AlloyDB instance is accessible via + private IP. For example, projects/myProject/global/networks/default. + This setting cannot be updated after it is set. + + --primary-labels=[KEY=VALUE,...] + The resource labels for an AlloyDB primary instance. An object + containing a list of "key": "value" pairs. + +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. diff --git a/gcloud/database-migration/connection-profiles/create/help b/gcloud/database-migration/connection-profiles/create/help index 6a0b8a6a7..4f8b659be 100644 --- a/gcloud/database-migration/connection-profiles/create/help +++ b/gcloud/database-migration/connection-profiles/create/help @@ -22,12 +22,18 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + alloydb + Create a Database Migration Service connection profile for AlloyDB. + cloudsql Create a Database Migration Service connection profile for Cloud SQL. mysql Create a Database Migration Service connection profile for MySQL. + oracle + Create a Database Migration Service connection profile for Oracle. + postgresql Create a Database Migration Service connection profile for PostgreSQL. diff --git a/gcloud/database-migration/connection-profiles/create/oracle b/gcloud/database-migration/connection-profiles/create/oracle new file mode 100644 index 000000000..469fedb92 --- /dev/null +++ b/gcloud/database-migration/connection-profiles/create/oracle @@ -0,0 +1,149 @@ +NAME + gcloud database-migration connection-profiles create oracle - create a + Database Migration Service connection profile for Oracle + +SYNOPSIS + gcloud database-migration connection-profiles create oracle + (CONNECTION_PROFILE : --region=REGION) + --database-service=DATABASE_SERVICE --host=HOST --port=PORT + --username=USERNAME (--password=PASSWORD | --prompt-for-password) + [--no-async] [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] + [--private-connection=PRIVATE_CONNECTION : --static-ip-connectivity + | [--forward-ssh-hostname=FORWARD_SSH_HOSTNAME + --forward-ssh-username=FORWARD_SSH_USERNAME + (--forward-ssh-password=FORWARD_SSH_PASSWORD + | --forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY) + : --forward-ssh-port=FORWARD_SSH_PORT; default=22]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Database Migration Service connection profile for Oracle. + +EXAMPLES + To create a connection profile for Oracle: + + $ gcloud database-migration connection-profiles create oracle \ + my-profile --region=us-central1 --password=123456 \ + --username=my-user --host=1.2.3.4 --port=5432 + +POSITIONAL ARGUMENTS + Connection profile resource - The connection profile to create. 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 connection_profile 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. + + CONNECTION_PROFILE + ID of the connection_profile or fully qualified identifier for the + connection_profile. To set the connection_profile attribute: + ▸ provide the argument connection_profile 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 connection_profile. To set the region + attribute: + ▸ provide the argument connection_profile on the command line with + a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + --database-service=DATABASE_SERVICE + database service for the oracle connection profile. + + --host=HOST + IP or hostname of the source database. + + --port=PORT + Network port of the source database. + + --username=USERNAME + Username that Database Migration Service uses to connect to the + database. Database Migration Service encrypts the value when storing + it. + + Exactly one of these must be specified: + + --password=PASSWORD + Password for the user that Database Migration Service uses to connect + to the source database. Database Migration Service encrypts the value + when storing it, and the field is not returned on request. + + --prompt-for-password + Prompt for the password used to connect to the database. + +OPTIONAL FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --display-name=DISPLAY_NAME + A user-friendly name for the connection profile. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + At most one of these can be specified: + + Private connection resource - Resource ID of the private connection. + 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 --private-connection on the command line with + a fully specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the region attribute: + ▸ provide the argument --private-connection on the command line with + a fully specified name; + ▸ provide the argument --region on the command line. + + --private-connection=PRIVATE_CONNECTION + ID of the private_connection or fully qualified identifier for the + private_connection. To set the private_connection attribute: + ▫ provide the argument --private-connection on the command line. + + --static-ip-connectivity + use static ip connectivity + + --forward-ssh-hostname=FORWARD_SSH_HOSTNAME + Hostname for the SSH tunnel. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --forward-ssh-username=FORWARD_SSH_USERNAME + Username for the SSH tunnel. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --forward-ssh-port=FORWARD_SSH_PORT; default=22 + Port for the SSH tunnel, default value is 22. + + Exactly one of these must be specified: + + --forward-ssh-password=FORWARD_SSH_PASSWORD + SSH password. + + --forward-ssh-private-key=FORWARD_SSH_PRIVATE_KEY + SSH private key.. + +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. diff --git a/gcloud/database-migration/connection-profiles/create/postgresql b/gcloud/database-migration/connection-profiles/create/postgresql index 496459e2e..29921786e 100644 --- a/gcloud/database-migration/connection-profiles/create/postgresql +++ b/gcloud/database-migration/connection-profiles/create/postgresql @@ -10,7 +10,8 @@ SYNOPSIS [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] [--ca-certificate=CA_CERTIFICATE : --client-certificate=CLIENT_CERTIFICATE --private-key=PRIVATE_KEY] - [GCLOUD_WIDE_FLAG ...] + [--psc-service-attachment=PSC_SERVICE_ATTACHMENT + : --static-ip-connectivity] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a Database Migration Service connection profile for PostgreSQL. @@ -115,6 +116,29 @@ OPTIONAL FLAGS the Client Certificate. Database Migration Service encrypts the value when storing it. + At most one of these can be specified: + + Service attachment resource - Resource ID of the service attachment. + 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 --psc-service-attachment on the command line + with a fully specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the region attribute: + ▸ provide the argument --psc-service-attachment on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + + --psc-service-attachment=PSC_SERVICE_ATTACHMENT + ID of the service_attachment or fully qualified identifier for the + service_attachment. To set the service_attachment attribute: + ▫ provide the argument --psc-service-attachment on the command + line. + + --static-ip-connectivity + use static ip connectivity + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/database-migration/conversion-workspaces/apply b/gcloud/database-migration/conversion-workspaces/apply new file mode 100644 index 000000000..072c0ada6 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/apply @@ -0,0 +1,84 @@ +NAME + gcloud database-migration conversion-workspaces apply - apply a Database + Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces apply + (CONVERSION_WORKSPACE : --region=REGION) + --destination-connection-profile=DESTINATION_CONNECTION_PROFILE + [--no-async] [--filter-string=FILTER_STRING] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Apply Database Migration Service conversion workspace onto the destination + database. + +EXAMPLES + To apply a conversion workspace: + + $ gcloud database-migration conversion-workspaces apply \ + my-conversion-workspace --region=us-central1 \ + --destination-connection-profile=projects/$$PROJECT_ID$$/\ + locations/us-central1/connectionProfiles/cp1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to apply. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + Connection profile resource - The connection profile to apply 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 --destination-connection-profile on the command + line with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. To set the region attribute: + ◆ provide the argument --destination-connection-profile on the command + line with a fully specified name; + ◆ provide the argument --region on the command line. + + This must be specified. + + --destination-connection-profile=DESTINATION_CONNECTION_PROFILE + ID of the connection_profile or fully qualified identifier for the + connection_profile. To set the connection_profile attribute: + ▸ provide the argument --destination-connection-profile on the + command line. + +OPTIONAL FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --filter-string=FILTER_STRING + Filter the entities based on AIP-160 standard. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/commit b/gcloud/database-migration/conversion-workspaces/commit new file mode 100644 index 000000000..b9d74544e --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/commit @@ -0,0 +1,62 @@ +NAME + gcloud database-migration conversion-workspaces commit - commit a Database + Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces commit + (CONVERSION_WORKSPACE : --region=REGION) [--no-async] + [--commit-name=COMMIT_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commit a Database Migration Service conversion workspace. + +EXAMPLES + To commit a conversion workspace: + + $ gcloud database-migration conversion-workspaces commit \ + my-conversion-workspace --region=us-central1 \ + --commit-name=my-commit + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to commit. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --commit-name=COMMIT_NAME + A user-friendly name for the conversion workspace commit. The commit + name can include letters, numbers, spaces, and hyphens, and must start + with a letter. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/convert b/gcloud/database-migration/conversion-workspaces/convert new file mode 100644 index 000000000..80e23df09 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/convert @@ -0,0 +1,62 @@ +NAME + gcloud database-migration conversion-workspaces convert - convert a + Database Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces convert + (CONVERSION_WORKSPACE : --region=REGION) [--no-async] [--auto-commit] + [--filter-string=FILTER_STRING] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Convert a Database Migration Service conversion workspace. + +EXAMPLES + To convert a conversion workspace: + + $ gcloud database-migration conversion-workspaces convert \ + my-conversion-workspace --region=us-central1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to convert. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --auto-commit + Auto commits the conversion workspace. + + --filter-string=FILTER_STRING + Filter the entities based on AIP-160 standard. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/create b/gcloud/database-migration/conversion-workspaces/create new file mode 100644 index 000000000..ed50cb95c --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/create @@ -0,0 +1,91 @@ +NAME + gcloud database-migration conversion-workspaces create - create a Database + Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces create + (CONVERSION_WORKSPACE : --region=REGION) + --destination-database-engine=DESTINATION_DATABASE_ENGINE + --destination-database-version=DESTINATION_DATABASE_VERSION + --source-database-engine=SOURCE_DATABASE_ENGINE + --source-database-version=SOURCE_DATABASE_VERSION [--no-async] + [--display-name=DISPLAY_NAME] [--global-settings=[KEY=VALUE,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Database Migration Service conversion workspace. + +EXAMPLES + To create a conversion workspace: + + $ gcloud database-migration conversion-workspaces create \ + my-conversion-workspace --region=us-central1 \ + --display-name=cw1 --source-database-engine=ORACLE \ + --source-database-version=11 \ + --destination-database-engine=POSTGRESQL \ + --destination-database-version=8 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to create. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + --destination-database-engine=DESTINATION_DATABASE_ENGINE + Database engine type. DESTINATION_DATABASE_ENGINE must be one of: + MYSQL, POSTGRESQL, SQLSERVER, ORACLE, SPANNER. + + --destination-database-version=DESTINATION_DATABASE_VERSION + Version number for the database engine. + + --source-database-engine=SOURCE_DATABASE_ENGINE + Database engine type. SOURCE_DATABASE_ENGINE must be one of: MYSQL, + POSTGRESQL, SQLSERVER, ORACLE, SPANNER. + + --source-database-version=SOURCE_DATABASE_VERSION + Version number for the database engine. + +OPTIONAL FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --display-name=DISPLAY_NAME + A user-friendly name for the conversion workspace. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. + + --global-settings=[KEY=VALUE,...] + A generic list of settings for the workspace. The settings are database + pair dependant and can indicate default behavior for the mapping rules + engine or turn on or off specific features. An object containing a list + of "key": "value" pairs. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/delete b/gcloud/database-migration/conversion-workspaces/delete new file mode 100644 index 000000000..b1256dd34 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/delete @@ -0,0 +1,56 @@ +NAME + gcloud database-migration conversion-workspaces delete - delete a Database + Migration conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces delete + (CONVERSION_WORKSPACE : --region=REGION) [--no-async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Database Migration conversion workspace + +EXAMPLES + To delete a conversion workspace called 'my-conversion-workspace', run: + + $ gcloud database-migration conversion-workspaces delete \ + my-conversion-workspace --region=us-central1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --no-async + Waits for the operation in progress to complete before returning. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/describe b/gcloud/database-migration/conversion-workspaces/describe new file mode 100644 index 000000000..935c1d7cc --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/describe @@ -0,0 +1,55 @@ +NAME + gcloud database-migration conversion-workspaces describe - show details + about a database migration conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces describe + (CONVERSION_WORKSPACE : --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about a conversion workspace. + +EXAMPLES + To show details about a conversion workspace, run: + + $ gcloud database-migration conversion-workspaces describe \ + my-conversion-workspace --region=us-central1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace you want to get + the details of. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region. To set the region attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region 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 datamigration/v1 API. The full documentation for this + API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/describe-entities b/gcloud/database-migration/conversion-workspaces/describe-entities new file mode 100644 index 000000000..b85e4c909 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/describe-entities @@ -0,0 +1,78 @@ +NAME + gcloud database-migration conversion-workspaces describe-entities - + describe database entities in the conversion workspaces + +SYNOPSIS + gcloud database-migration conversion-workspaces describe-entities + (CONVERSION_WORKSPACE : --region=REGION) --tree-type=TREE_TYPE + [--commit-id=COMMIT_ID] [--filter-string=FILTER_STRING] [--uncommitted] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe database entities (SOURCE/DRAFT/DESTINATION) in the conversion + workspaces. + +EXAMPLES + To describe the source entities in a conversion workspaces in a project and + location us-central1, run: + + $ gcloud database-migration conversion-workspaces \ + describe-entities my-conversion-workspace --region=us-central1 \ + --tree-type=SOURCE + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace you want to get + the details of. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region. To set the region attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + --tree-type=TREE_TYPE + The type of tree to return. TREE_TYPE must be one of: + db-tree-type-unspecified, destination-tree, draft-tree, source-tree. + +OPTIONAL FLAGS + --commit-id=COMMIT_ID + Request a specific commit id. If not specified, the entities from the + latest commit are returned. + + --filter-string=FILTER_STRING + Filter the returned entities based on AIP-160 standard. + + --uncommitted + Whether to retrieve the latest committed version of the entities or the + latest version. This field is ignored if a specific commit_id is + specified. + +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 datamigration/v1 API. The full documentation for this + API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/help b/gcloud/database-migration/conversion-workspaces/help new file mode 100644 index 000000000..1776c096a --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/help @@ -0,0 +1,54 @@ +NAME + gcloud database-migration conversion-workspaces - manage Database Migration + Service conversion workspaces + +SYNOPSIS + gcloud database-migration conversion-workspaces COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing Database Migration Service conversion workspaces. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + apply + Apply a Database Migration Service conversion workspace. + + commit + Commit a Database Migration Service conversion workspace. + + convert + Convert a Database Migration Service conversion workspace. + + create + Create a Database Migration Service conversion workspace. + + delete + Delete a Database Migration conversion workspace. + + describe + Show details about a database migration conversion workspace. + + describe-entities + Describe database entities in the conversion workspaces. + + list + List conversion workspaces. + + list-background-jobs + List background jobs in the conversion workspaces. + + rollback + Rollback a Database Migration Service conversion workspace. + + seed + Seed a Database Migration Service conversion workspace. + + update + Update a Database Migration Service conversion workspace. diff --git a/gcloud/database-migration/conversion-workspaces/list b/gcloud/database-migration/conversion-workspaces/list new file mode 100644 index 000000000..557f1b432 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/list @@ -0,0 +1,79 @@ +NAME + gcloud database-migration conversion-workspaces list - list conversion + workspaces + +SYNOPSIS + gcloud database-migration conversion-workspaces list --region=REGION + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List conversion workspaces. + +EXAMPLES + To list all conversion workspaces in a project and location us-central1, + run: + + $ gcloud database-migration conversion-workspaces list \ + --region=us-central1 + +REQUIRED FLAGS + Region resource - The region you want to list the conversion workspaces + for. 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; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + --region=REGION + ID of the region or fully qualified identifier for the region. To set + the region attribute: + ▸ provide the argument --region 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 datamigration/v1 API. The full documentation for this + API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/list-background-jobs b/gcloud/database-migration/conversion-workspaces/list-background-jobs new file mode 100644 index 000000000..d724ef07e --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/list-background-jobs @@ -0,0 +1,67 @@ +NAME + gcloud database-migration conversion-workspaces list-background-jobs - list + background jobs in the conversion workspaces + +SYNOPSIS + gcloud database-migration conversion-workspaces list-background-jobs + (CONVERSION_WORKSPACE : --region=REGION) [--max-size=MAX_SIZE] + [--most-recent-per-job-type] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List background jobs in the conversion workspaces. + +EXAMPLES + To list the background jobs in a conversion workspaces in a project and + location us-central1, run: + + $ gcloud database-migration conversion-workspaces \ + list-background-jobs my-conversion-workspace \ + --region=us-central1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace you want to get + the details of. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region. To set the region attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --max-size=MAX_SIZE + The maximum number of jobs to return. The service may return fewer than + this value. If unspecified, at most 100 jobs will be returned. The + maximum value is 100; values above 100 will be coerced to 100. + + --most-recent-per-job-type + Returns only the most recent job per job type. + +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 datamigration/v1 API. The full documentation for this + API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/conversion-workspaces/rollback b/gcloud/database-migration/conversion-workspaces/rollback new file mode 100644 index 000000000..a884b82d9 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/rollback @@ -0,0 +1,56 @@ +NAME + gcloud database-migration conversion-workspaces rollback - rollback a + Database Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces rollback + (CONVERSION_WORKSPACE : --region=REGION) [--no-async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Rollback a Database Migration Service conversion workspace. + +EXAMPLES + To rollback a conversion workspace: + + $ gcloud database-migration conversion-workspaces rollback \ + my-conversion-workspace --region=us-central1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to rollback. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --no-async + Waits for the operation in progress to complete before returning. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/seed b/gcloud/database-migration/conversion-workspaces/seed new file mode 100644 index 000000000..ba83e225d --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/seed @@ -0,0 +1,101 @@ +NAME + gcloud database-migration conversion-workspaces seed - seed a Database + Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces seed + (CONVERSION_WORKSPACE : --region=REGION) + (--destination-connection-profile=DESTINATION_CONNECTION_PROFILE + | --source-connection-profile=SOURCE_CONNECTION_PROFILE) [--no-async] + [--auto-commit] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Seed a Database Migration Service conversion workspace. + +EXAMPLES + To seed a conversion workspace: + + $ gcloud database-migration conversion-workspaces seed \ + my-conversion-workspace --region=us-central1 \ + --source-connection-profile=cp1 + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to seed. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + Connection profile resource - The connection profile to seed from. 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 --destination-connection-profile on the + command line with a fully specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the region attribute: + ▸ provide the argument --destination-connection-profile on the + command line with a fully specified name; + ▸ provide the argument --region on the command line. + + --destination-connection-profile=DESTINATION_CONNECTION_PROFILE + ID of the connection_profile or fully qualified identifier for the + connection_profile. To set the connection_profile attribute: + ▫ provide the argument --destination-connection-profile on the + command line. + + Connection profile resource - The connection profile to seed from. 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 --source-connection-profile on the command + line with a fully specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. To set the region attribute: + ▸ provide the argument --source-connection-profile on the command + line with a fully specified name; + ▸ provide the argument --region on the command line. + + --source-connection-profile=SOURCE_CONNECTION_PROFILE + ID of the connection_profile or fully qualified identifier for the + connection_profile. To set the connection_profile attribute: + ▫ provide the argument --source-connection-profile on the command + line. + +OPTIONAL FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --auto-commit + Auto commits the conversion workspace. + +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. diff --git a/gcloud/database-migration/conversion-workspaces/update b/gcloud/database-migration/conversion-workspaces/update new file mode 100644 index 000000000..a3791c4e8 --- /dev/null +++ b/gcloud/database-migration/conversion-workspaces/update @@ -0,0 +1,62 @@ +NAME + gcloud database-migration conversion-workspaces update - update a Database + Migration Service conversion workspace + +SYNOPSIS + gcloud database-migration conversion-workspaces update + (CONVERSION_WORKSPACE : --region=REGION) [--no-async] + [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Database Migration Service conversion workspace. + +EXAMPLES + To update a conversion workspace: + + $ gcloud database-migration conversion-workspaces update \ + my-conversion-workspace --region=us-central1 \ + --display-name=new-display-name + +POSITIONAL ARGUMENTS + Conversion workspace resource - The conversion workspace to update. 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 conversion_workspace 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. + + CONVERSION_WORKSPACE + ID of the conversion_workspace or fully qualified identifier for the + conversion_workspace. To set the conversion_workspace attribute: + ▸ provide the argument conversion_workspace 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 conversion_workspace. To set the region + attribute: + ▸ provide the argument conversion_workspace on the command line + with a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --display-name=DISPLAY_NAME + A user-friendly name for the conversion workspace. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. + +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. diff --git a/gcloud/database-migration/help b/gcloud/database-migration/help index ca24c3fef..ba0e60610 100644 --- a/gcloud/database-migration/help +++ b/gcloud/database-migration/help @@ -18,12 +18,18 @@ GROUPS connection-profiles Manage Database Migration Service connection profiles. + conversion-workspaces + Manage Database Migration Service conversion workspaces. + migration-jobs Manage Database Migration Service migration jobs. operations Manage Database Migration Service operations. + private-connections + Manage Database Migration Service private connections. + NOTES This variant is also available: diff --git a/gcloud/database-migration/private-connections/create b/gcloud/database-migration/private-connections/create new file mode 100644 index 000000000..c7d0be973 --- /dev/null +++ b/gcloud/database-migration/private-connections/create @@ -0,0 +1,94 @@ +NAME + gcloud database-migration private-connections create - create a Database + Migration private connection + +SYNOPSIS + gcloud database-migration private-connections create + (PRIVATE_CONNECTION : --region=REGION) --display-name=DISPLAY_NAME + (--subnet=SUBNET --vpc=VPC) [--no-async] [--labels=[KEY=VALUE,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Database Migration private connection + +EXAMPLES + To create a privateConnection called 'my-privateConnection', run: + + $ gcloud database-migration private-connections create \ + my-privateConnection --region=us-central1 \ + --display-name=my-privateConnection --vpc=vpc-example \ + --subnet=10.0.0.0/29 + +POSITIONAL ARGUMENTS + Private connection resource - The private connection to create. 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 private_connection 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. + + PRIVATE_CONNECTION + ID of the private_connection or fully qualified identifier for the + private_connection. To set the private_connection attribute: + ▸ provide the argument private_connection 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 private_connection. To set the region + attribute: + ▸ provide the argument private_connection on the command line with + a fully specified name; + ▸ provide the argument --region on the command line. + +REQUIRED FLAGS + --display-name=DISPLAY_NAME + Friendly name for the private connection. + + This must be specified. + + --subnet=SUBNET + A free subnet for peering. (CIDR of /29). + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Vpc resource - Resource ID of the private connection. 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 --vpc 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. + + --vpc=VPC + ID of the vpc or fully qualified identifier for the vpc. To set the + vpc attribute: + ▫ provide the argument --vpc on the command line. + +OPTIONAL FLAGS + --no-async + Waits for the operation in progress to complete before returning. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + +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. diff --git a/gcloud/database-migration/private-connections/delete b/gcloud/database-migration/private-connections/delete new file mode 100644 index 000000000..b31b7ee10 --- /dev/null +++ b/gcloud/database-migration/private-connections/delete @@ -0,0 +1,56 @@ +NAME + gcloud database-migration private-connections delete - delete a Database + Migration private connection + +SYNOPSIS + gcloud database-migration private-connections delete + (PRIVATE_CONNECTION : --region=REGION) [--no-async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Database Migration private connection + +EXAMPLES + To delete a privateConnection called 'my-privateConnection', run: + + $ gcloud database-migration private-connections delete \ + my-privateConnection --region=us-central1 + +POSITIONAL ARGUMENTS + Private connection resource - The private connection 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 private_connection 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. + + PRIVATE_CONNECTION + ID of the private_connection or fully qualified identifier for the + private_connection. To set the private_connection attribute: + ▸ provide the argument private_connection 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 private_connection. To set the region + attribute: + ▸ provide the argument private_connection on the command line with + a fully specified name; + ▸ provide the argument --region on the command line. + +FLAGS + --no-async + Waits for the operation in progress to complete before returning. + +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. diff --git a/gcloud/database-migration/private-connections/describe b/gcloud/database-migration/private-connections/describe new file mode 100644 index 000000000..03632aa89 --- /dev/null +++ b/gcloud/database-migration/private-connections/describe @@ -0,0 +1,55 @@ +NAME + gcloud database-migration private-connections describe - show details about + a database migration private connection + +SYNOPSIS + gcloud database-migration private-connections describe + (PRIVATE_CONNECTION : --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about a private connection. + +EXAMPLES + To show details about a private connection, run: + + $ gcloud database-migration private-connections describe \ + my-private-connection --region=us-central1 + +POSITIONAL ARGUMENTS + Private connection resource - The private connection you want to get the + details of. 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 private_connection 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. + + PRIVATE_CONNECTION + ID of the private_connection or fully qualified identifier for the + private_connection. To set the private_connection attribute: + ▸ provide the argument private_connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The name of the region. To set the region attribute: + ▸ provide the argument private_connection on the command line with + a fully specified name; + ▸ provide the argument --region 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 datamigration/v1 API. The full documentation for this + API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/database-migration/private-connections/help b/gcloud/database-migration/private-connections/help new file mode 100644 index 000000000..02b77f750 --- /dev/null +++ b/gcloud/database-migration/private-connections/help @@ -0,0 +1,30 @@ +NAME + gcloud database-migration private-connections - manage Database Migration + Service private connections + +SYNOPSIS + gcloud database-migration private-connections COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing Database Migration Service private connections. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Database Migration private connection. + + delete + Delete a Database Migration private connection. + + describe + Show details about a database migration private connection. + + list + List private connections. diff --git a/gcloud/database-migration/private-connections/list b/gcloud/database-migration/private-connections/list new file mode 100644 index 000000000..f550b9610 --- /dev/null +++ b/gcloud/database-migration/private-connections/list @@ -0,0 +1,79 @@ +NAME + gcloud database-migration private-connections list - list private + connections + +SYNOPSIS + gcloud database-migration private-connections list --region=REGION + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List private connections. + +EXAMPLES + To list all private connections in a project and location 'us-central1', + run: + + $ gcloud database-migration private-connections list \ + --region=us-central1 + +REQUIRED FLAGS + Region resource - The region you want to list the private connections for. + 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; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + --region=REGION + ID of the region or fully qualified identifier for the region. To set + the region attribute: + ▸ provide the argument --region 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 datamigration/v1 API. The full documentation for this + API can be found at: https://cloud.google.com/database-migration/ diff --git a/gcloud/dataproc/clusters/create b/gcloud/dataproc/clusters/create index ae5ee1058..d7f3e5ce1 100644 --- a/gcloud/dataproc/clusters/create +++ b/gcloud/dataproc/clusters/create @@ -718,8 +718,9 @@ FLAGS --metric-sources=[METRIC_SOURCES,...] Specifies a list of Metric Sources to collect custom metrics from the - cluster. METRIC_SOURCES must be one of: HDFS, HIVESERVER2, - MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, YARN. + cluster. METRIC_SOURCES must be one of: HDFS, HIVEMETASTORE, + HIVESERVER2, MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, + YARN. At most one of these can be specified: diff --git a/gcloud/dataproc/jobs/kill b/gcloud/dataproc/jobs/kill index c3264cea8..7aca73172 100644 --- a/gcloud/dataproc/jobs/kill +++ b/gcloud/dataproc/jobs/kill @@ -2,7 +2,8 @@ NAME gcloud dataproc jobs kill - kill an active job SYNOPSIS - gcloud dataproc jobs kill (JOB : --region=REGION) [GCLOUD_WIDE_FLAG ...] + gcloud dataproc jobs kill (JOB : --region=REGION) [--async] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Kill an active job. @@ -43,6 +44,11 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property dataproc/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, diff --git a/gcloud/dataproc/jobs/submit/help b/gcloud/dataproc/jobs/submit/help index 4fce33d35..a668ada4a 100644 --- a/gcloud/dataproc/jobs/submit/help +++ b/gcloud/dataproc/jobs/submit/help @@ -86,6 +86,9 @@ COMMANDS spark-sql Submit a Spark SQL job to a cluster. + trino + Submit a Trino job to a cluster. + NOTES These variants are also available: diff --git a/gcloud/dataproc/jobs/submit/trino b/gcloud/dataproc/jobs/submit/trino new file mode 100644 index 000000000..110c6a3a7 --- /dev/null +++ b/gcloud/dataproc/jobs/submit/trino @@ -0,0 +1,134 @@ +NAME + gcloud dataproc jobs submit trino - submit a Trino job to a cluster + +SYNOPSIS + gcloud dataproc jobs submit trino + (--cluster=CLUSTER | --cluster-labels=[KEY=VALUE,...]) + (--execute=QUERY, -e QUERY | --file=FILE, -f FILE) [--async] + [--bucket=BUCKET] [--client-tags=[CLIENT_TAG,...]] + [--continue-on-failure] [--driver-log-levels=[PACKAGE=LEVEL,...]] + [--labels=[KEY=VALUE,...]] + [--max-failures-per-hour=MAX_FAILURES_PER_HOUR] + [--max-failures-total=MAX_FAILURES_TOTAL] + [--properties=[PARAM=VALUE,...]] [--properties-file=PROPERTIES_FILE] + [--query-output-format=QUERY_OUTPUT_FORMAT] [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Submit a Trino job to a cluster + +EXAMPLES + To submit a Trino job with a local script, run: + + $ gcloud dataproc jobs submit trino --cluster=my-cluster \ + --file=my_script.R + + To submit a Trino job with inline queries, run: + + $ gcloud dataproc jobs submit trino --cluster=my-cluster \ + -e="SELECT * FROM foo WHERE bar > 2" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --cluster=CLUSTER + The Dataproc cluster to submit the job to. + + --cluster-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + Labels of Dataproc cluster on which to place the job. + + Exactly one of these must be specified: + + --execute=QUERY, -e QUERY + A Trino query to execute. + + --file=FILE, -f FILE + HCFS URI of file containing the Trino script to execute. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --bucket=BUCKET + The Cloud Storage bucket to stage files in. Defaults to the cluster's + configured bucket. + + --client-tags=[CLIENT_TAG,...] + A list of Trino client tags to attach to this query. + + --continue-on-failure + Whether to continue if a query fails. + + --driver-log-levels=[PACKAGE=LEVEL,...] + A list of package-to-log4j log level pairs to configure driver logging. + For example: root=FATAL,com.example=INFO + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --max-failures-per-hour=MAX_FAILURES_PER_HOUR + Specifies the maximum number of times a job can be restarted per hour + in event of failure. Default is 0 (no retries after job failure). + + --max-failures-total=MAX_FAILURES_TOTAL + Specifies the maximum total number of times a job can be restarted + after the job fails. Default is 0 (no retries after job failure). + + --properties=[PARAM=VALUE,...] + A list of key value pairs to set Trino session properties. + + --properties-file=PROPERTIES_FILE + Path to a local file or a file in a Cloud Storage bucket containing + configuration properties for the job. The client machine running this + command must have read permission to the file. + + Specify properties in the form of property=value in the text file. For + example: + + # Properties to set for the job: + key1=value1 + key2=value2 + # Comment out properties not used. + # key3=value3 + + If a property is set in both --properties and --properties-file, the + value defined in --properties takes precedence. + + --query-output-format=QUERY_OUTPUT_FORMAT + The query output display format. See the Trino documentation for + supported output formats. + + --region=REGION + Dataproc region to use. Each Dataproc region constitutes an independent + resource namespace constrained to deploying instances into Compute + Engine zones inside the region. Overrides the default dataproc/region + property value for this command invocation. + +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 dataproc jobs submit trino + + $ gcloud beta dataproc jobs submit trino + diff --git a/gcloud/dataproc/workflow-templates/add-job/help b/gcloud/dataproc/workflow-templates/add-job/help index c946a0128..91b1c00c9 100644 --- a/gcloud/dataproc/workflow-templates/add-job/help +++ b/gcloud/dataproc/workflow-templates/add-job/help @@ -68,6 +68,9 @@ COMMANDS spark-sql Add a SparkSql job to the workflow template. + trino + Add a Trino job to the workflow template. + NOTES These variants are also available: diff --git a/gcloud/dataproc/workflow-templates/add-job/trino b/gcloud/dataproc/workflow-templates/add-job/trino new file mode 100644 index 000000000..3a76bf459 --- /dev/null +++ b/gcloud/dataproc/workflow-templates/add-job/trino @@ -0,0 +1,130 @@ +NAME + gcloud dataproc workflow-templates add-job trino - add a Trino job to the + workflow template + +SYNOPSIS + gcloud dataproc workflow-templates add-job trino --step-id=STEP_ID + (--execute=QUERY, -e QUERY | --file=FILE, -f FILE) + (--workflow-template=WORKFLOW_TEMPLATE : --region=REGION) + [--client-tags=[CLIENT_TAG,...]] [--continue-on-failure] + [--driver-log-levels=[PACKAGE=LEVEL,...]] [--labels=[KEY=VALUE,...]] + [--properties=[PARAM=VALUE,...]] [--properties-file=PROPERTIES_FILE] + [--query-output-format=QUERY_OUTPUT_FORMAT] + [--start-after=STEP_ID,[STEP_ID,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Add a Trino job to the workflow template. + +EXAMPLES + To add a Trino job that executes 'QUERY' to the workflow template + 'my-workflow-template' in the 'us-central1' region with 'my-step-id', + + run: + + $ gcloud dataproc workflow-templates add-job trino \ + --step-id=my-step_id -e=QUERY \ + --workflow-template=my-workflow-template --region=us-central1 + +REQUIRED FLAGS + --step-id=STEP_ID + The step ID of the job in the workflow template. + + Exactly one of these must be specified: + + --execute=QUERY, -e QUERY + A Trino query to execute. + + --file=FILE, -f FILE + HCFS URI of file containing the Trino script to execute. + + Template resource - The name of the workflow template to add job to. 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 --workflow-template 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. + + --workflow-template=WORKFLOW_TEMPLATE + ID of the template or fully qualified identifier for the template. To + set the template attribute: + ▸ provide the argument --workflow-template on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --region=REGION + Dataproc region for the template. Each Dataproc region constitutes an + independent resource namespace constrained to deploying instances + into Compute Engine zones inside the region. Overrides the default + dataproc/region property value for this command invocation. To set + the region attribute: + ▸ provide the argument --workflow-template on the command line with + a fully specified name; + ▸ provide the argument --region on the command line; + ▸ set the property dataproc/region. + +OPTIONAL FLAGS + --client-tags=[CLIENT_TAG,...] + A list of Trino client tags to attach to this query. + + --continue-on-failure + Whether to continue if a query fails. + + --driver-log-levels=[PACKAGE=LEVEL,...] + A list of package-to-log4j log level pairs to configure driver logging. + For example: root=FATAL,com.example=INFO + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --properties=[PARAM=VALUE,...] + A list of key value pairs to set Trino session properties. + + --properties-file=PROPERTIES_FILE + Path to a local file or a file in a Cloud Storage bucket containing + configuration properties for the job. The client machine running this + command must have read permission to the file. + + Specify properties in the form of property=value in the text file. For + example: + + # Properties to set for the job: + key1=value1 + key2=value2 + # Comment out properties not used. + # key3=value3 + + If a property is set in both --properties and --properties-file, the + value defined in --properties takes precedence. + + --query-output-format=QUERY_OUTPUT_FORMAT + The query output display format. See the Trino documentation for + supported output formats. + + --start-after=STEP_ID,[STEP_ID,...] + (Optional) List of step IDs to start this job after. + +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 dataproc workflow-templates add-job trino + + $ gcloud beta dataproc workflow-templates add-job trino + diff --git a/gcloud/dataproc/workflow-templates/set-managed-cluster b/gcloud/dataproc/workflow-templates/set-managed-cluster index e6ba29453..a3ce3f2e9 100644 --- a/gcloud/dataproc/workflow-templates/set-managed-cluster +++ b/gcloud/dataproc/workflow-templates/set-managed-cluster @@ -652,8 +652,9 @@ FLAGS --metric-sources=[METRIC_SOURCES,...] Specifies a list of Metric Sources to collect custom metrics from the - cluster. METRIC_SOURCES must be one of: HDFS, HIVESERVER2, - MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, YARN. + cluster. METRIC_SOURCES must be one of: HDFS, HIVEMETASTORE, + HIVESERVER2, MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, + YARN. At most one of these can be specified: diff --git a/gcloud/deploy/releases/create b/gcloud/deploy/releases/create index fe55a919a..01a262241 100644 --- a/gcloud/deploy/releases/create +++ b/gcloud/deploy/releases/create @@ -10,7 +10,9 @@ SYNOPSIS [--ignore-file=IGNORE_FILE] [--labels=[KEY=VALUE,...]] [--skaffold-version=SKAFFOLD_VERSION] [--to-target=TO_TARGET] [--build-artifacts=BUILD_ARTIFACTS | --images=[NAME=TAG,...]] - [--disable-initial-rollout | --enable-initial-rollout] + [--disable-initial-rollout | --enable-initial-rollout + --initial-rollout-annotations=[KEY=VALUE,...] + --initial-rollout-labels=[KEY=VALUE,...]] [--from-k8s-manifest=FROM_K8S_MANIFEST | --from-run-manifest=FROM_RUN_MANIFEST | --skaffold-file=SKAFFOLD_FILE --source=SOURCE; default="."] @@ -159,6 +161,28 @@ FLAGS Creates a rollout in the first target defined in the delivery pipeline. This is the default behavior. + --initial-rollout-annotations=[KEY=VALUE,...] + Annotations to apply to the initial rollout when creating the + release. Annotations take the form of key/value string pairs. + + Examples: + + Add annotations: + + $ gcloud deploy releases create \ + --initial-rollout-annotations="from_target=test,status=stable" + + --initial-rollout-labels=[KEY=VALUE,...] + Labels to apply to the initial rollout when creating the release. + Labels take the form of key/value string pairs. + + Examples: + + Add labels: + + $ gcloud deploy releases create \ + initial-rollout-labels="commit=abc123,author=foo" + At most one of these can be specified: --from-k8s-manifest=FROM_K8S_MANIFEST diff --git a/gcloud/dns/record-sets/create b/gcloud/dns/record-sets/create index 94c57239c..7a2621652 100644 --- a/gcloud/dns/record-sets/create +++ b/gcloud/dns/record-sets/create @@ -117,7 +117,7 @@ REQUIRED FLAGS For --routing-policy-type = "WRR" this flag indicates the weighted round robin policy data. The field accepts a semicolon-delimited list of the format - "${weight_percent}:${rrdata},${rrdata}". Specify weight as a + "${weight_percent}=${rrdata},${rrdata}". Specify weight as a non-negative number (0 is allowed). Ratio of traffic routed to the target is calculated from the ratio of individual weight over the total across all weights. @@ -125,7 +125,7 @@ REQUIRED FLAGS For --routing-policy-type = "GEO" this flag indicates the geo-locations policy data. The field accepts a semicolon-delimited list of the format - "${region}:${rrdata},${rrdata}". Each individual rrdata can + "${region}=${rrdata},${rrdata}". Each individual rrdata can either be an ip address or a string of the format forwarding_config_name@region. diff --git a/gcloud/dns/record-sets/update b/gcloud/dns/record-sets/update index 3a6ea4e4f..1d05408c9 100644 --- a/gcloud/dns/record-sets/update +++ b/gcloud/dns/record-sets/update @@ -85,7 +85,7 @@ REQUIRED FLAGS For --routing-policy-type = "WRR" this flag indicates the weighted round robin policy data. The field accepts a semicolon-delimited list of the format - "${weight_percent}:${rrdata},${rrdata}". Specify weight as a + "${weight_percent}=${rrdata},${rrdata}". Specify weight as a non-negative number (0 is allowed). Ratio of traffic routed to the target is calculated from the ratio of individual weight over the total across all weights. @@ -93,7 +93,7 @@ REQUIRED FLAGS For --routing-policy-type = "GEO" this flag indicates the geo-locations policy data. The field accepts a semicolon-delimited list of the format - "${region}:${rrdata},${rrdata}". Each individual rrdata can + "${region}=${rrdata},${rrdata}". Each individual rrdata can either be an ip address or a string of the format forwarding_config_name@region. diff --git a/gcloud/edge-cache/help b/gcloud/edge-cache/help new file mode 100644 index 000000000..107af823f --- /dev/null +++ b/gcloud/edge-cache/help @@ -0,0 +1,55 @@ +NAME + gcloud edge-cache - manage Media CDN resources + +SYNOPSIS + gcloud edge-cache GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Media CDN resources. + +EXAMPLES + To list EdgeCacheService resources in the active Cloud Platform project, + run: + + $ gcloud edge-cache services list + + To create an EdgeCacheOrigin resource named 'my-origin' that points to a + Cloud Storage bucket, run: + + $ gcloud edge-cache origins create my-origin \ + --origin-address="gs://bucket" + + To import an EdgeCacheService resource configuration from a YAML + definition, run: + + $ gcloud edge-cache services import my-service --source=config.yaml + + To describe an EdgeCacheKeyset resource named 'my-keyset', run: + + $ gcloud edge-cache keysets describe my-keyset + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + keysets + Interact with and manage EdgeCacheKeyset resources. + + operations + Manage EdgeCache operations. + + origins + Interact with and manage EdgeCacheOrigin resources. + + services + Interact with and manage EdgeCacheService resources. + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache + diff --git a/gcloud/edge-cache/keysets/create b/gcloud/edge-cache/keysets/create new file mode 100644 index 000000000..f8a9d0d75 --- /dev/null +++ b/gcloud/edge-cache/keysets/create @@ -0,0 +1,120 @@ +NAME + gcloud edge-cache keysets create - create an EdgeCacheKeyset resource + +SYNOPSIS + gcloud edge-cache keysets create (KEYSET : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--labels=KEY=VALUE] + [--public-key=PUBLIC_KEY] + [--validation-shared-key=VALIDATION_SHARED_KEY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new EdgeCacheKeyset resource. + +EXAMPLES + To create an EdgeCacheKeyset resource called 'my-keyset', run: + + $ gcloud edge-cache keysets create my-keyset \ + --public-key='id=KEYID,value=BASE64PUBLICKEY' + +POSITIONAL ARGUMENTS + Keyset resource - The name of the EdgeCacheKeyset resource to create. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --public-key=PUBLIC_KEY + Set of public keys to use for validating signed requests, when + associated with a route. This flag can be repeated to create a Keyset + with multiple public keys. + + If you are providing your own public keys, specify the key in the form + id=ID,value=BASE64ENCODEDPUBLICKEY. + + If you are using Google-managed public keys as part of a dual-token + setup, specify the key in the form id=ID,managed=true. + + id + id (name) name of the key within the keyset. + + value + URL-safe base64 encoded public key. Cannot be specified if + managed=true. + + managed + Boolean indicating this is a Google-managed key. Cannot be + specified if value=true. + + To create a public key with id 'foo', pass + --public-key='id=foo,value=VALUE' to gcloud edge-cache keysets create. + + To create a Google-managed public key with id 'bar', pass + --public-key='id=foo,managed=true' to gcloud edge-cache keysets create. + + At least one of public-key or validation-shared-key must be specified. + + --validation-shared-key=VALIDATION_SHARED_KEY + An ordered list of shared keys to use for validating signed requests. + + To create a validation shared key pointing to a Secret Manager secret + version with name projects/PROJECT/secrets/SECRET/versions/VERSION, + pass + --validation-shared-key='secret_version=projects/PROJECT/secrets/SECRET/versions/VERSION' + to gcloud edge-cache keysets create. + + secret_version + The name of the secret in Secret Manager. Must be in the format + projects/PROJECT/secrets/SECRET/versions/VERSION. + + At least one of public-key or validation-shared-key must be specified. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets create + diff --git a/gcloud/edge-cache/keysets/delete b/gcloud/edge-cache/keysets/delete new file mode 100644 index 000000000..09632f3d5 --- /dev/null +++ b/gcloud/edge-cache/keysets/delete @@ -0,0 +1,66 @@ +NAME + gcloud edge-cache keysets delete - delete an EdgeCacheKeyset resource + +SYNOPSIS + gcloud edge-cache keysets delete (KEYSET : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an EdgeCacheKeyset resource. + +EXAMPLES + To delete an EdgeCacheKeyset resource called 'my-keyset', run: + + $ gcloud edge-cache keysets delete my-keyset + +POSITIONAL ARGUMENTS + Keyset resource - The name of the EdgeCacheKeyset resource 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets delete + diff --git a/gcloud/edge-cache/keysets/describe b/gcloud/edge-cache/keysets/describe new file mode 100644 index 000000000..ba9927fee --- /dev/null +++ b/gcloud/edge-cache/keysets/describe @@ -0,0 +1,62 @@ +NAME + gcloud edge-cache keysets describe - show details about an EdgeCacheKeyset + resource + +SYNOPSIS + gcloud edge-cache keysets describe (KEYSET : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about an EdgeCacheKeyset resource. + +EXAMPLES + To show details for an EdgeCacheKeyset resource named 'my-keyset', run: + + $ gcloud edge-cache keysets describe my-keyset + +POSITIONAL ARGUMENTS + Keyset resource - The EdgeCacheKeyset resource 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets describe + diff --git a/gcloud/edge-cache/keysets/export b/gcloud/edge-cache/keysets/export new file mode 100644 index 000000000..d1c3e24fe --- /dev/null +++ b/gcloud/edge-cache/keysets/export @@ -0,0 +1,70 @@ +NAME + gcloud edge-cache keysets export - export an EdgeCacheKeyset resource + +SYNOPSIS + gcloud edge-cache keysets export (KEYSET : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Export an EdgeCacheKeyset resource to YAML. + +EXAMPLES + To export an EdgeCacheKeyset resourced named 'my-keyset', run: + + $ gcloud edge-cache keysets export my-keyset \ + --destination=keyset.yaml + +POSITIONAL ARGUMENTS + Keyset resource - The EdgeCacheKeyset resource you want to export. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets export + diff --git a/gcloud/edge-cache/keysets/help b/gcloud/edge-cache/keysets/help new file mode 100644 index 000000000..8fe3a99d1 --- /dev/null +++ b/gcloud/edge-cache/keysets/help @@ -0,0 +1,44 @@ +NAME + gcloud edge-cache keysets - interact with and manage EdgeCacheKeyset + resources + +SYNOPSIS + gcloud edge-cache keysets COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Interact with and manage EdgeCacheKeyset resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create an EdgeCacheKeyset resource. + + delete + Delete an EdgeCacheKeyset resource. + + describe + Show details about an EdgeCacheKeyset resource. + + export + Export an EdgeCacheKeyset resource. + + import + Import an EdgeCacheKeyset resource. + + list + List EdgeCacheKeyset resources. + + update + Update an EdgeCacheKeyset resource. + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets + diff --git a/gcloud/edge-cache/keysets/import b/gcloud/edge-cache/keysets/import new file mode 100644 index 000000000..85dac1c52 --- /dev/null +++ b/gcloud/edge-cache/keysets/import @@ -0,0 +1,86 @@ +NAME + gcloud edge-cache keysets import - import an EdgeCacheKeyset resource + +SYNOPSIS + gcloud edge-cache keysets import (KEYSET : --location=LOCATION) [--async] + [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import an EdgeCacheKeyset resource. If the named EdgeCacheKeyset resource + already exists, the resource will be updated to match the imported resource + configuration. + + Note: If you are updating an existing EdgeCacheKeyset resource, you should + ensure that it includes any public keys still needed to validate incoming + user requests. + + If the named EdgeCacheKeyset resource does not already exist, a new + EdgeCacheKeyset resource will be created with that name. + +EXAMPLES + To import an EdgeCacheKeyset resource named 'my-keyset' from a YAML file, + run: + + $ gcloud edge-cache keysets import my-keyset --source=my-keyset.yaml + +POSITIONAL ARGUMENTS + Keyset resource - The EdgeCacheKeyset resource you want to import. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets import + diff --git a/gcloud/edge-cache/keysets/list b/gcloud/edge-cache/keysets/list new file mode 100644 index 000000000..251347431 --- /dev/null +++ b/gcloud/edge-cache/keysets/list @@ -0,0 +1,65 @@ +NAME + gcloud edge-cache keysets list - list EdgeCacheKeyset resources + +SYNOPSIS + gcloud edge-cache keysets list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List EdgeCacheKeyset resources. + +EXAMPLES + To list existing EdgeCacheKeyset resources, run: + + $ gcloud edge-cache keysets list + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets list + diff --git a/gcloud/edge-cache/keysets/update b/gcloud/edge-cache/keysets/update new file mode 100644 index 000000000..93e27c134 --- /dev/null +++ b/gcloud/edge-cache/keysets/update @@ -0,0 +1,133 @@ +NAME + gcloud edge-cache keysets update - update an EdgeCacheKeyset resource + +SYNOPSIS + gcloud edge-cache keysets update (KEYSET : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--labels=KEY=VALUE] + [--public-key=PUBLIC_KEY] + [--validation-shared-key=VALIDATION_SHARED_KEY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an existing EdgeCacheKeyset resource. + +EXAMPLES + To update an EdgeCacheKeyset resource called 'my-keyset', run: + + $ gcloud edge-cache keysets update my-keyset \ + --public-key='id=KEYID,value=BASE64PUBLICKEY' + + The update command appends keys to an existing EdgeCacheKeyset resource. To + add more than one key to an EdgeCacheKeyset resource, provide multiple + --public-key values: + + $ gcloud edge-cache keysets update my-keyset \ + --public-key='id=KEYID,value=BASE64PUBLICKEY' \ + --public-key='id=EXISTING,value=EXISTINGPUBLICKEY' + + You can specify, and an EdgeCacheKeyset resource can contain, up to three + (3) public keys. To delete unused public keys within an existing Keyset, + use the import command to specify the EdgeCacheKeyset resource in full, + omitting any unused publicKey items. + +POSITIONAL ARGUMENTS + Keyset resource - The name of the EdgeCacheKeyset resource to update. 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 keyset on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + KEYSET + ID of the keyset or fully qualified identifier for the keyset. To set + the keyset attribute: + ▸ provide the argument keyset on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument keyset on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --public-key=PUBLIC_KEY + Set of public keys to use for validating signed requests, when + associated with a route. This flag can be repeated to create a Keyset + with multiple public keys. + + If you are providing your own public keys, specify the key in the form + id=ID,value=BASE64ENCODEDPUBLICKEY. + + If you are using Google-managed public keys as part of a dual-token + setup, specify the key in the form id=ID,managed=true. + + id + id (name) name of the key within the keyset. + + value + URL-safe base64 encoded public key. Cannot be specified if + managed=true. + + managed + Boolean indicating this is a Google-managed key. Cannot be + specified if value=true. + + To create a public key with id 'foo', pass + --public-key='id=foo,value=VALUE' to gcloud edge-cache keysets update. + + To create a Google-managed public key with id 'bar', pass + --public-key='id=foo,managed=true' to gcloud edge-cache keysets update. + + At least one of public-key or validation-shared-key must be specified. + + --validation-shared-key=VALIDATION_SHARED_KEY + An ordered list of shared keys to use for validating signed requests. + + To create a validation shared key pointing to a Secret Manager secret + version with name projects/PROJECT/secrets/SECRET/versions/VERSION, + pass + --validation-shared-key='secret_version=projects/PROJECT/secrets/SECRET/versions/VERSION' + to gcloud edge-cache keysets update. + + secret_version + The name of the secret in Secret Manager. Must be in the format + projects/PROJECT/secrets/SECRET/versions/VERSION. + + At least one of public-key or validation-shared-key must be specified. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache keysets update + diff --git a/gcloud/edge-cache/operations/describe b/gcloud/edge-cache/operations/describe new file mode 100644 index 000000000..5f74615cf --- /dev/null +++ b/gcloud/edge-cache/operations/describe @@ -0,0 +1,53 @@ +NAME + gcloud edge-cache operations describe - describe a long-running operation + +SYNOPSIS + gcloud edge-cache operations describe OPERATION [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a long-running operation. You can use this to inspect whether a + create or update operation was successful or the operation returned any + errors. + +EXAMPLES + To describe an operation with name simple-operation, run: + + $ gcloud edge-cache operations describe simple-operation + +POSITIONAL ARGUMENTS + Operation resource - operation 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 operation 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 + location attribute: + ◆ provide the argument operation on the command line with a fully + specified name; + ◆ use global location. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation 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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache operations describe + diff --git a/gcloud/edge-cache/operations/help b/gcloud/edge-cache/operations/help new file mode 100644 index 000000000..1ae495924 --- /dev/null +++ b/gcloud/edge-cache/operations/help @@ -0,0 +1,28 @@ +NAME + gcloud edge-cache operations - manage EdgeCache operations + +SYNOPSIS + gcloud edge-cache operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing long-running operations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe a long-running operation. + + list + List long-running operations. + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache operations + diff --git a/gcloud/edge-cache/operations/list b/gcloud/edge-cache/operations/list new file mode 100644 index 000000000..b32309f30 --- /dev/null +++ b/gcloud/edge-cache/operations/list @@ -0,0 +1,65 @@ +NAME + gcloud edge-cache operations list - list long-running operations + +SYNOPSIS + gcloud edge-cache operations list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List long-running operations. + +EXAMPLES + To list all operations, run: + + $ gcloud edge-cache operations list + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache operations list + diff --git a/gcloud/edge-cache/origins/create b/gcloud/edge-cache/origins/create new file mode 100644 index 000000000..f3638129c --- /dev/null +++ b/gcloud/edge-cache/origins/create @@ -0,0 +1,196 @@ +NAME + gcloud edge-cache origins create - create an EdgeCacheOrigin resource + +SYNOPSIS + gcloud edge-cache origins create (ORIGIN : --location=LOCATION) + --origin-address=ORIGIN_ADDRESS [--async] [--description=DESCRIPTION] + [--failover-origin=FAILOVER_ORIGIN] [--labels=KEY=VALUE] + [--max-attempts=MAX_ATTEMPTS] [--port=PORT] [--protocol=PROTOCOL] + [--response-timeout=RESPONSE_TIMEOUT] + [--retry-conditions=[RETRY_CONDITIONS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new EdgeCacheOrigin resource. + +EXAMPLES + To create a EdgeCacheOrigin resource called 'my-origin', run: + + $ gcloud edge-cache origins create my-origin \ + --origin-address="origin.example.com" + +POSITIONAL ARGUMENTS + Origin resource - The name of the EdgeCacheOrigin resource to create. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +REQUIRED FLAGS + --origin-address=ORIGIN_ADDRESS + A fully qualified domain name (FQDN) or IP address reachable over the + public Internet, or the address of a Google Cloud Storage bucket. + + This address will be used as the origin for cache requests - e.g. + ◆ FQDN: media-backend.example.com + ◆ IPv4: 35.218.1.1 + ◆ IPv6: [2607:f8b0:4012:809::200e] + ◆ Cloud Storage: gs://bucketname + + When providing an FQDN (hostname), it must be publicly resolvable (e.g. + via Google public DNS) and IP addresses must be publicly routable. If a + Cloud Storage bucket is provided, it must be in the canonical + "gs://bucketname" format. Other forms, such as + "storage.googleapis.com", will be rejected. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --failover-origin=FAILOVER_ORIGIN + Origin resource to try when the current origin cannot be reached. After + maxAttempts is reached, the configured failoverOrigin will be used to + fulfil the request. + + For example, the following are both valid URLs to an EdgeCacheOrigin + resource: + + ◆ /projects/PROJECT/locations/global/edgeCacheOrigins/yourOrigin + ◆ yourOrigin + + The value of timeout.maxAttemptsTimeout dictates the timeout across all + origins. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --max-attempts=MAX_ATTEMPTS + Maximum number of attempts to cache fill from this origin. Another + attempt is made when a cache fill fails with one of the + retry_conditions. + + Once max_attempts to this origin have failed the failover_origin will + be used, if one is specified. That failover_origin may specify its own + max_attempts, retry_conditions and failover_origin to control its own + cache fill failures. + + The total number of allowed attempts to cache fill across this and + failover origins is limited to four. The total time allowed for cache + fill attempts across this and failover origins can be controlled with + max_attempts_timeout. + + The last valid response from an origin will be returned to the client. + If no origin returns a valid response, an HTTP 503 will be returned to + the client. + + Defaults to 1. Must be a value greater than 0 and less than 4. + + --port=PORT + Port to connect to the origin on. Defaults to port 443 for HTTP2 and + HTTPS protocols, and port 80 for HTTP. + + --protocol=PROTOCOL + Protocol to use to connect to the configured origin. Defaults to HTTP2, + and it is strongly recommended that users use HTTP2 for both security & + performance. + + When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed, + unexpired TLS (SSL) certificate must be presented by the origin server. + + PROTOCOL must be one of: + + http + HTTP without TLS (SSL). This is not recommended, as communication + outside of Google's network will be unencrypted to the public + endpoint (origin). + + http2 + HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS). + Requires a valid (public, unexpired) TLS certificate to be present + on the origin. + + https + HTTP/1.1 with TLS (SSL). Requires a valid (public, unexpired) TLS + certificate to be present on the origin. + + --response-timeout=RESPONSE_TIMEOUT + Maximum duration to wait for data to arrive when reading from the HTTP + connection/stream. + + Defaults to 5 seconds. The timeout must be a value between 1s and 30s. + + --retry-conditions=[RETRY_CONDITIONS,...] + Specifies one or more retry conditions for the configured origin. + + If the failure mode during a connection attempt to the origin matches + the configured retryCondition(s), the origin request will be retried up + to maxAttempts times. The failoverOrigin, if configured, will then be + used to satisfy the request. + + The default retryCondition is "connect-failure". + + retryConditions apply to this origin, and not subsequent + failoverOrigin(s), which may specify their own retryConditions and + maxAttempts. + + Valid values are: + + ◆ connect-failure: Retry on failures connecting to origins, for + example due to connection timeouts. + ◆ http-5xx: Retry if the origin responds with any 5xx response code, + or if the origin does not respond at all, example: disconnects, + reset, read timeout, connection failure, and refused streams. + ◆ gateway-error: Similar to 5xx, but only applies to response codes + 502, 503 or 504. + ◆ retriable-4xx: Retry for retriable 4xx response codes, which + include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests) + ◆ not-found: Retry if the origin returns a HTTP 404 (Not Found). This + can be useful when generating video content, and the segment is not + available yet. + + RETRY_CONDITIONS must be one of: connect-failure, forbidden, + gateway-error, http-5xx, not-found, retriable-4xx, + retry-conditions-unspecified. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins create + diff --git a/gcloud/edge-cache/origins/delete b/gcloud/edge-cache/origins/delete new file mode 100644 index 000000000..40cfbdb40 --- /dev/null +++ b/gcloud/edge-cache/origins/delete @@ -0,0 +1,66 @@ +NAME + gcloud edge-cache origins delete - delete an EdgeCacheOrigin resource + +SYNOPSIS + gcloud edge-cache origins delete (ORIGIN : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a EdgeCacheOrigin resource. + +EXAMPLES + To delete a EdgeCacheOrigin resource called 'my-origin', run: + + $ gcloud edge-cache origins delete my-origin + +POSITIONAL ARGUMENTS + Origin resource - The name of the EdgeCacheOrigin resource 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins delete + diff --git a/gcloud/edge-cache/origins/describe b/gcloud/edge-cache/origins/describe new file mode 100644 index 000000000..2ada41ff8 --- /dev/null +++ b/gcloud/edge-cache/origins/describe @@ -0,0 +1,62 @@ +NAME + gcloud edge-cache origins describe - show details about an EdgeCacheOrigin + resource + +SYNOPSIS + gcloud edge-cache origins describe (ORIGIN : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about an EdgeCacheOrigin resource. + +EXAMPLES + To show details about an EdgeCacheOrigin resource named 'my-origin', run: + + $ gcloud edge-cache origins describe my-origin + +POSITIONAL ARGUMENTS + Origin resource - The EdgeCacheOrigin resource 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins describe + diff --git a/gcloud/edge-cache/origins/export b/gcloud/edge-cache/origins/export new file mode 100644 index 000000000..4363cc487 --- /dev/null +++ b/gcloud/edge-cache/origins/export @@ -0,0 +1,70 @@ +NAME + gcloud edge-cache origins export - export an EdgeCacheOrigin resource + +SYNOPSIS + gcloud edge-cache origins export (ORIGIN : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Export an EdgeCacheOrigin resource to YAML. + +EXAMPLES + To export an EdgeCacheOrigin resource named 'my-origin', run: + + $ gcloud edge-cache origins export my-origin \ + --destination=my-origin.yaml + +POSITIONAL ARGUMENTS + Origin resource - The EdgeCacheOrigin resource you want to export. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins export + diff --git a/gcloud/edge-cache/origins/help b/gcloud/edge-cache/origins/help new file mode 100644 index 000000000..3109b9324 --- /dev/null +++ b/gcloud/edge-cache/origins/help @@ -0,0 +1,44 @@ +NAME + gcloud edge-cache origins - interact with and manage EdgeCacheOrigin + resources + +SYNOPSIS + gcloud edge-cache origins COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Interact with and manage EdgeCacheOrigin resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create an EdgeCacheOrigin resource. + + delete + Delete an EdgeCacheOrigin resource. + + describe + Show details about an EdgeCacheOrigin resource. + + export + Export an EdgeCacheOrigin resource. + + import + Import an EdgeCacheOrigin resource. + + list + List all EdgeCacheOrigin resources in a project. + + update + Update an EdgeCacheOrigin resource. + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins + diff --git a/gcloud/edge-cache/origins/import b/gcloud/edge-cache/origins/import new file mode 100644 index 000000000..f10c343f1 --- /dev/null +++ b/gcloud/edge-cache/origins/import @@ -0,0 +1,82 @@ +NAME + gcloud edge-cache origins import - import an EdgeCacheOrigin resource + +SYNOPSIS + gcloud edge-cache origins import (ORIGIN : --location=LOCATION) [--async] + [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import an EdgeCacheOrigin resource. If the named EdgeCacheOrigin resource + already exists, the resource will be updated to match the imported resource + configuration. + + If the named EdgeCacheOrigin resource does not already exist, a new + EdgeCacheOrigin resource will be created with that name. + +EXAMPLES + To import an EdgeCacheOrigin resource named 'my-origin' from a YAML file, + run: + + $ gcloud edge-cache origins import my-origin --source=my-origin.yaml + +POSITIONAL ARGUMENTS + Origin resource - The EdgeCacheOrigin resource you want to import. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins import + diff --git a/gcloud/edge-cache/origins/list b/gcloud/edge-cache/origins/list new file mode 100644 index 000000000..67bdea7c5 --- /dev/null +++ b/gcloud/edge-cache/origins/list @@ -0,0 +1,66 @@ +NAME + gcloud edge-cache origins list - list all EdgeCacheOrigin resources in a + project + +SYNOPSIS + gcloud edge-cache origins list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List EdgeCacheOrigin resources. + +EXAMPLES + To list existing EdgeCacheOrigin resources, run: + + $ gcloud edge-cache origins list + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins list + diff --git a/gcloud/edge-cache/origins/update b/gcloud/edge-cache/origins/update new file mode 100644 index 000000000..8f955b09a --- /dev/null +++ b/gcloud/edge-cache/origins/update @@ -0,0 +1,195 @@ +NAME + gcloud edge-cache origins update - update an EdgeCacheOrigin resource + +SYNOPSIS + gcloud edge-cache origins update (ORIGIN : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--failover-origin=FAILOVER_ORIGIN] + [--labels=KEY=VALUE] [--max-attempts=MAX_ATTEMPTS] + [--origin-address=ORIGIN_ADDRESS] [--port=PORT] [--protocol=PROTOCOL] + [--response-timeout=RESPONSE_TIMEOUT] + [--retry-conditions=[RETRY_CONDITIONS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an existing EdgeCacheOrigin resource. + +EXAMPLES + To update an EdgeCacheOrigin resource named 'my-origin', run: + + $ gcloud edge-cache origins update my-origin \ + --origin-address=new-origin.example.com + +POSITIONAL ARGUMENTS + Origin resource - The name of the EdgeCacheOrigin resource to create. 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 origin on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + ORIGIN + ID of the origin or fully qualified identifier for the origin. To set + the origin attribute: + ▸ provide the argument origin on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument origin on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --failover-origin=FAILOVER_ORIGIN + Origin resource to try when the current origin cannot be reached. After + maxAttempts is reached, the configured failoverOrigin will be used to + fulfil the request. + + For example, the following are both valid URLs to an EdgeCacheOrigin + resource: + + ◆ /projects/PROJECT/locations/global/edgeCacheOrigins/yourOrigin + ◆ yourOrigin + + The value of timeout.maxAttemptsTimeout dictates the timeout across all + origins. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --max-attempts=MAX_ATTEMPTS + Maximum number of attempts to cache fill from this origin. Another + attempt is made when a cache fill fails with one of the + retry_conditions. + + Once max_attempts to this origin have failed the failover_origin will + be used, if one is specified. That failover_origin may specify its own + max_attempts, retry_conditions and failover_origin to control its own + cache fill failures. + + The total number of allowed attempts to cache fill across this and + failover origins is limited to four. The total time allowed for cache + fill attempts across this and failover origins can be controlled with + max_attempts_timeout. + + The last valid response from an origin will be returned to the client. + If no origin returns a valid response, an HTTP 503 will be returned to + the client. + + Defaults to 1. Must be a value greater than 0 and less than 4. + + --origin-address=ORIGIN_ADDRESS + A fully qualified domain name (FQDN) or IP address reachable over the + public Internet, or the address of a Google Cloud Storage bucket. + + This address will be used as the origin for cache requests - e.g. + ◆ FQDN: media-backend.example.com + ◆ IPv4: 35.218.1.1 + ◆ IPv6: [2607:f8b0:4012:809::200e] + ◆ Cloud Storage: gs://bucketname + + When providing an FQDN (hostname), it must be publicly resolvable (e.g. + via Google public DNS) and IP addresses must be publicly routable. If a + Cloud Storage bucket is provided, it must be in the canonical + "gs://bucketname" format. Other forms, such as + "storage.googleapis.com", will be rejected. + + --port=PORT + Port to connect to the origin on. Defaults to port 443 for HTTP2 and + HTTPS protocols, and port 80 for HTTP. + + --protocol=PROTOCOL + Protocol to use to connect to the configured origin. Defaults to HTTP2, + and it is strongly recommended that users use HTTP2 for both security & + performance. + + When using HTTP2 or HTTPS as the protocol, a valid, publicly-signed, + unexpired TLS (SSL) certificate must be presented by the origin server. + + PROTOCOL must be one of: + + http + HTTP without TLS (SSL). This is not recommended, as communication + outside of Google's network will be unencrypted to the public + endpoint (origin). + + http2 + HTTP/2 protocol. HTTP/2 refers to "h2", which requires TLS (HTTPS). + Requires a valid (public, unexpired) TLS certificate to be present + on the origin. + + https + HTTP/1.1 with TLS (SSL). Requires a valid (public, unexpired) TLS + certificate to be present on the origin. + + --response-timeout=RESPONSE_TIMEOUT + Maximum duration to wait for data to arrive when reading from the HTTP + connection/stream. + + Defaults to 5 seconds. The timeout must be a value between 1s and 30s. + + --retry-conditions=[RETRY_CONDITIONS,...] + Specifies one or more retry conditions for the configured origin. + + If the failure mode during a connection attempt to the origin matches + the configured retryCondition(s), the origin request will be retried up + to maxAttempts times. The failoverOrigin, if configured, will then be + used to satisfy the request. + + The default retryCondition is "connect-failure". + + retryConditions apply to this origin, and not subsequent + failoverOrigin(s), which may specify their own retryConditions and + maxAttempts. + + Valid values are: + + ◆ connect-failure: Retry on failures connecting to origins, for + example due to connection timeouts. + ◆ http-5xx: Retry if the origin responds with any 5xx response code, + or if the origin does not respond at all, example: disconnects, + reset, read timeout, connection failure, and refused streams. + ◆ gateway-error: Similar to 5xx, but only applies to response codes + 502, 503 or 504. + ◆ retriable-4xx: Retry for retriable 4xx response codes, which + include HTTP 409 (Conflict) and HTTP 429 (Too Many Requests) + ◆ not-found: Retry if the origin returns a HTTP 404 (Not Found). This + can be useful when generating video content, and the segment is not + available yet. + + RETRY_CONDITIONS must be one of: connect-failure, forbidden, + gateway-error, http-5xx, not-found, retriable-4xx, + retry-conditions-unspecified. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache origins update + diff --git a/gcloud/edge-cache/services/delete b/gcloud/edge-cache/services/delete new file mode 100644 index 000000000..5ab0da21a --- /dev/null +++ b/gcloud/edge-cache/services/delete @@ -0,0 +1,66 @@ +NAME + gcloud edge-cache services delete - delete an EdgeCacheService resource + +SYNOPSIS + gcloud edge-cache services delete (SERVICE : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an EdgeCacheService resource. + +EXAMPLES + To delete an EdgeCacheService resource named 'my-service', run: + + $ gcloud edge-cache services delete my-service + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services delete + diff --git a/gcloud/edge-cache/services/describe b/gcloud/edge-cache/services/describe new file mode 100644 index 000000000..b0314719c --- /dev/null +++ b/gcloud/edge-cache/services/describe @@ -0,0 +1,62 @@ +NAME + gcloud edge-cache services describe - show details about an + EdgeCacheService resource + +SYNOPSIS + gcloud edge-cache services describe (SERVICE : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about an EdgeCacheService resource. + +EXAMPLES + To show details about an EdgeCacheService resource named 'my-service', run: + + $ gcloud edge-cache services describe my-service + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services describe + diff --git a/gcloud/edge-cache/services/export b/gcloud/edge-cache/services/export new file mode 100644 index 000000000..6fde19cda --- /dev/null +++ b/gcloud/edge-cache/services/export @@ -0,0 +1,70 @@ +NAME + gcloud edge-cache services export - export an EdgeCacheService resource + +SYNOPSIS + gcloud edge-cache services export (SERVICE : --location=LOCATION) + [--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Export an EdgeCacheService resource to YAML. + +EXAMPLES + To export an existing EdgeCacheService resource named 'my-service', run: + + $ gcloud edge-cache services export my-service \ + --destination=my-service.yaml + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource you want to export. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --destination=DESTINATION + Path to a YAML file where the configuration will be exported. The + exported data will not contain any output-only fields. Alternatively, + you may omit this flag to write to standard output. For a schema + describing the export/import format, see + $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services export + diff --git a/gcloud/edge-cache/services/help b/gcloud/edge-cache/services/help new file mode 100644 index 000000000..c9014eee0 --- /dev/null +++ b/gcloud/edge-cache/services/help @@ -0,0 +1,44 @@ +NAME + gcloud edge-cache services - interact with and manage EdgeCacheService + resources + +SYNOPSIS + gcloud edge-cache services COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Interact with and manage EdgeCacheService resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + delete + Delete an EdgeCacheService resource. + + describe + Show details about an EdgeCacheService resource. + + export + Export an EdgeCacheService resource. + + import + Import an EdgeCacheService resource. + + invalidate-cache + Invalidate the cache for an EdgeCacheService resource. + + list + List all EdgeCacheService resources in a project. + + update + Update an EdgeCacheService resource. + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services + diff --git a/gcloud/edge-cache/services/import b/gcloud/edge-cache/services/import new file mode 100644 index 000000000..8f57f7fb6 --- /dev/null +++ b/gcloud/edge-cache/services/import @@ -0,0 +1,83 @@ +NAME + gcloud edge-cache services import - import an EdgeCacheService resource + +SYNOPSIS + gcloud edge-cache services import (SERVICE : --location=LOCATION) [--async] + [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import an EdgeCacheService resource. If the named EdgeCacheService resource + already exists, the resource will be updated to match the imported resource + configuration. + + If the named EdgeCacheService resource does not already exist, a new + EdgeCacheService resource will be created with that name. + +EXAMPLES + To import an EdgeCacheService resource named 'my-service' from a YAML file, + run: + + $ gcloud edge-cache services import my-service \ + --source=my-service.yaml + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource you want to import. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services import + diff --git a/gcloud/edge-cache/services/invalidate-cache b/gcloud/edge-cache/services/invalidate-cache new file mode 100644 index 000000000..50b75cffd --- /dev/null +++ b/gcloud/edge-cache/services/invalidate-cache @@ -0,0 +1,104 @@ +NAME + gcloud edge-cache services invalidate-cache - invalidate the cache for an + EdgeCacheService resource + +SYNOPSIS + gcloud edge-cache services invalidate-cache (SERVICE : --location=LOCATION) + (--host=HOST --path=PATH --tags=[TAGS,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Invalidate the cache entries associated with an EdgeCacheService resource. + +EXAMPLES + To invalidate content via a tag, or tags for a given host for an + EdgeCacheService named 'my-service': + + $ gcloud edge-cache services invalidate-cache my-service \ + --tags="status=404" --host="media.example.com" + + To invalidate all content under a specific path, specify an exact path, or + a prefix. Prefixes are denoted with a trailing * character. + + $ gcloud edge-cache services invalidate-cache my-service \ + --path="/static/*" + + You can optionally combine this with a status code. For example, to + invalidate all cached HTTP 404s: + + $ gcloud edge-cache services invalidate-cache my-service \ + --tags="status=404" --path="/static/*" + +POSITIONAL ARGUMENTS + Service resource - The EdgeCacheService resource you want to invalidate + the cache for. 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +REQUIRED FLAGS + At least one of these must be specified: + + --host=HOST + The hostname to invalidate against. You can specify an exact or + wildcard host - e.g. "video.example.com" or ".example.com" - based on + host component. + + --path=PATH + The path to invalidate against. You can specify an exact or wildcard + host - e.g. "/videos/hls/139123.mp4" or "/manifests/" - based on path + component. + + --tags=[TAGS,...] + A list of cache tags used to identify cached objects. + + ▸ Cache tags are specified when the response is first cached, by + setting the "Cache-Tag" response header at the origin. + ▸ By default, all objects have a cache tag representing the HTTP + status code of the response, the MIME content-type, and the origin. + ▸ Multiple cache tags in the same revalidation request are treated + as boolean OR - e.g. tag1 OR tag2 OR tag3. + ▸ If a host and/or path are also specified, these are treated as + boolean AND with any tags. + + Up to 10 tags may be specified in a single invalidation request. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services invalidate-cache + diff --git a/gcloud/edge-cache/services/list b/gcloud/edge-cache/services/list new file mode 100644 index 000000000..49594b9ef --- /dev/null +++ b/gcloud/edge-cache/services/list @@ -0,0 +1,66 @@ +NAME + gcloud edge-cache services list - list all EdgeCacheService resources in a + project + +SYNOPSIS + gcloud edge-cache services list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List EdgeCacheService resources. + +EXAMPLES + To list existing EdgeCacheService resources, run: + + $ gcloud edge-cache services list + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services list + diff --git a/gcloud/edge-cache/services/update b/gcloud/edge-cache/services/update new file mode 100644 index 000000000..b2a783922 --- /dev/null +++ b/gcloud/edge-cache/services/update @@ -0,0 +1,119 @@ +NAME + gcloud edge-cache services update - update an EdgeCacheService resource + +SYNOPSIS + gcloud edge-cache services update (SERVICE : --location=LOCATION) [--async] + [--description=DESCRIPTION] + [--edge-security-policy=EDGE_SECURITY_POLICY] + [--edge-ssl-certificate=[EDGE_SSL_CERTIFICATE,...]] [--enable-logging] + [--labels=KEY=VALUE] [--logging-sample-rate=LOGGING_SAMPLE_RATE] + [--require-tls] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an existing EdgeCacheService resource. + +EXAMPLES + To update an EdgeCacheService resource called 'my-service' run: + + $ gcloud edge-cache services update my-service \ + --description="new description" + +POSITIONAL ARGUMENTS + Service resource - The name of the EdgeCacheService resource to create. + 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 service on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + SERVICE + ID of the service or fully qualified identifier for the service. To + set the service attribute: + ▸ provide the argument service on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The location Id. + + To set the location attribute: + ▸ provide the argument service on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ use global location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Human-readable description of the resource. + + --edge-security-policy=EDGE_SECURITY_POLICY + Resource URL that points at the Cloud Armor edge security policy that + is applied on each request against the EdgeCacheService. + + Security Policies should be specified as relative resource URLs - for + example projects/my-project/locations/global/securityPolicies/my-policy + + Note that only security policies with a type of EDGE can be attached to + an EdgeCacheService. + + --edge-ssl-certificate=[EDGE_SSL_CERTIFICATE,...] + URLs to sslCertificate resources that are used to authenticate + connections between users and the EdgeCacheService. + + Certificates should be specified as relative resource URLs - for + example projects/my-project/locations/global/certificates/my-cert + + Note that only "global" certificates with a "scope" of EDGE_CACHE can + be attached to an EdgeCacheService. + + You may specify up to 5 SSL certificates per Service. + + --enable-logging + Specifies whether to enable logging for traffic served by this service. + + Defaults to false. + + --labels=KEY=VALUE + List of KEY=VALUE labels to attach to this resource. + + --logging-sample-rate=LOGGING_SAMPLE_RATE + Configures the sampling rate of requests, where 1.0 means all logged + requests are reported and 0.0 means no logged requests are reported. + The default value is 1.0, and the value of the field must be in [0, 1]. + + This field can only be specified if logging is enabled for this + service. + + --require-tls + Require TLS (HTTPS) for all clients connecting to this service. + + Clients who connect over HTTP (port 80) will receive a HTTP 301 to the + same URL over HTTPS (port 443). You must have at least one (1) + edgeSslCertificate specified to enable this. + +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 networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + This variant is also available: + + $ gcloud alpha edge-cache services update + diff --git a/gcloud/firebase/test/ios/run b/gcloud/firebase/test/ios/run index feaea83af..5aac8778e 100644 --- a/gcloud/firebase/test/ios/run +++ b/gcloud/firebase/test/ios/run @@ -108,7 +108,8 @@ COMMONLY USED FLAGS ◆ --timeout 100 is 100 seconds --type=TYPE - The type of iOS test to run. TYPE must be one of: xctest, game-loop. + The type of iOS test to run. TYPE must be one of: xctest, game-loop, + robo. --xcode-version=XCODE_VERSION The version of Xcode that should be used to run an XCTest. Defaults to @@ -129,8 +130,8 @@ FLAGS --app=APP The path to the application archive (.ipa file) for game-loop testing. The path may be in the local filesystem or in Google Cloud Storage - using gs:// notation. This flag is only valid when --type=game-loop is - also set. + using gs:// notation. This flag is only valid when --type is game-loop + or robo. --async Invoke a test asynchronously without waiting for test results. diff --git a/gcloud/firestore/export b/gcloud/firestore/export index 20fef1ef1..75306c1c2 100644 --- a/gcloud/firestore/export +++ b/gcloud/firestore/export @@ -4,10 +4,12 @@ NAME SYNOPSIS gcloud firestore export OUTPUT_URI_PREFIX [--async] - [--collection-ids=[COLLECTION_IDS,...]] [GCLOUD_WIDE_FLAG ...] + [--collection-ids=[COLLECTION_IDS,...]] + [--database=DATABASE; default="(default)"] + [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - export Cloud Firestore documents to Google Cloud Storage + export Cloud Firestore documents to Google Cloud Storage. EXAMPLES To export all collection groups to mybucket in objects prefixed with @@ -21,6 +23,11 @@ EXAMPLES --collection-ids='specific collection group1','specific collection group2' --async + To export all collection groups from certain namespace, run: + + $ gcloud firestore export gs://mybucket/my/path \ + --namespace-ids='specific namespace id' + POSITIONAL ARGUMENTS OUTPUT_URI_PREFIX Location where the export files will be stored. Must be a valid Google @@ -47,6 +54,24 @@ FLAGS $ gcloud firestore export --collection-ids='customers','orders' + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud firestore export --database='foo' + + --namespace-ids=[NAMESPACE_IDS,...] + A list specifying which namespaces will be included in the operation. + When omitted, all namespaces are included. + + This is only supported for Datastore Mode databases. + + For example, to operate on only the 'customers' and 'orders' + namespaces: + + $ gcloud firestore export --namespaces-ids='customers','orders' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/fields/ttls/list b/gcloud/firestore/fields/ttls/list index 114dc04b7..39e6b4a2b 100644 --- a/gcloud/firestore/fields/ttls/list +++ b/gcloud/firestore/fields/ttls/list @@ -3,7 +3,8 @@ NAME expiration setting SYNOPSIS - gcloud firestore fields ttls list [--collection-group=COLLECTION_GROUP] + gcloud firestore fields ttls list + [--collection-group=COLLECTION_GROUP --database=DATABASE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -20,22 +21,15 @@ FLAGS Collection group resource - Collection group of the ttl. This can be omitted to include fields across all collection groups - (kinds). 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: + (kinds). 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 --collection-group on the command line with a fully specified name; ◆ provide the argument [--collection-group] 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--collection-group] on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. --collection-group=COLLECTION_GROUP ID of the collection group or fully qualified identifier for the @@ -43,6 +37,17 @@ FLAGS ▸ provide the argument --collection-group on the command line; ▸ provide the argument [--collection-group] on the command line. + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/firestore/fields/ttls/update b/gcloud/firestore/fields/ttls/update index 8f6b31cb8..1d233e3ff 100644 --- a/gcloud/firestore/fields/ttls/update +++ b/gcloud/firestore/fields/ttls/update @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud firestore fields ttls update - (FIELD : --collection-group=COLLECTION_GROUP) + (FIELD : --collection-group=COLLECTION_GROUP --database=DATABASE) (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -35,12 +35,7 @@ POSITIONAL ARGUMENTS ◆ provide the argument field 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 - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. This must be specified. @@ -60,6 +55,15 @@ POSITIONAL ARGUMENTS specified name; ▸ provide the argument --collection-group on the command line. + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/firestore/import b/gcloud/firestore/import index 3c695f170..d0adb39ef 100644 --- a/gcloud/firestore/import +++ b/gcloud/firestore/import @@ -4,10 +4,12 @@ NAME SYNOPSIS gcloud firestore import INPUT_URI_PREFIX [--async] - [--collection-ids=[COLLECTION_IDS,...]] [GCLOUD_WIDE_FLAG ...] + [--collection-ids=[COLLECTION_IDS,...]] + [--database=DATABASE; default="(default)"] + [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - import Cloud Firestore documents from Google Cloud Storage + import Cloud Firestore documents from Google Cloud Storage. EXAMPLES To import all collection groups from mybucket/my/path, run: @@ -20,6 +22,11 @@ EXAMPLES --collection-ids='specific collection group1','specific collection group2' --async + To import all collection groups from certain namespace, run: + + $ gcloud firestore import gs://mybucket/my/path \ + --namespace-ids='specific namespace id' + POSITIONAL ARGUMENTS INPUT_URI_PREFIX Location of the import files. @@ -42,6 +49,24 @@ FLAGS $ gcloud firestore import --collection-ids='customers','orders' + --database=DATABASE; default="(default)" + The database to operate on. The default value is (default). + + For example, to operate on database foo: + + $ gcloud firestore import --database='foo' + + --namespace-ids=[NAMESPACE_IDS,...] + A list specifying which namespaces will be included in the operation. + When omitted, all namespaces are included. + + This is only supported for Datastore Mode databases. + + For example, to operate on only the 'customers' and 'orders' + namespaces: + + $ gcloud firestore import --namespaces-ids='customers','orders' + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/indexes/composite/create b/gcloud/firestore/indexes/composite/create index e1dbcdd8c..77d6e364e 100644 --- a/gcloud/firestore/indexes/composite/create +++ b/gcloud/firestore/indexes/composite/create @@ -2,9 +2,9 @@ NAME gcloud firestore indexes composite create - create a new composite index SYNOPSIS - gcloud firestore indexes composite create - --collection-group=COLLECTION_GROUP --field-config=FIELD_CONFIG - [--async] [GCLOUD_WIDE_FLAG ...] + gcloud firestore indexes composite create --field-config=FIELD_CONFIG + (--collection-group=COLLECTION_GROUP : --database=DATABASE) [--async] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a new composite index. @@ -19,27 +19,12 @@ EXAMPLES --field-config=field-path=user-id,order=descending \ --field-config=field-path=timestamp,order=descending + $ gcloud firestore indexes composite create --database=(default) \ + --collection-group=Events \ + --field-config=field-path=user-id,order=descending \ + --field-config=field-path=timestamp,order=descending + REQUIRED FLAGS - Collection group resource - Collection group of the index. 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 --collection-group 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). - - This must be specified. - - --collection-group=COLLECTION_GROUP - ID of the collection group or fully qualified identifier for the - collection group. To set the collection-group attribute: - ▸ provide the argument --collection-group on the command line. - --field-config=FIELD_CONFIG Configuration for a field. @@ -66,6 +51,34 @@ REQUIRED FLAGS option is 'contains'. Exactly one of 'order' or 'array-config' must be specified. + Collection group resource - Collection group of the index. 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 --collection-group on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --collection-group=COLLECTION_GROUP + ID of the collection group or fully qualified identifier for the + collection group. To set the collection-group attribute: + ▸ provide the argument --collection-group on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/firestore/indexes/composite/delete b/gcloud/firestore/indexes/composite/delete index 08a0fe7c6..1aeec924f 100644 --- a/gcloud/firestore/indexes/composite/delete +++ b/gcloud/firestore/indexes/composite/delete @@ -3,7 +3,8 @@ NAME index SYNOPSIS - gcloud firestore indexes composite delete INDEX [GCLOUD_WIDE_FLAG ...] + gcloud firestore indexes composite delete (INDEX : --database=DATABASE) + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Delete the given composite index. @@ -13,20 +14,19 @@ EXAMPLES $ gcloud firestore indexes composite delete 3421ef + $ gcloud firestore indexes composite delete 3421ef \ + --database=(default) + POSITIONAL ARGUMENTS - Composite index resource - Index 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: + Composite index resource - Index 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 index 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 - database attribute: - ◆ provide the argument index on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). To set the collection-group - attribute: + collection-group attribute: ◆ provide the argument index on the command line with a fully specified name; ◆ provide the argument [--collection-group] on the command line. @@ -38,6 +38,18 @@ POSITIONAL ARGUMENTS composite index. To set the index attribute: ▸ provide the argument index on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + Database of the composite index. + + To set the database attribute: + ▸ provide the argument index on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/indexes/composite/describe b/gcloud/firestore/indexes/composite/describe index c3eb7bb06..727ed17a8 100644 --- a/gcloud/firestore/indexes/composite/describe +++ b/gcloud/firestore/indexes/composite/describe @@ -3,7 +3,8 @@ NAME index SYNOPSIS - gcloud firestore indexes composite describe INDEX [GCLOUD_WIDE_FLAG ...] + gcloud firestore indexes composite describe (INDEX : --database=DATABASE) + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Describe the given composite index. @@ -13,20 +14,19 @@ EXAMPLES $ gcloud firestore indexes composite describe 3421ef + $ gcloud firestore indexes composite describe 3421ef \ + --database=(default) + POSITIONAL ARGUMENTS - Composite index resource - Index 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: + Composite index resource - Index 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 index 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 - database attribute: - ◆ provide the argument index on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). To set the collection-group - attribute: + collection-group attribute: ◆ provide the argument index on the command line with a fully specified name; ◆ provide the argument [--collection-group] on the command line. @@ -38,6 +38,18 @@ POSITIONAL ARGUMENTS composite index. To set the index attribute: ▸ provide the argument index on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --database=DATABASE + Database of the composite index. + + To set the database attribute: + ▸ provide the argument index on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/indexes/composite/list b/gcloud/firestore/indexes/composite/list index 3bc13dfc7..94033cdcf 100644 --- a/gcloud/firestore/indexes/composite/list +++ b/gcloud/firestore/indexes/composite/list @@ -2,9 +2,9 @@ NAME gcloud firestore indexes composite list - list composite indexes SYNOPSIS - gcloud firestore indexes composite list [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud firestore indexes composite list [--database=DATABASE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION List composite indexes. @@ -14,12 +14,34 @@ EXAMPLES $ gcloud firestore indexes composite list + $ gcloud firestore indexes composite list --database=(default) + The following command lists composite indexes in the Events collection group: $ gcloud firestore indexes composite list \ --filter=COLLECTION_GROUP:Events +FLAGS + Collection group resource - Collection group of the index. 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 [--collection-group] 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 + collection-group attribute: + ◆ provide the argument [--collection-group] on the command line. + + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/firestore/indexes/fields/describe b/gcloud/firestore/indexes/fields/describe index b1e4b6a37..b6b95be2b 100644 --- a/gcloud/firestore/indexes/fields/describe +++ b/gcloud/firestore/indexes/fields/describe @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud firestore indexes fields describe - [[FIELD] --collection-group=COLLECTION_GROUP] [GCLOUD_WIDE_FLAG ...] + [[FIELD] --collection-group=COLLECTION_GROUP --database=DATABASE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Describe the index configuration of the given field. @@ -14,6 +15,8 @@ EXAMPLES $ gcloud firestore indexes fields describe + $ gcloud firestore indexes fields describe --database=(default) + The following command describes the index configuration of the timestamp field in the Events collection group. @@ -31,13 +34,7 @@ POSITIONAL ARGUMENTS name; ◆ with a fully specified name; ◆ set the property core/project; - ◆ provide the argument --project on the command line. To set the - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ with a fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. [FIELD] ID of the field or fully qualified identifier for the field. To set @@ -55,6 +52,16 @@ POSITIONAL ARGUMENTS ▸ provide the argument --collection-group on the command line; ▸ . + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/firestore/indexes/fields/list b/gcloud/firestore/indexes/fields/list index 60ad5dbe6..ddc7e60b0 100644 --- a/gcloud/firestore/indexes/fields/list +++ b/gcloud/firestore/indexes/fields/list @@ -3,7 +3,8 @@ NAME settings SYNOPSIS - gcloud firestore indexes fields list [--collection-group=COLLECTION_GROUP] + gcloud firestore indexes fields list + [--collection-group=COLLECTION_GROUP --database=DATABASE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -17,6 +18,8 @@ EXAMPLES $ gcloud firestore indexes fields list + $ gcloud firestore indexes fields list --database=(default) + The following command lists fields with custom index settings in the Events collection group: @@ -33,23 +36,16 @@ EXAMPLES FLAGS Collection group resource - Collection group of the index. - This can be omitted to include fields across all collection groups. 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: + This can be omitted to include fields across all collection groups. 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 --collection-group on the command line with a fully specified name; ◆ provide the argument [--collection-group] 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 - database attribute: - ◆ provide the argument --collection-group on the command line with a - fully specified name; - ◆ provide the argument [--collection-group] on the command line with a - fully specified name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. --collection-group=COLLECTION_GROUP ID of the collection group or fully qualified identifier for the @@ -57,6 +53,17 @@ FLAGS ▸ provide the argument --collection-group on the command line; ▸ provide the argument [--collection-group] on the command line. + --database=DATABASE + Database of the collection group. + + To set the database attribute: + ▸ provide the argument --collection-group on the command line with + a fully specified name; + ▸ provide the argument [--collection-group] on the command line + with a fully specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/firestore/indexes/fields/update b/gcloud/firestore/indexes/fields/update index 6a2db8dd3..840a5a39c 100644 --- a/gcloud/firestore/indexes/fields/update +++ b/gcloud/firestore/indexes/fields/update @@ -4,9 +4,8 @@ NAME SYNOPSIS gcloud firestore indexes fields update - (FIELD : --collection-group=COLLECTION_GROUP) - (--clear-exemption | --disable-indexes - | --index=[array-config=ARRAY-CONFIG],[order=ORDER]) [--async] + (FIELD : --collection-group=COLLECTION_GROUP --database=DATABASE) + (--clear-exemption | --disable-indexes | --index=KEY=VALUE) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -22,6 +21,9 @@ EXAMPLES $ gcloud firestore indexes fields update timestamp \ --collection-group=Events --disable-indexes + $ gcloud firestore indexes fields update timestamp \ + --database=(default) --collection-group=Events --disable-indexes + The following command creates an exemption for the timestamp field in the Events collection group, in which the list of indexes is explicitly set to [ASCENDING, DESCENDING]: @@ -45,12 +47,7 @@ POSITIONAL ARGUMENTS ◆ provide the argument field 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 - database attribute: - ◆ provide the argument field on the command line with a fully specified - name; - ◆ provide the argument [--database] on the command line (currently - '(default)' is the only supported value). + ◆ provide the argument --project on the command line. This must be specified. @@ -70,6 +67,15 @@ POSITIONAL ARGUMENTS specified name; ▸ provide the argument --collection-group on the command line. + --database=DATABASE + Database of the field. + + To set the database attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --database on the command line; + ▸ the default value of argument [--database] is (default). + REQUIRED FLAGS Exactly one of these must be specified: @@ -80,7 +86,7 @@ REQUIRED FLAGS --disable-indexes If provided, the field will no longer be indexed at all. - --index=[array-config=ARRAY-CONFIG],[order=ORDER] + --index=KEY=VALUE An index for the field. This flag can be repeated to provide multiple indexes. Any existing diff --git a/gcloud/functions/add-invoker-policy-binding b/gcloud/functions/add-invoker-policy-binding index 5f3d9fedf..8bc35d16d 100644 --- a/gcloud/functions/add-invoker-policy-binding +++ b/gcloud/functions/add-invoker-policy-binding @@ -7,7 +7,7 @@ SYNOPSIS --member=PRINCIPAL [GCLOUD_WIDE_FLAG ...] DESCRIPTION - This command applies to Cloud Functions V2 only. + This command applies to Cloud Functions 2nd gen only. EXAMPLES To add the invoker policy binding for FUNCTION-1 from role ROLE-1 for diff --git a/gcloud/functions/deploy b/gcloud/functions/deploy index f45bc8fe5..836e70170 100644 --- a/gcloud/functions/deploy +++ b/gcloud/functions/deploy @@ -134,8 +134,16 @@ FLAGS --memory=MEMORY Limit on the amount of memory the function can use. - Allowed values are: 128MB, 256MB, 512MB, 1024MB, 2048MB, 4096MB, and - 8192MB. By default, a new function is limited to 256MB of memory. When + Allowed values for v1 are: 128MB, 256MB, 512MB, 1024MB, 2048MB, 4096MB, + and 8192MB. + + Allowed values for GCF 2nd gen are in the format: with + allowed units of "k", "M", "G", "Ki", "Mi", "Gi". Ending 'b' or 'B' is + allowed. + + Examples: 100000k, 128M, 10Mb, 1024Mi, 750K, 4Gi. + + By default, a new function is limited to 256MB of memory. When deploying an update to an existing function, the function keeps its old memory limit unless you specify this flag. @@ -257,8 +265,12 @@ FLAGS --timeout=TIMEOUT The function execution timeout, e.g. 30s for 30 seconds. Defaults to original value for existing function or 60 seconds for new functions. - Cannot be more than 540s. See $ gcloud topic datetimes for information - on duration formats. + + For GCF 1st gen functions, cannot be more than 540s. + + For GCF 2nd gen functions, cannot be more than 3600s. + + See $ gcloud topic datetimes for information on duration formats. --trigger-location=TRIGGER_LOCATION The location of the trigger, which must be a region or multi-region diff --git a/gcloud/functions/remove-invoker-policy-binding b/gcloud/functions/remove-invoker-policy-binding index 75f549a62..601821118 100644 --- a/gcloud/functions/remove-invoker-policy-binding +++ b/gcloud/functions/remove-invoker-policy-binding @@ -7,7 +7,7 @@ SYNOPSIS --member=PRINCIPAL [GCLOUD_WIDE_FLAG ...] DESCRIPTION - This command applies to Cloud Functions V2 only. + This command applies to Cloud Functions 2nd gen only. EXAMPLES To remove the invoker policy binding for FUNCTION-1 from role ROLE-1 for diff --git a/gcloud/healthcare/fhir-stores/import/gcs b/gcloud/healthcare/fhir-stores/import/gcs index 0dc431ee1..6e5acbda0 100644 --- a/gcloud/healthcare/fhir-stores/import/gcs +++ b/gcloud/healthcare/fhir-stores/import/gcs @@ -17,14 +17,14 @@ EXAMPLES the folder 'someFolder' into the FHIR store 'test-fhir-store', run: $ gcloud healthcare fhir-stores import gcs test-fhir-store \ - --gcs-uri=gs://testGcsBucket/someFolder --dataset=test-dataset + --gcs-uri=gs://testGcsBucket/someFolder/* --dataset=test-dataset To perform the same import, but importing resources with the content structure of 'RESOURCE', run: $ gcloud healthcare fhir-stores import gcs test-fhir-store \ - --gcs-uri=gs://testGcsBucket/someFolder --dataset=test-dataset \ - --content-structure=RESOURCE + --gcs-uri=gs://testGcsBucket/someFolder/* \ + --dataset=test-dataset --content-structure=RESOURCE POSITIONAL ARGUMENTS FhirStore resource - Cloud Healthcare API FHIR store into which the data @@ -64,7 +64,21 @@ REQUIRED FLAGS --gcs-uri=GCS_URI Cloud Storage source data locations. Each Cloud Storage object should be a text file that contains newline-delimited JSON structures - conforming to the FHIR standard. + conforming to the FHIR standard. You can use wildcards to import + multiple files from one or more directories. + ◆ Use * to match 0 or more non-separator characters. For example, + gs://BUCKET/DIRECTORY/Example*.ndjson matches Example.ndjson and + Example22.ndjson in DIRECTORY. + ◆ Use ** to match 0 or more characters (including separators). Must + be used at the end of a path and with no other wildcards in the path. + Can also be used with a filename extension (such as .ndjson), which + imports all files with the filename extension in the specified + directory and its subdirectories. For example, + gs://BUCKET/DIRECTORY/**.ndjson imports all files with the .ndjson + filename extension in DIRECTORY and its subdirectories. + ◆ Use ? to match 1 character. For example, + gs://BUCKET/DIRECTORY/Example?.ndjson matches Example1.ndjson but + does not match Example.ndjson or Example01.ndjson. OPTIONAL FLAGS --async diff --git a/gcloud/iap/oauth-clients/create b/gcloud/iap/oauth-clients/create index 6d7105cd5..d560bbaf9 100644 --- a/gcloud/iap/oauth-clients/create +++ b/gcloud/iap/oauth-clients/create @@ -1,5 +1,5 @@ NAME - gcloud iap oauth-clients create - create a Cloud IAP OAuth client for the + gcloud iap oauth-clients create - create a Cloud IAP OAuth client in the project SYNOPSIS @@ -7,17 +7,17 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - gcloud iap oauth-clients create is used to create a Cloud IAP OAuth client - for the project. To call this command, the Cloud OAuth brand for the - project must exist and be set for 'internal only'. The client is owned by - Cloud IAP. + gcloud iap oauth-clients create is used to create an OAuth client in the + project to be used by Cloud IAP. To call this command, the Cloud OAuth + brand for the project must exist and be set for 'internal only'. The new + client is owned by Cloud IAP. EXAMPLES - To create a Cloud OAuth client for the current project, run: + To create a Cloud IAP OAuth client for the current project, run: $ gcloud iap oauth-clients create BRAND --display_name=DISPLAY_NAME - To create a Cloud OAuth client for the project PROJECT_ID, run: + To create a Cloud IAP OAuth client for the project PROJECT_ID, run: $ gcloud iap oauth-clients create BRAND \ --display_name=DISPLAY_NAME --project=PROJECT_ID diff --git a/gcloud/iap/oauth-clients/delete b/gcloud/iap/oauth-clients/delete index db283b571..c17dce7d5 100644 --- a/gcloud/iap/oauth-clients/delete +++ b/gcloud/iap/oauth-clients/delete @@ -7,14 +7,16 @@ SYNOPSIS DESCRIPTION gcloud iap oauth-clients delete is used to delete a Cloud IAP OAuth client. + Note this command cannot be used to delete any other type of OAuth client + in your project. EXAMPLES - To delete a Cloud OAuth client named CLIENT for the current project and + To delete a Cloud IAP OAuth client named CLIENT for the current project and brand BRAND, run: $ gcloud iap oauth-clients delete CLIENT --brand=BRAND - To delete a Cloud OAuth client named CLIENT for a specific project + To delete a Cloud IAP OAuth client named CLIENT for a specific project PROJECT_ID and brand BRAND, run: $ gcloud iap oauth-clients delete CLIENT --brand=BRAND \ diff --git a/gcloud/iap/oauth-clients/describe b/gcloud/iap/oauth-clients/describe index 89afe1abf..d8cb0e087 100644 --- a/gcloud/iap/oauth-clients/describe +++ b/gcloud/iap/oauth-clients/describe @@ -7,14 +7,15 @@ SYNOPSIS DESCRIPTION gcloud iap oauth-clients describe is used to describe a Cloud IAP OAuth - client. + client. Note this command cannot be used to describe any other type of + OAuth client in your project. EXAMPLES - To describe a Cloud OAuth client for the current project, run: + To describe a Cloud IAP OAuth client for the current project, run: $ gcloud iap oauth-clients describe NAME - To describe a Cloud OAuth client for a specific brand, run: + To describe a Cloud IAP OAuth client for a specific brand, run: $ gcloud iap oauth-clients describe NAME --brand=BRAND diff --git a/gcloud/iap/oauth-clients/help b/gcloud/iap/oauth-clients/help index 15bb92e11..e595f05c7 100644 --- a/gcloud/iap/oauth-clients/help +++ b/gcloud/iap/oauth-clients/help @@ -5,7 +5,9 @@ SYNOPSIS gcloud iap oauth-clients COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Manage IAP OAuth clients. + Manage OAuth clients that are used by Cloud Identity-Aware Proxy. Note this + API cannot be used as a generic management API for all OAuth clients in + your project. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -16,7 +18,7 @@ COMMANDS COMMAND is one of the following: create - Create a Cloud IAP OAuth client for the project. + Create a Cloud IAP OAuth client in the project. delete Delete a Cloud IAP OAuth client. diff --git a/gcloud/iap/oauth-clients/list b/gcloud/iap/oauth-clients/list index 37c0aa6a9..dcc9c4880 100644 --- a/gcloud/iap/oauth-clients/list +++ b/gcloud/iap/oauth-clients/list @@ -8,10 +8,11 @@ SYNOPSIS DESCRIPTION gcloud iap oauth-clients list is used to list Cloud IAP OAuth clients in a - Cloud OAuth brand. + Cloud OAuth brand. Note this command will not list any other type of OAuth + client in your project. EXAMPLES - To list a Cloud OAuth client for the current project, run: + To list the Cloud IAP OAuth clients for the current project, run: $ gcloud iap oauth-clients list BRAND diff --git a/gcloud/iap/oauth-clients/reset-secret b/gcloud/iap/oauth-clients/reset-secret index a0fab61d6..aca192fd9 100644 --- a/gcloud/iap/oauth-clients/reset-secret +++ b/gcloud/iap/oauth-clients/reset-secret @@ -8,14 +8,15 @@ SYNOPSIS DESCRIPTION gcloud iap oauth-clients reset-secret is used to reset a Cloud IAP OAuth - client secret. + client secret. Note this command cannot be used to reset the secret for any + other type of OAuth client in your project. EXAMPLES - To reset a Cloud OAuth client secret, run: + To reset a Cloud IAP OAuth client secret, run: $ gcloud iap oauth-clients reset-secret NAME - To reset a Cloud OAuth client secret for a specific brand, run: + To reset a Cloud IAP OAuth client secret for a specific brand, run: $ gcloud iap oauth-clients reset-secret NAME --brand=BRAND diff --git a/gcloud/ids/endpoints/create b/gcloud/ids/endpoints/create index ab11f5a37..06f41fb31 100644 --- a/gcloud/ids/endpoints/create +++ b/gcloud/ids/endpoints/create @@ -5,7 +5,8 @@ SYNOPSIS gcloud ids endpoints create (ENDPOINT : --zone=ZONE) --network=NETWORK --severity=SEVERITY [--async] [--description=DESCRIPTION] [--enable-traffic-logs] [--labels=[KEY=VALUE,...]] - [--max-wait=MAX_WAIT; default="60m"] [GCLOUD_WIDE_FLAG ...] + [--max-wait=MAX_WAIT; default="60m"] + [--threat-exceptions=[exc1,exc2,...,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create an endpoint for the specified VPC network. Successful creation of an @@ -21,6 +22,14 @@ EXAMPLES $ gcloud ids endpoints create my-endpoint --network=my-net \ --zone=us-central1-a --project=my-project --severity=LOW + To create an endpoint called my-endpoint for VPC network my-net, in zone + us-central1-a, alerting on LOW threats or higher, excluding threat IDs 1000 + and 2000, run: + + $ gcloud ids endpoints create my-endpoint --network=my-net \ + --zone=us-central1-a --project=my-project --severity=LOW \ + --threat-exceptions=1000,2000 + POSITIONAL ARGUMENTS Endpoint resource - endpoint. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not @@ -83,6 +92,10 @@ OPTIONAL FLAGS specified. See $ gcloud topic datetimes for information on time formats. + --threat-exceptions=[exc1,exc2,...,...] + List of threat IDs to be excepted from alerting. Passing empty list + clears the exceptions. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/ids/endpoints/help b/gcloud/ids/endpoints/help index 803934d5d..4a984e5bc 100644 --- a/gcloud/ids/endpoints/help +++ b/gcloud/ids/endpoints/help @@ -31,6 +31,9 @@ COMMANDS list List Cloud IDS endpoints. + update + Update an existing Cloud IDS endpoint. + NOTES These variants are also available: diff --git a/gcloud/ids/endpoints/update b/gcloud/ids/endpoints/update new file mode 100644 index 000000000..10163babb --- /dev/null +++ b/gcloud/ids/endpoints/update @@ -0,0 +1,83 @@ +NAME + gcloud ids endpoints update - update an existing Cloud IDS endpoint + +SYNOPSIS + gcloud ids endpoints update (ENDPOINT : --zone=ZONE) [--async] + [--max-wait=MAX_WAIT; default="60m"] + [--threat-exceptions=[exc1,exc2,...,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update the endpoint for the specified VPC network. Check the progress of + endpoint update by using gcloud alpha ids endpoints list. + + For more examples, refer to the EXAMPLES section below. + +EXAMPLES + To update an endpoint called my-endpoint, excluding threat IDs 1000 and + 2000, run: + + $ gcloud ids endpoints update my-endpoint \ + --threat-exceptions=1000,2000 + + To update an endpoint called my-endpoint, clearing the excluded threat + list, run: + + $ gcloud ids endpoints update my-endpoint --threat-exceptions= + +POSITIONAL ARGUMENTS + Endpoint resource - endpoint. 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 endpoint 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. + + ENDPOINT + ID of the endpoint or fully qualified identifier for the endpoint. To + set the endpoint attribute: + ▸ provide the argument endpoint on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --zone=ZONE + Zone of the endpoint. To set the zone attribute: + ▸ provide the argument endpoint on the command line with a fully + specified name; + ▸ provide the argument --zone on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --max-wait=MAX_WAIT; default="60m" + Time to synchronously wait for the operation to complete, after which + the operation continues asynchronously. Ignored if --no-async isn't + specified. See $ gcloud topic datetimes for information on time + formats. + + --threat-exceptions=[exc1,exc2,...,...] + List of threat IDs to be excepted from alerting. Passing empty list + clears the exceptions. + +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 ids endpoints update + + $ gcloud beta ids endpoints update + diff --git a/gcloud/kms/import-jobs/create b/gcloud/kms/import-jobs/create index 0c4a388a1..be44373e3 100644 --- a/gcloud/kms/import-jobs/create +++ b/gcloud/kms/import-jobs/create @@ -15,7 +15,7 @@ EXAMPLES $ gcloud kms import-jobs create strider --location=us-central1 \ --keyring=fellowship \ - --import-method=rsa-oaep-3072-sha1-aes-256 \ + --import-method=rsa-oaep-3072-sha256-aes-256 \ --protection-level=hsm POSITIONAL ARGUMENTS diff --git a/gcloud/kms/keys/create b/gcloud/kms/keys/create index a1b0f4eca..dc4055051 100644 --- a/gcloud/kms/keys/create +++ b/gcloud/kms/keys/create @@ -162,7 +162,8 @@ OPTIONAL FLAGS https://cloud.google.com/kms/docs/algorithms. DEFAULT_ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, external-symmetric-encryption, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/kms/keys/update b/gcloud/kms/keys/update index 102f2b58c..05492f412 100644 --- a/gcloud/kms/keys/update +++ b/gcloud/kms/keys/update @@ -112,7 +112,8 @@ FLAGS https://cloud.google.com/kms/docs/algorithms. DEFAULT_ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, external-symmetric-encryption, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/kms/keys/versions/import b/gcloud/kms/keys/versions/import index 97d3d7834..d27cb8307 100644 --- a/gcloud/kms/keys/versions/import +++ b/gcloud/kms/keys/versions/import @@ -32,7 +32,8 @@ REQUIRED FLAGS about supported algorithms, see https://cloud.google.com/kms/docs/algorithms. ALGORITHM must be one of: ec-sign-p256-sha256, ec-sign-p384-sha384, ec-sign-secp256k1-sha256, - google-symmetric-encryption, hmac-sha256, rsa-decrypt-oaep-2048-sha1, + google-symmetric-encryption, hmac-sha1, hmac-sha224, hmac-sha256, + hmac-sha384, hmac-sha512, rsa-decrypt-oaep-2048-sha1, rsa-decrypt-oaep-2048-sha256, rsa-decrypt-oaep-3072-sha1, rsa-decrypt-oaep-3072-sha256, rsa-decrypt-oaep-4096-sha1, rsa-decrypt-oaep-4096-sha256, rsa-decrypt-oaep-4096-sha512, diff --git a/gcloud/logging/buckets/create b/gcloud/logging/buckets/create index 73eb797c1..4b1ad5629 100644 --- a/gcloud/logging/buckets/create +++ b/gcloud/logging/buckets/create @@ -1,5 +1,5 @@ NAME - gcloud logging buckets create - creates a bucket + gcloud logging buckets create - create a bucket SYNOPSIS gcloud logging buckets create BUCKET_ID --location=LOCATION diff --git a/gcloud/logging/buckets/delete b/gcloud/logging/buckets/delete index 5d2f0af52..c01509c2b 100644 --- a/gcloud/logging/buckets/delete +++ b/gcloud/logging/buckets/delete @@ -24,16 +24,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a bucket associated with this billing account. + Billing account of the bucket to delete. --folder=FOLDER_ID - Delete a bucket associated with this folder. + Folder of the bucket to delete. --organization=ORGANIZATION_ID - Delete a bucket associated with this organization. + Organization of the bucket to delete. --project=PROJECT_ID - Delete a bucket associated with this project. + Project of the bucket to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/buckets/describe b/gcloud/logging/buckets/describe index 7852d105e..bfd358b39 100644 --- a/gcloud/logging/buckets/describe +++ b/gcloud/logging/buckets/describe @@ -1,5 +1,5 @@ NAME - gcloud logging buckets describe - displays information about a bucket + gcloud logging buckets describe - display information about a bucket SYNOPSIS gcloud logging buckets describe BUCKET_ID --location=LOCATION @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Displays information about a bucket. + Display information about a bucket. EXAMPLES To describe a bucket in a project, run: @@ -27,16 +27,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a bucket associated with this billing account. + Billing account of the bucket to describe. --folder=FOLDER_ID - Describe a bucket associated with this folder. + Folder of the bucket to describe. --organization=ORGANIZATION_ID - Describe a bucket associated with this organization. + Organization of the bucket to describe. --project=PROJECT_ID - Describe a bucket associated with this project. + Project of the bucket to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/buckets/help b/gcloud/logging/buckets/help index 98b456d42..e2ef34ace 100644 --- a/gcloud/logging/buckets/help +++ b/gcloud/logging/buckets/help @@ -18,22 +18,22 @@ COMMANDS COMMAND is one of the following: create - Creates a bucket. + Create a bucket. delete Delete a bucket. describe - Displays information about a bucket. + Display information about a bucket. list - Lists the defined buckets. + List the defined buckets. undelete Undelete a bucket. update - Updates a bucket. + Update a bucket. NOTES These variants are also available: diff --git a/gcloud/logging/buckets/list b/gcloud/logging/buckets/list index db7be8195..abfeb7f29 100644 --- a/gcloud/logging/buckets/list +++ b/gcloud/logging/buckets/list @@ -1,5 +1,5 @@ NAME - gcloud logging buckets list - lists the defined buckets + gcloud logging buckets list - list the defined buckets SYNOPSIS gcloud logging buckets list [--location=LOCATION] @@ -9,7 +9,7 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Lists the buckets for a project. + List the buckets for a project. EXAMPLES To list the buckets in a project, run: @@ -24,16 +24,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List buckets associated with this billing account. + Billing account of the buckets to list. --folder=FOLDER_ID - List buckets associated with this folder. + Folder of the buckets to list. --organization=ORGANIZATION_ID - List buckets associated with this organization. + Organization of the buckets to list. --project=PROJECT_ID - List buckets associated with this project. + Project of the buckets to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/buckets/undelete b/gcloud/logging/buckets/undelete index c23f1cd81..69613ab95 100644 --- a/gcloud/logging/buckets/undelete +++ b/gcloud/logging/buckets/undelete @@ -24,16 +24,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Undelete a bucket associated with this billing account. + Billing account of the bucket to undelete. --folder=FOLDER_ID - Undelete a bucket associated with this folder. + Folder of the bucket to undelete. --organization=ORGANIZATION_ID - Undelete a bucket associated with this organization. + Organization of the bucket to undelete. --project=PROJECT_ID - Undelete a bucket associated with this project. + Project of the bucket to undelete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/buckets/update b/gcloud/logging/buckets/update index ee9be022d..79cf26ac6 100644 --- a/gcloud/logging/buckets/update +++ b/gcloud/logging/buckets/update @@ -1,5 +1,5 @@ NAME - gcloud logging buckets update - updates a bucket + gcloud logging buckets update - update a bucket SYNOPSIS gcloud logging buckets update BUCKET_ID --location=LOCATION @@ -11,7 +11,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Updates the properties of a bucket. + Update the properties of a bucket. EXAMPLES To update a bucket in your project, run: diff --git a/gcloud/logging/copy b/gcloud/logging/copy index bca1786b1..57fa21423 100644 --- a/gcloud/logging/copy +++ b/gcloud/logging/copy @@ -43,16 +43,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Copy log entries associated with this billing account. + Billing account of the log entries to copy. --folder=FOLDER_ID - Copy log entries associated with this folder. + Folder of the log entries to copy. --organization=ORGANIZATION_ID - Copy log entries associated with this organization. + Organization of the log entries to copy. --project=PROJECT_ID - Copy log entries associated with this project. + Project of the log entries to copy. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/locations/describe b/gcloud/logging/locations/describe index 5965cfbd8..026e58a7c 100644 --- a/gcloud/logging/locations/describe +++ b/gcloud/logging/locations/describe @@ -23,16 +23,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a location associated with this billing account. + Billing account of the location to describe. --folder=FOLDER_ID - Describe a location associated with this folder. + Folder of the location to describe. --organization=ORGANIZATION_ID - Describe a location associated with this organization. + Organization of the location to describe. --project=PROJECT_ID - Describe a location associated with this project. + Project of the location to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/locations/list b/gcloud/logging/locations/list index 43de7f3f4..1cf28f59b 100644 --- a/gcloud/logging/locations/list +++ b/gcloud/logging/locations/list @@ -20,16 +20,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List locations associated with this billing account. + Billing account of the locations to list. --folder=FOLDER_ID - List locations associated with this folder. + Folder of the locations to list. --organization=ORGANIZATION_ID - List locations associated with this organization. + Organization of the locations to list. --project=PROJECT_ID - List locations associated with this project. + Project of the locations to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/logs/delete b/gcloud/logging/logs/delete index 918044db4..7c41efbe9 100644 --- a/gcloud/logging/logs/delete +++ b/gcloud/logging/logs/delete @@ -1,16 +1,17 @@ NAME - gcloud logging logs delete - deletes all entries from a log + gcloud logging logs delete - delete all entries from a log in the _Default + log bucket SYNOPSIS gcloud logging logs delete LOG_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Deletes all entries from a log. With no entries, the log will not appear in - the list of your project's logs. However, you can write new entries to the - log. + Delete all entries from a log in the _Default log bucket. With no entries, + the log will not appear in the list of your project's logs. However, you + can write new entries to the log. EXAMPLES - To delete all entries from log 'my-log': + To delete all entries from log 'my-log' in the _Default log bucket: $ gcloud logging logs delete my-log diff --git a/gcloud/logging/logs/help b/gcloud/logging/logs/help index c490e902d..883185c40 100644 --- a/gcloud/logging/logs/help +++ b/gcloud/logging/logs/help @@ -16,10 +16,10 @@ COMMANDS COMMAND is one of the following: delete - Deletes all entries from a log. + Delete all entries from a log in the _Default log bucket. list - Lists your project's logs. + List your project's logs. NOTES These variants are also available: diff --git a/gcloud/logging/logs/list b/gcloud/logging/logs/list index 6e1d1ba88..9981dc380 100644 --- a/gcloud/logging/logs/list +++ b/gcloud/logging/logs/list @@ -1,5 +1,5 @@ NAME - gcloud logging logs list - lists your project's logs + gcloud logging logs list - list your project's logs SYNOPSIS gcloud logging logs list [--bucket=BUCKET --location=LOCATION --view=VIEW] diff --git a/gcloud/logging/metrics/create b/gcloud/logging/metrics/create index 4d4fedadd..1934fcfbd 100644 --- a/gcloud/logging/metrics/create +++ b/gcloud/logging/metrics/create @@ -1,5 +1,5 @@ NAME - gcloud logging metrics create - creates a logs-based metric + gcloud logging metrics create - create a logs-based metric SYNOPSIS gcloud logging metrics create METRIC_NAME @@ -8,7 +8,7 @@ SYNOPSIS : --bucket-name=BUCKET_NAME]) [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Creates a logs-based metric to count the number of log entries that match a + Create a logs-based metric to count the number of log entries that match a filter expression. Logs-based metrics can also be used to extract values from logs and create a distribution of the values. diff --git a/gcloud/logging/metrics/delete b/gcloud/logging/metrics/delete index 68aa2dfea..bba2dafca 100644 --- a/gcloud/logging/metrics/delete +++ b/gcloud/logging/metrics/delete @@ -1,11 +1,11 @@ NAME - gcloud logging metrics delete - deletes a logs-based metric + gcloud logging metrics delete - delete a logs-based metric SYNOPSIS gcloud logging metrics delete METRIC_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Deletes a logs-based metric called high_severity_count. + Delete a logs-based metric called high_severity_count. EXAMPLES To delete a metric called high_severity_count, run: diff --git a/gcloud/logging/metrics/describe b/gcloud/logging/metrics/describe index bddb8b772..dcd67909b 100644 --- a/gcloud/logging/metrics/describe +++ b/gcloud/logging/metrics/describe @@ -1,12 +1,12 @@ NAME - gcloud logging metrics describe - shows the definition of a logs-based + gcloud logging metrics describe - display the definition of a logs-based metric SYNOPSIS gcloud logging metrics describe METRIC_NAME [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Shows the definition of a logs-based metric. + Show the definition of a logs-based metric. EXAMPLES To show the definition of a metric called high_severity_count, run: diff --git a/gcloud/logging/metrics/help b/gcloud/logging/metrics/help index 0605612e8..80da8a238 100644 --- a/gcloud/logging/metrics/help +++ b/gcloud/logging/metrics/help @@ -16,19 +16,19 @@ COMMANDS COMMAND is one of the following: create - Creates a logs-based metric. + Create a logs-based metric. delete - Deletes a logs-based metric. + Delete a logs-based metric. describe - Shows the definition of a logs-based metric. + Display the definition of a logs-based metric. list - Displays all logs-based metrics. + Display all logs-based metrics. update - Updates the definition of a logs-based metric. + Update the definition of a logs-based metric. NOTES These variants are also available: diff --git a/gcloud/logging/metrics/list b/gcloud/logging/metrics/list index f75e9875b..dc310dcfe 100644 --- a/gcloud/logging/metrics/list +++ b/gcloud/logging/metrics/list @@ -1,12 +1,12 @@ NAME - gcloud logging metrics list - displays all logs-based metrics + gcloud logging metrics list - display all logs-based metrics SYNOPSIS gcloud logging metrics list [--filter=EXPRESSION] [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Lists all logs-based metrics. + List all logs-based metrics. EXAMPLES To list the top 10 logs-based metrics, run: diff --git a/gcloud/logging/metrics/update b/gcloud/logging/metrics/update index e5a9041ca..024fa7593 100644 --- a/gcloud/logging/metrics/update +++ b/gcloud/logging/metrics/update @@ -1,5 +1,5 @@ NAME - gcloud logging metrics update - updates the definition of a logs-based + gcloud logging metrics update - update the definition of a logs-based metric SYNOPSIS @@ -9,7 +9,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Updates the description or the filter expression of an existing logs-based + Update the description or the filter expression of an existing logs-based metric. EXAMPLES diff --git a/gcloud/logging/operations/cancel b/gcloud/logging/operations/cancel index 8b1ec7865..923dacc7e 100644 --- a/gcloud/logging/operations/cancel +++ b/gcloud/logging/operations/cancel @@ -29,16 +29,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Cancel operation associated with this billing account. + Billing account of the operation to cancel. --folder=FOLDER_ID - Cancel operation associated with this folder. + Folder of the operation to cancel. --organization=ORGANIZATION_ID - Cancel operation associated with this organization. + Organization of the operation to cancel. --project=PROJECT_ID - Cancel operation associated with this project. + Project of the operation to cancel. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/operations/describe b/gcloud/logging/operations/describe index 53a4cbd8d..e045433a3 100644 --- a/gcloud/logging/operations/describe +++ b/gcloud/logging/operations/describe @@ -1,5 +1,6 @@ NAME - gcloud logging operations describe - describe a long running operation + gcloud logging operations describe - display the information about a long + running operation SYNOPSIS gcloud logging operations describe OPERATION_ID --location=LOCATION @@ -8,10 +9,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Describe a long running operation which was scheduled before. For example, - a copy_log_entries operation scheduled by command: "gcloud alpha logging - copy BUCKET_ID DESTINATION --location=LOCATION" OPERATION_ID and LOCATION - are required to locate such operation. + Display the information about a long running operation which was scheduled + before. For example, a copy_log_entries operation scheduled by command: + "gcloud alpha logging copy BUCKET_ID DESTINATION --location=LOCATION" + OPERATION_ID and LOCATION are required to locate such operation. EXAMPLES To describe an operation, run: @@ -30,16 +31,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe operation associated with this billing account. + Billing account of the operation to describe. --folder=FOLDER_ID - Describe operation associated with this folder. + Folder of the operation to describe. --organization=ORGANIZATION_ID - Describe operation associated with this organization. + Organization of the operation to describe. --project=PROJECT_ID - Describe operation associated with this project. + Project of the operation to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/operations/help b/gcloud/logging/operations/help index 01aa5d903..39e949867 100644 --- a/gcloud/logging/operations/help +++ b/gcloud/logging/operations/help @@ -19,7 +19,7 @@ COMMANDS Cancel a long running operation. describe - Describe a long running operation. + Display the information about a long running operation. list List long running operations. diff --git a/gcloud/logging/operations/list b/gcloud/logging/operations/list index 5b5a365a4..2b00198b2 100644 --- a/gcloud/logging/operations/list +++ b/gcloud/logging/operations/list @@ -62,16 +62,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List operations associated with this billing account. + Billing account of the operations to list. --folder=FOLDER_ID - List operations associated with this folder. + Folder of the operations to list. --organization=ORGANIZATION_ID - List operations associated with this organization. + Organization of the operations to list. --project=PROJECT_ID - List operations associated with this project. + Project of the operations to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/read b/gcloud/logging/read index 8c56597db..688db4f27 100644 --- a/gcloud/logging/read +++ b/gcloud/logging/read @@ -6,7 +6,8 @@ SYNOPSIS [--order=ORDER; default="desc"] [--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID | --organization=ORGANIZATION_ID | --project=PROJECT_ID] - [--bucket=BUCKET --location=LOCATION --view=VIEW] [--limit=LIMIT] + [--resource-names=[RESOURCE,...] + | --bucket=BUCKET --location=LOCATION --view=VIEW] [--limit=LIMIT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -49,13 +50,13 @@ EXAMPLES $ gcloud logging read --bucket= --location=[LOCATION] \ --limit=1 - To read a log entry from the global Required log bucket using the bucket's - Default log view: + To read a log entry from the global _Required log bucket using the bucket's + _Default log view: $ gcloud logging read "" --bucket=_Required --location=global \ --view=_Default --limit=1 - To read a log entry from a log bucket using the bucket's AllLogs log view: + To read a log entry from a log bucket using the bucket's _AllLogs log view: $ gcloud logging read "" --bucket=[BUCKET_ID] \ --location=[LOCATION] --view=_AllLogs --limit=1 @@ -66,6 +67,14 @@ EXAMPLES $ gcloud logging read "" --bucket=[BUCKET_ID] \ --location=[LOCATION] --view=[VIEW_ID] --limit=1 + To read log entries from multiple resources, specify them as a + comma-delimeted sequence with --resource-names. Each resource name can be + specified either as a top-level resource (e.g., projects/[PROJECT_ID], + folders/[FOLDER_ID], etc.) or as a Log View resource (e.g., + projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_NAME]/views/[VIEW_ID]). + + $ gcloud logging read "" --resource-names=[RESOURCE-1],[RESOURCE-2] + POSITIONAL ARGUMENTS [LOG_FILTER] Filter expression that specifies the log entries to return. Detailed @@ -85,16 +94,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Read log entries associated with this billing account. + Billing account of the log entries to read. --folder=FOLDER_ID - Read log entries associated with this folder. + Folder of the log entries to read. --organization=ORGANIZATION_ID - Read log entries associated with this organization. + Organization of the log entries to read. --project=PROJECT_ID - Read log entries associated with this project. + Project of the log entries to read. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be @@ -107,29 +116,38 @@ FLAGS and billing. To specify a different project for quota and billing, use --billing-project or billing/quota_project property. - These arguments are used in conjunction with the parent to construct a - view resource. + At most one of these can be specified: - --bucket=BUCKET - Id of the log bucket. If this argument is provided then --location - and --view must also be specified. + --resource-names=[RESOURCE,...] + Resource name(s) to read logs from. A resource can either be an + top-level resource (e.g., "projects/my-project") or a full log view + resource path (e.g., + "projects/my-project/locations/my-location/buckets/my-bucket/views/my-view"). + Multiple resources can be specified, separated by a comma. - This flag argument must be specified if any of the other arguments in - this group are specified. + These arguments are used in conjunction with the parent to construct a + view resource. - --location=LOCATION - Location of the log bucket. If this argument is provided then - --bucket and --view must also be specified. + --bucket=BUCKET + Id of the log bucket. If this argument is provided then --location + and --view must also be specified. - This flag argument must be specified if any of the other arguments in - this group are specified. + This flag argument must be specified if any of the other arguments + in this group are specified. - --view=VIEW - Id of the view. If this argument is provided then --location and - --bucket must also be specified. + --location=LOCATION + Location of the log bucket. If this argument is provided then + --bucket and --view must also be specified. - This flag argument must be specified if any of the other arguments in - this group are specified. + This flag argument must be specified if any of the other arguments + in this group are specified. + + --view=VIEW + Id of the view. If this argument is provided then --location and + --bucket must also be specified. + + This flag argument must be specified if any of the other arguments + in this group are specified. LIST COMMAND FLAGS --limit=LIMIT diff --git a/gcloud/logging/resource-descriptors/help b/gcloud/logging/resource-descriptors/help index 1e85eab9b..9e0839c0a 100644 --- a/gcloud/logging/resource-descriptors/help +++ b/gcloud/logging/resource-descriptors/help @@ -17,7 +17,7 @@ COMMANDS COMMAND is one of the following: list - Lists all available resource descriptors. + List all available resource descriptors. NOTES These variants are also available: diff --git a/gcloud/logging/resource-descriptors/list b/gcloud/logging/resource-descriptors/list index a9cfd78ae..d26a6148a 100644 --- a/gcloud/logging/resource-descriptors/list +++ b/gcloud/logging/resource-descriptors/list @@ -1,5 +1,5 @@ NAME - gcloud logging resource-descriptors list - lists all available resource + gcloud logging resource-descriptors list - list all available resource descriptors SYNOPSIS @@ -7,7 +7,7 @@ SYNOPSIS [--limit=LIMIT] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Lists all available resource descriptors that are used by Cloud Logging. + List all available resource descriptors that are used by Cloud Logging. Each log entry must be associated with a valid resource descriptor. EXAMPLES diff --git a/gcloud/logging/settings/describe b/gcloud/logging/settings/describe index 245196246..2b3b426de 100644 --- a/gcloud/logging/settings/describe +++ b/gcloud/logging/settings/describe @@ -1,5 +1,5 @@ NAME - gcloud logging settings describe - displays the settings for the Cloud + gcloud logging settings describe - display the settings for the Cloud Logging Logs Router SYNOPSIS @@ -32,16 +32,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe settings associated with this billing account. + Billing account of the settings to describe. --folder=FOLDER_ID - Describe settings associated with this folder. + Folder of the settings to describe. --organization=ORGANIZATION_ID - Describe settings associated with this organization. + Organization of the settings to describe. --project=PROJECT_ID - Describe settings associated with this project. + Project of the settings to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/settings/help b/gcloud/logging/settings/help index a283d8d7d..968d9048b 100644 --- a/gcloud/logging/settings/help +++ b/gcloud/logging/settings/help @@ -17,10 +17,10 @@ COMMANDS COMMAND is one of the following: describe - Displays the settings for the Cloud Logging Logs Router. + Display the settings for the Cloud Logging Logs Router. update - Updates the settings for the Cloud Logging Logs Router. + Update the settings for the Cloud Logging Logs Router. NOTES These variants are also available: diff --git a/gcloud/logging/settings/update b/gcloud/logging/settings/update index b0420ed47..47ea1f0f6 100644 --- a/gcloud/logging/settings/update +++ b/gcloud/logging/settings/update @@ -1,5 +1,5 @@ NAME - gcloud logging settings update - updates the settings for the Cloud Logging + gcloud logging settings update - update the settings for the Cloud Logging Logs Router SYNOPSIS @@ -67,13 +67,13 @@ REQUIRED FLAGS OPTIONAL FLAGS --disable-default-sink - Enable or disable Default sink for the Default bucket. Specify - --no-disable-default-sink to enable a disabled Default sink. Note: It + Enable or disable _Default sink for the _Default bucket. Specify + --no-disable-default-sink to enable a disabled _Default sink. Note: It only applies to the newly created projects and will not affect the projects created before. --storage-location=STORAGE_LOCATION - Update the storage location for Default bucket and Required bucket. + Update the storage location for _Default bucket and _Required bucket. Note: It only applies to the newly created projects and will not affect the projects created before. diff --git a/gcloud/logging/sinks/create b/gcloud/logging/sinks/create index b0afd3a63..0cdce7b87 100644 --- a/gcloud/logging/sinks/create +++ b/gcloud/logging/sinks/create @@ -1,5 +1,5 @@ NAME - gcloud logging sinks create - creates a log sink + gcloud logging sinks create - create a log sink SYNOPSIS gcloud logging sinks create SINK_NAME DESTINATION @@ -12,8 +12,8 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Creates a log used to route log entries to a destination. The sink routes - all log entries that match its --log-filter flag. + Create a log sink used to route log entries to a destination. The sink + routes all log entries that match its --log-filter flag. An empty filter matches all logs. @@ -118,16 +118,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Create a sink associated with this billing account. + Billing account of the sink to create. --folder=FOLDER_ID - Create a sink associated with this folder. + Folder of the sink to create. --organization=ORGANIZATION_ID - Create a sink associated with this organization. + Organization of the sink to create. --project=PROJECT_ID - Create a sink associated with this project. + Project of the sink to create. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/sinks/delete b/gcloud/logging/sinks/delete index d21e65882..7f4f2f24b 100644 --- a/gcloud/logging/sinks/delete +++ b/gcloud/logging/sinks/delete @@ -1,5 +1,5 @@ NAME - gcloud logging sinks delete - deletes a sink + gcloud logging sinks delete - delete a sink SYNOPSIS gcloud logging sinks delete SINK_NAME @@ -8,10 +8,10 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Deletes a sink and halts the export of log entries associated with that - sink. Deleting a sink does not affect log entries already exported through - the deleted sink, and will not affect other sinks that are exporting the - same log(s). + Delete a sink and halt the export of log entries associated with that sink. + Deleting a sink does not affect log entries already exported through the + deleted sink, and will not affect other sinks that are exporting the same + log(s). EXAMPLES To delete a sync 'my-bq-sync': @@ -26,16 +26,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a sink associated with this billing account. + Billing account of the sink to delete. --folder=FOLDER_ID - Delete a sink associated with this folder. + Folder of the sink to delete. --organization=ORGANIZATION_ID - Delete a sink associated with this organization. + Organization of the sink to delete. --project=PROJECT_ID - Delete a sink associated with this project. + Project of the sink to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/sinks/describe b/gcloud/logging/sinks/describe index fad846495..e23ffd981 100644 --- a/gcloud/logging/sinks/describe +++ b/gcloud/logging/sinks/describe @@ -1,5 +1,5 @@ NAME - gcloud logging sinks describe - displays information about a sink + gcloud logging sinks describe - display information about a sink SYNOPSIS gcloud logging sinks describe SINK_NAME @@ -8,7 +8,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Displays information about a sink. + Display information about a sink. EXAMPLES To describe a sync 'my-bq-sync': @@ -23,16 +23,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a sink associated with this billing account. + Billing account of the sink to describe. --folder=FOLDER_ID - Describe a sink associated with this folder. + Folder of the sink to describe. --organization=ORGANIZATION_ID - Describe a sink associated with this organization. + Organization of the sink to describe. --project=PROJECT_ID - Describe a sink associated with this project. + Project of the sink to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/sinks/help b/gcloud/logging/sinks/help index 96bb348b1..e191aa674 100644 --- a/gcloud/logging/sinks/help +++ b/gcloud/logging/sinks/help @@ -17,19 +17,19 @@ COMMANDS COMMAND is one of the following: create - Creates a log sink. + Create a log sink. delete - Deletes a sink. + Delete a sink. describe - Displays information about a sink. + Display information about a sink. list - Lists the defined sinks. + List the defined sinks. update - Updates a sink. + Update a sink. NOTES These variants are also available: diff --git a/gcloud/logging/sinks/list b/gcloud/logging/sinks/list index a5a5d4c8b..1f69da408 100644 --- a/gcloud/logging/sinks/list +++ b/gcloud/logging/sinks/list @@ -1,5 +1,5 @@ NAME - gcloud logging sinks list - lists the defined sinks + gcloud logging sinks list - list the defined sinks SYNOPSIS gcloud logging sinks list @@ -9,7 +9,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Lists the defined sinks. + List the defined sinks. EXAMPLES To list all defined sinks: @@ -20,16 +20,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List sinks associated with this billing account. + Billing account of the sinks to list. --folder=FOLDER_ID - List sinks associated with this folder. + Folder of the sinks to list. --organization=ORGANIZATION_ID - List sinks associated with this organization. + Organization of the sinks to list. --project=PROJECT_ID - List sinks associated with this project. + Project of the sinks to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/sinks/update b/gcloud/logging/sinks/update index 9676d323a..1fda3a08e 100644 --- a/gcloud/logging/sinks/update +++ b/gcloud/logging/sinks/update @@ -1,5 +1,5 @@ NAME - gcloud logging sinks update - updates a sink + gcloud logging sinks update - update a sink SYNOPSIS gcloud logging sinks update SINK_NAME [DESTINATION] @@ -15,7 +15,7 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Changes the [DESTINATION] or --log-filter associated with a sink. The new + Change the [DESTINATION] or --log-filter associated with a sink. The new destination must already exist and Cloud Logging must have permission to write to it. @@ -116,16 +116,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Update a sink associated with this billing account. + Billing account of the sink to update. --folder=FOLDER_ID - Update a sink associated with this folder. + Folder of the sink to update. --organization=ORGANIZATION_ID - Update a sink associated with this organization. + Organization of the sink to update. --project=PROJECT_ID - Update a sink associated with this project. + Project of the sink to update. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/views/create b/gcloud/logging/views/create index d7049f613..4e2f38233 100644 --- a/gcloud/logging/views/create +++ b/gcloud/logging/views/create @@ -36,16 +36,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Create view associated with this billing account. + Billing account of the view to create. --folder=FOLDER_ID - Create view associated with this folder. + Folder of the view to create. --organization=ORGANIZATION_ID - Create view associated with this organization. + Organization of the view to create. --project=PROJECT_ID - Create view associated with this project. + Project of the view to create. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/views/delete b/gcloud/logging/views/delete index a70642d0b..d20c91d3b 100644 --- a/gcloud/logging/views/delete +++ b/gcloud/logging/views/delete @@ -31,16 +31,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Delete a bucket associated with this billing account. + Billing account of the view to delete. --folder=FOLDER_ID - Delete a bucket associated with this folder. + Folder of the view to delete. --organization=ORGANIZATION_ID - Delete a bucket associated with this organization. + Organization of the view to delete. --project=PROJECT_ID - Delete a bucket associated with this project. + Project of the view to delete. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/views/describe b/gcloud/logging/views/describe index 744d695fe..cb749c922 100644 --- a/gcloud/logging/views/describe +++ b/gcloud/logging/views/describe @@ -31,16 +31,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Describe a view associated with this billing account. + Billing account of the view to describe. --folder=FOLDER_ID - Describe a view associated with this folder. + Folder of the view to describe. --organization=ORGANIZATION_ID - Describe a view associated with this organization. + Organization of the view to describe. --project=PROJECT_ID - Describe a view associated with this project. + Project of the view to describe. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/views/list b/gcloud/logging/views/list index 2f116eb8d..1c627d603 100644 --- a/gcloud/logging/views/list +++ b/gcloud/logging/views/list @@ -27,16 +27,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - List views associated with this billing account. + Billing account of the views to list. --folder=FOLDER_ID - List views associated with this folder. + Folder of the views to list. --organization=ORGANIZATION_ID - List views associated with this organization. + Organization of the views to list. --project=PROJECT_ID - List views associated with this project. + Project of the views to list. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/views/update b/gcloud/logging/views/update index 9112809f4..f96a5db31 100644 --- a/gcloud/logging/views/update +++ b/gcloud/logging/views/update @@ -38,16 +38,16 @@ OPTIONAL FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Update view associated with this billing account. + Billing account of the view to update. --folder=FOLDER_ID - Update view associated with this folder. + Folder of the view to update. --organization=ORGANIZATION_ID - Update view associated with this organization. + Organization of the view to update. --project=PROJECT_ID - Update view associated with this project. + Project of the view to update. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/logging/write b/gcloud/logging/write index bf3bbe76a..2230348ee 100644 --- a/gcloud/logging/write +++ b/gcloud/logging/write @@ -53,16 +53,16 @@ FLAGS At most one of these can be specified: --billing-account=BILLING_ACCOUNT_ID - Write log entries associated with this billing account. + Billing account of the log entries to write. --folder=FOLDER_ID - Write log entries associated with this folder. + Folder of the log entries to write. --organization=ORGANIZATION_ID - Write log entries associated with this organization. + Organization of the log entries to write. --project=PROJECT_ID - Write log entries associated with this project. + Project of the log entries to write. The Google Cloud project ID to use for this invocation. If omitted, then the current project is assumed; the current project can be diff --git a/gcloud/metastore/services/create b/gcloud/metastore/services/create index 90dff0d53..517921de2 100644 --- a/gcloud/metastore/services/create +++ b/gcloud/metastore/services/create @@ -3,6 +3,7 @@ NAME SYNOPSIS gcloud metastore services create (SERVICE : --location=LOCATION) [--async] + [--database-type=DATABASE_TYPE; default="mysql"] [--encryption-kms-key=ENCRYPTION_KMS_KEY] [--hive-metastore-version=HIVE_METASTORE_VERSION] [--labels=[KEY=VALUE,...]] [--port=PORT; default=9083] @@ -76,6 +77,18 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --database-type=DATABASE_TYPE; default="mysql" + The type of database the Dataproc Metastore service will store data in. + DATABASE_TYPE must be one of: + + mysql + MYSQL database type is a Dataproc Metastore service backed by MySQL + CloudSQL. + + spanner + SPANNER database type is a Dataproc Metastore service backed by + Cloud Spanner. + --encryption-kms-key=ENCRYPTION_KMS_KEY The name of the Cloud KMS key to use for customer data encryption. Cannot be changed once the service is created. Mutually exclusive with diff --git a/gcloud/ml/speech/recognize b/gcloud/ml/speech/recognize index 963ec7594..ce32e55b9 100644 --- a/gcloud/ml/speech/recognize +++ b/gcloud/ml/speech/recognize @@ -56,7 +56,7 @@ OPTIONAL FLAGS --filter-profanity If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, - e.g. "f**". + e.g. f***. --hints=[HINT,...] A list of strings containing word and phrase "hints" so that the speech diff --git a/gcloud/ml/speech/recognize-long-running b/gcloud/ml/speech/recognize-long-running index 3ca1ac002..232a54c52 100644 --- a/gcloud/ml/speech/recognize-long-running +++ b/gcloud/ml/speech/recognize-long-running @@ -65,7 +65,7 @@ OPTIONAL FLAGS --filter-profanity If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, - e.g. "f**". + e.g. f***. --hints=[HINT,...] A list of strings containing word and phrase "hints" so that the speech diff --git a/gcloud/network-connectivity/help b/gcloud/network-connectivity/help index 627062da1..45224f9dd 100644 --- a/gcloud/network-connectivity/help +++ b/gcloud/network-connectivity/help @@ -18,6 +18,9 @@ GROUPS hubs Manage Network Connectivity Center hubs. + internal-ranges + Manage internal ranges. + locations Get information about supported Network Connectivity Center locations. diff --git a/gcloud/network-connectivity/internal-ranges/create b/gcloud/network-connectivity/internal-ranges/create new file mode 100644 index 000000000..730ade0ee --- /dev/null +++ b/gcloud/network-connectivity/internal-ranges/create @@ -0,0 +1,167 @@ +NAME + gcloud network-connectivity internal-ranges create - create a new internal + range + +SYNOPSIS + gcloud network-connectivity internal-ranges create + (INTERNAL_RANGE : --region=REGION) --network=NETWORK + (--ip-cidr-range=IP_CIDR_RANGE | [--prefix-length=PREFIX_LENGTH + : --target-cidr-range=[TARGET_CIDR_RANGE,...]]) [--async] + [--description=DESCRIPTION] [--labels=KEY=VALUE] + [--overlaps=[OVERLAPS,...]] [--peering=PEERING; default="for-self"] + [--usage=USAGE; default="for-vpc"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new internal range with the given name. + +EXAMPLES + Create an internal range with name my-range and ip-cidr-range + 192.168.0.0/25 in network + https://www.googleapis.com/compute/v1/projects/my-project/locations/global/networks/my-network: + + $ gcloud network-connectivity internal-ranges create my-range \ + --ip-cidr-range="192.168.0.0/25" \ + --network="https://www.googleapis.com/compute/v1/projects/my-pro\ + ject/locations/global/networks/my-network" --project=my-project + + Create an internal range with name my-range and auto-allocated /25 block + (prefix-length 25) in network my-network: + + $ gcloud network-connectivity internal-ranges create my-range \ + --prefix-length=25 --network="my-network" --project=my-project + +POSITIONAL ARGUMENTS + Internal range resource - Name of the internal range to be created. 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 internal_range on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + INTERNAL_RANGE + ID of the internal range or fully qualified identifier for the + internal range. To set the internal_range attribute: + ▸ provide the argument internal_range on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location ID. + + To set the region attribute: + ▸ provide the argument internal_range on the command line with a + fully specified name; + ▸ provide the argument --region on the command line; + ▸ use default global location . + +REQUIRED FLAGS + --network=NETWORK + The URL or resource ID of the network in which to reserve the internal + range. Legacy network is not supported. This can only be specified for + a global internal address. + + For example: + ◆ https://www.googleapis.com/compute/v1/projects/my-project/locations/global/networks/my-network + ◆ /projects/my-project/locations/global/networks/my-network + ◆ my-network + + Exactly one of these must be specified: + + --ip-cidr-range=IP_CIDR_RANGE + IP range that this internal range defines. + + --prefix-length=PREFIX_LENGTH + An alternative to ip-cidr-range. Can be set when trying to create a + reservation that automatically finds a free range of the given size. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --target-cidr-range=[TARGET_CIDR_RANGE,...] + Can be set to narrow down or pick a different address space while + searching for a free range. If not set, defaults to the "10.0.0.0/8" + address space. This can be used to search in other rfc-1918 address + spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 + address spaces used in the VPC. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Description of the internal range to be created. + + --labels=KEY=VALUE + List of label KEY=VALUE pairs to add. + + --overlaps=[OVERLAPS,...] + Overlap specifications for the range being created. OVERLAPS must be + (currently only one value is supported): + + overlap-route-range + Allows for creation or existence of routes that have a more + specific destination than the created range. + + --peering=PEERING; default="for-self" + The type of peering set for the internal range. PEERING must be one of: + + for-peer + This behavior can be set when the internal range is being reserved + for usage by the peers. This means that no resource within the VPC + in which it is being created can use this to associate with a cloud + resource, but one of the peers can. This represents "donating" a + range for peers to use. + + for-self + This beharior represents the case that the internal range is + intended to be used in the VPC on which it is created and is + accessible from its peers. This implies that peers or peer-of-peers + cannot use this range. + + not-shared + This behavior can be set when the internal range is being reserved + for usage by the VPC on which it is created but not shared with the + peers. In a sense it is local to the VPC. This can be used to + create internal ranges for various purposes like + HTTP_INTERNAL_LOAD_BALANCER or for interconnect routes that are not + shared with peers. This also implies that peers cannot use this + range in a way that is visible to this VPC, but can re-use this + range as long as it is NOT_SHARED from the peer VPC too. + + --usage=USAGE; default="for-vpc" + The type of usage set for the internal range. USAGE must be one of: + + external-to-vpc + Ranges created with EXTERNAL_TO_VPC cannot be associated with cloud + resources and are meant to block out address ranges for various use + cases, like for example, usage on-prem, with dynamic route + announcements via interconnect. + + for-vpc + A cloud resource can use the reserved CIDR block by associating it + with the internal range resource if usage is set to FOR_VPC. + +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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud alpha network-connectivity internal-ranges create + diff --git a/gcloud/network-connectivity/internal-ranges/delete b/gcloud/network-connectivity/internal-ranges/delete new file mode 100644 index 000000000..711cc32cc --- /dev/null +++ b/gcloud/network-connectivity/internal-ranges/delete @@ -0,0 +1,68 @@ +NAME + gcloud network-connectivity internal-ranges delete - delete an internal + range + +SYNOPSIS + gcloud network-connectivity internal-ranges delete + (INTERNAL_RANGE : --region=REGION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified internal range. + +EXAMPLES + Delete an internal range named my-range: + + $ gcloud network-connectivity internal-ranges delete my-range + +POSITIONAL ARGUMENTS + Internal range resource - Name of the internal range to be deleted. 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 internal_range on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + INTERNAL_RANGE + ID of the internal range or fully qualified identifier for the + internal range. To set the internal_range attribute: + ▸ provide the argument internal_range on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location ID. + + To set the region attribute: + ▸ provide the argument internal_range on the command line with a + fully specified name; + ▸ provide the argument --region on the command line; + ▸ use default global location . + +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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud alpha network-connectivity internal-ranges delete + diff --git a/gcloud/network-connectivity/internal-ranges/describe b/gcloud/network-connectivity/internal-ranges/describe new file mode 100644 index 000000000..450c4455f --- /dev/null +++ b/gcloud/network-connectivity/internal-ranges/describe @@ -0,0 +1,63 @@ +NAME + gcloud network-connectivity internal-ranges describe - describe an internal + range + +SYNOPSIS + gcloud network-connectivity internal-ranges describe + (INTERNAL_RANGE : --region=REGION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve and display details about an internal range. + +EXAMPLES + Display details about an internal range named my-range: + + $ gcloud network-connectivity internal-ranges describe my-range + +POSITIONAL ARGUMENTS + Internal range resource - Name of the internal range to be described. 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 internal_range on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + INTERNAL_RANGE + ID of the internal range or fully qualified identifier for the + internal range. To set the internal_range attribute: + ▸ provide the argument internal_range on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location ID. + + To set the region attribute: + ▸ provide the argument internal_range on the command line with a + fully specified name; + ▸ provide the argument --region on the command line; + ▸ use default global location . + +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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud alpha network-connectivity internal-ranges describe + diff --git a/gcloud/network-connectivity/internal-ranges/help b/gcloud/network-connectivity/internal-ranges/help new file mode 100644 index 000000000..7f3d7c550 --- /dev/null +++ b/gcloud/network-connectivity/internal-ranges/help @@ -0,0 +1,37 @@ +NAME + gcloud network-connectivity internal-ranges - manage internal ranges + +SYNOPSIS + gcloud network-connectivity internal-ranges COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage internal ranges. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a new internal range. + + delete + Delete an internal range. + + describe + Describe an internal range. + + list + List internal ranges. + + update + Update an internal range. + +NOTES + This variant is also available: + + $ gcloud alpha network-connectivity internal-ranges + diff --git a/gcloud/network-connectivity/internal-ranges/list b/gcloud/network-connectivity/internal-ranges/list new file mode 100644 index 000000000..c8076ed87 --- /dev/null +++ b/gcloud/network-connectivity/internal-ranges/list @@ -0,0 +1,78 @@ +NAME + gcloud network-connectivity internal-ranges list - list internal ranges + +SYNOPSIS + gcloud network-connectivity internal-ranges list [--region=REGION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve and display a list of all internal ranges in the specified + project. + +EXAMPLES + List all internal ranges: + + $ gcloud network-connectivity internal-ranges list + +FLAGS + Region resource - Location of the internal ranges to display. 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; + ◆ use default global location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --region=REGION + ID of the region or fully qualified identifier for the region. To set + the region attribute: + ▸ provide the argument --region on the command line; + ▸ use default global location . + +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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud alpha network-connectivity internal-ranges list + diff --git a/gcloud/network-connectivity/internal-ranges/update b/gcloud/network-connectivity/internal-ranges/update new file mode 100644 index 000000000..538325999 --- /dev/null +++ b/gcloud/network-connectivity/internal-ranges/update @@ -0,0 +1,86 @@ +NAME + gcloud network-connectivity internal-ranges update - update an internal + range + +SYNOPSIS + gcloud network-connectivity internal-ranges update + (INTERNAL_RANGE : --region=REGION) + (--ip-cidr-range=IP_CIDR_RANGE | --prefix-length=PREFIX_LENGTH) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update the details of an internal range. + +EXAMPLES + Update ip-cidr-range of an internal range named my-range: + + $ gcloud network-connectivity internal-ranges update my-range \ + --ip-cidr-range="192.168.0.0/24" + + Extend an internal range named my-range to an address block of /24: + + $ gcloud network-connectivity internal-ranges update my-range \ + --prefix-length=24 + +POSITIONAL ARGUMENTS + Internal range resource - Name of the internal range to be created. 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 internal_range on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + INTERNAL_RANGE + ID of the internal range or fully qualified identifier for the + internal range. To set the internal_range attribute: + ▸ provide the argument internal_range on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The location ID. + + To set the region attribute: + ▸ provide the argument internal_range on the command line with a + fully specified name; + ▸ provide the argument --region on the command line; + ▸ use default global location . + +REQUIRED FLAGS + Exactly one of these must be specified: + + --ip-cidr-range=IP_CIDR_RANGE + IP range that this internal range defines. + + --prefix-length=PREFIX_LENGTH + An alternative to ip-cidr-range. Can be set when trying to create a + reservation that automatically finds a free range of the given size. + +OPTIONAL 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 networkconnectivity/v1 API. The full documentation + for this API can be found at: + https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest + +NOTES + This variant is also available: + + $ gcloud alpha network-connectivity internal-ranges update + diff --git a/gcloud/network-management/connectivity-tests/create b/gcloud/network-management/connectivity-tests/create index f3894f521..874570932 100644 --- a/gcloud/network-management/connectivity-tests/create +++ b/gcloud/network-management/connectivity-tests/create @@ -8,7 +8,9 @@ SYNOPSIS --destination-gke-master-cluster=DESTINATION_GKE_MASTER_CLUSTER --destination-instance=DESTINATION_INSTANCE --destination-ip-address=DESTINATION_IP_ADDRESS) - (--source-cloud-function=SOURCE_CLOUD_FUNCTION + (--source-app-engine-version=SOURCE_APP_ENGINE_VERSION + --source-cloud-function=SOURCE_CLOUD_FUNCTION + --source-cloud-run-revision=SOURCE_CLOUD_RUN_REVISION --source-cloud-sql-instance=SOURCE_CLOUD_SQL_INSTANCE --source-gke-master-cluster=SOURCE_GKE_MASTER_CLUSTER --source-instance=SOURCE_INSTANCE @@ -72,9 +74,15 @@ REQUIRED FLAGS At least one of these must be specified: + --source-app-engine-version=SOURCE_APP_ENGINE_VERSION + App Engine version URI as the source endpoint. + --source-cloud-function=SOURCE_CLOUD_FUNCTION A Cloud function URI as the source endpoint. + --source-cloud-run-revision=SOURCE_CLOUD_RUN_REVISION + Cloud Run revision URI as the source endpoint. + --source-cloud-sql-instance=SOURCE_CLOUD_SQL_INSTANCE A Cloud SQL instance URI as the source endpoint. diff --git a/gcloud/network-management/connectivity-tests/update b/gcloud/network-management/connectivity-tests/update index 8fb1a5bd8..5576380ce 100644 --- a/gcloud/network-management/connectivity-tests/update +++ b/gcloud/network-management/connectivity-tests/update @@ -20,8 +20,12 @@ SYNOPSIS | --destination-instance=DESTINATION_INSTANCE] [--clear-destination-ip-address | --destination-ip-address=DESTINATION_IP_ADDRESS] + [--clear-source-app-engine-version + | --source-app-engine-version=SOURCE_APP_ENGINE_VERSION] [--clear-source-cloud-function | --source-cloud-function=SOURCE_CLOUD_FUNCTION] + [--clear-source-cloud-run-revision + | --source-cloud-run-revision=SOURCE_CLOUD_RUN_REVISION] [--clear-source-cloud-sql-instance | --source-cloud-sql-instance=SOURCE_CLOUD_SQL_INSTANCE] [--clear-source-gke-master-cluster @@ -137,6 +141,14 @@ FLAGS internal IP. An IPv6 address is only allowed when the test's destination is a global load balancer VIP. + At most one of these can be specified: + + --clear-source-app-engine-version + Clear existing source App Engine version. + + --source-app-engine-version=SOURCE_APP_ENGINE_VERSION + App Engine version URI as the source endpoint. + At most one of these can be specified: --clear-source-cloud-function @@ -145,6 +157,14 @@ FLAGS --source-cloud-function=SOURCE_CLOUD_FUNCTION A Cloud function URI as the source endpoint. + At most one of these can be specified: + + --clear-source-cloud-run-revision + Clear existing source Cloud Run revision. + + --source-cloud-run-revision=SOURCE_CLOUD_RUN_REVISION + Cloud Run revision URI as the source endpoint. + At most one of these can be specified: --clear-source-cloud-sql-instance diff --git a/gcloud/network-management/help b/gcloud/network-management/help index 83759e6fd..fde17cb52 100644 --- a/gcloud/network-management/help +++ b/gcloud/network-management/help @@ -22,7 +22,9 @@ GROUPS Manage Network Management operations. NOTES - This variant is also available: + These variants are also available: + + $ gcloud alpha network-management $ gcloud beta network-management diff --git a/gcloud/notebooks/instances/create b/gcloud/notebooks/instances/create index 093a0ecfb..29a04db8b 100644 --- a/gcloud/notebooks/instances/create +++ b/gcloud/notebooks/instances/create @@ -15,6 +15,8 @@ SYNOPSIS [--metadata=[KEY=VALUE,...]] [--post-startup-script=POST_STARTUP_SCRIPT] [--service-account=SERVICE_ACCOUNT] + [--no-shielded-integrity-monitoring] [--shielded-secure-boot] + [--no-shielded-vtpm] [--accelerator-core-count=ACCELERATOR_CORE_COUNT --accelerator-type=ACCELERATOR_TYPE] [--boot-disk-size=BOOT_DISK_SIZE --boot-disk-type=BOOT_DISK_TYPE] @@ -23,7 +25,9 @@ SYNOPSIS : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT]] [--network=NETWORK : --no-proxy-access --no-public-ip [--subnet=SUBNET - : --subnet-region=SUBNET_REGION]] [GCLOUD_WIDE_FLAG ...] + : --subnet-region=SUBNET_REGION]] + [--reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; + default="TYPE_UNSPECIFIED"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Request for creating notebook instances. @@ -181,6 +185,17 @@ OPTIONAL FLAGS the instance. If not specified, the Compute Engine default service account is used. + --shielded-integrity-monitoring + Enable monitoring of the boot integrity of the instance. Enabled by + default, use --no-shielded-integrity-monitoring to disable. + + --shielded-secure-boot + Boot instance with secure boot enabled. Disabled by default. + + --shielded-vtpm + Boot instance with TPM (Trusted Platform Module) enabled. Enabled by + default, use --no-shielded-vtpm to disable. + The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has enough vCPUs and memory to support the `machine_type` you have selected. @@ -307,6 +322,17 @@ OPTIONAL FLAGS specified name; ▫ provide the argument --subnet-region on the command line. + Specifies the reservation for the instance. + + --reservation=RESERVATION + The name of the reservation, required when + --reservation-affinity=SPECIFIC_RESERVATION. + + --reservation-affinity=RESERVATION_AFFINITY; default="TYPE_UNSPECIFIED" + The type of reservation for the instance. RESERVATION_AFFINITY must + be one of: TYPE_UNSPECIFIED, NO_RESERVATION, ANY_RESERVATION, + SPECIFIC_RESERVATION. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/notebooks/instances/diagnose b/gcloud/notebooks/instances/diagnose new file mode 100644 index 000000000..7a1f14359 --- /dev/null +++ b/gcloud/notebooks/instances/diagnose @@ -0,0 +1,104 @@ +NAME + gcloud notebooks instances diagnose - request for diagnose instances + +SYNOPSIS + gcloud notebooks instances diagnose (INSTANCE : --location=LOCATION) + --gcs-bucket=GCS_BUCKET [--async] [--enable-copy-home-files] + [--enable-packet-capture] [--enable-repair] + [--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Request for diagnose notebook instances. + +EXAMPLES + To diagnose an instance, run: + + $ gcloud notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket + + To diagnose an instance with a relative path: + + $ gcloud notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket \ + --relative-path=logs + + To diagnose an instance, with packet capture: + + $ gcloud notebooks instances diagnose example-instance \ + --location=us-west1-b --gcs-bucket=gs://example-bucket \ + --enable-packet-capture + +POSITIONAL ARGUMENTS + Instance resource - User-defined unique name of this instance. The + instance name must be 1 to 63 characters long and contain only lowercase + letters, numeric characters, and dashes. The first character must be a + lowercase letter and the last character cannot be a dash. 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 instance 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. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. To + set the instance attribute: + ▸ provide the argument instance on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location of this environment + https://cloud.google.com/compute/docs/regions-zones/#locations. To + set the location attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property notebooks/location. + +REQUIRED FLAGS + --gcs-bucket=GCS_BUCKET + The Cloud Storage bucket where the log files generated from the + diagnose command will be stored. storage.buckets.writer permissions + must be given to project's service account or user credential. Format: + gs://{gcs_bucket} + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --enable-copy-home-files + Enables flag to copy all /home/jupyter folder contents + + --enable-packet-capture + Enables flag to capture packets from the instance for 30 seconds + + --enable-repair + Enables flag to repair service for instance + + --relative-path=RELATIVE_PATH + Defines the relative storage path in the Cloud Storage bucket where the + diagnostic logs will be written. Default path will be the root + directory of the Cloud Storage bucketFormat of full path: + gs://{gcs_bucket}/{relative_path}/ + +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 notebooks instances diagnose + + $ gcloud beta notebooks instances diagnose + diff --git a/gcloud/notebooks/instances/help b/gcloud/notebooks/instances/help index dc58897f6..e02323ba1 100644 --- a/gcloud/notebooks/instances/help +++ b/gcloud/notebooks/instances/help @@ -27,6 +27,9 @@ COMMANDS describe Request for describing instances. + diagnose + Request for diagnose instances. + get-health Request for checking if a notebook instance is healthy. diff --git a/gcloud/notebooks/runtimes/create b/gcloud/notebooks/runtimes/create index 35eeb3bb3..aff8a2ad5 100644 --- a/gcloud/notebooks/runtimes/create +++ b/gcloud/notebooks/runtimes/create @@ -24,7 +24,7 @@ EXAMPLES $ gcloud notebooks runtimes create example-runtime \ --runtime-access-type=SINGLE_USER \ --runtime-owner=example@google.com \ - --machine-type=n1-standard-4 --location=us-central1-b + --machine-type=n1-standard-4 --location=us-central1 POSITIONAL ARGUMENTS Runtime resource - User-defined unique name of this runtime. The runtime @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/notebooks/runtimes/delete b/gcloud/notebooks/runtimes/delete index 7f4a187bc..67a1b889c 100644 --- a/gcloud/notebooks/runtimes/delete +++ b/gcloud/notebooks/runtimes/delete @@ -12,7 +12,7 @@ EXAMPLES To delete a runtime, run: $ gcloud notebooks runtimes delete example-runtime \ - --location=us-central1-b + --location=us-central1 POSITIONAL ARGUMENTS Runtime resource - User-defined unique name of this runtime. The runtime @@ -31,7 +31,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/notebooks/runtimes/describe b/gcloud/notebooks/runtimes/describe index 0ab1e0190..b70963ec2 100644 --- a/gcloud/notebooks/runtimes/describe +++ b/gcloud/notebooks/runtimes/describe @@ -12,7 +12,7 @@ EXAMPLES To describe a runtime, run: $ gcloud notebooks runtimes describe example-runtime \ - --location=us-central1-b + --location=us-central1 POSITIONAL ARGUMENTS Runtime resource - User-defined unique name of this runtime. The runtime @@ -31,7 +31,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/notebooks/runtimes/diagnose b/gcloud/notebooks/runtimes/diagnose new file mode 100644 index 000000000..e5a3db3dd --- /dev/null +++ b/gcloud/notebooks/runtimes/diagnose @@ -0,0 +1,96 @@ +NAME + gcloud notebooks runtimes diagnose - request for diagnose runtimes + +SYNOPSIS + gcloud notebooks runtimes diagnose (RUNTIME : --location=LOCATION) + --gcs-bucket=GCS_BUCKET [--async] [--enable-copy-home-files] + [--enable-packet-capture] [--enable-repair] + [--relative-path=RELATIVE_PATH] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Request for diagnose notebook runtimes. + +EXAMPLES + To diagnose an runtime, run: + + $ gcloud notebooks runtimes diagnose example-runtime \ + --location=us-central1 --gcs-bucket=gs://example-bucket + + To diagnose an runtime with a relative path: + + $ gcloud notebooks runtimes diagnose example-runtime \ + --location=us-central1 --gcs-bucket=gs://example-bucket \ + --relative-path=logs + + To diagnose an runtime, with packet capture: + + $ gcloud notebooks runtimes diagnose example-runtime \ + --location=us-central1 --gcs-bucket=gs://example-bucket \ + --enable-packet-capture + +POSITIONAL ARGUMENTS + Runtime resource - User-defined unique name of this runtime. The runtime + name must be 1 to 63 characters long and contain only lowercase letters, + numeric characters, and dashes. The first character must be a lowercase + letter and the last character cannot be a dash. 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 runtime 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. + + RUNTIME + ID of the runtime or fully qualified identifier for the runtime. To + set the runtime attribute: + ▸ provide the argument runtime on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location of this runtime + https://cloud.google.com/compute/docs/regions-zones/#locations. To + set the location attribute: + ▸ provide the argument runtime on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property notebooks/location. + +REQUIRED FLAGS + --gcs-bucket=GCS_BUCKET + The Cloud Storage bucket where the log files generated from the + diagnose command will be stored. storage.buckets.writer permissions + must be given to project's service account or user credential. Format: + gs://{gcs_bucket} + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --enable-copy-home-files + Enables flag to copy all /home/jupyter folder contents + + --enable-packet-capture + Enables flag to capture packets from the runtime for 30 seconds + + --enable-repair + Enables flag to repair service for runtime + + --relative-path=RELATIVE_PATH + Defines the relative storage path in the Cloud Storage bucket where the + diagnostic logs will be written. Default path will be the root + directory of the Cloud Storage bucketFormat of full path: + gs://{gcs_bucket}/{relative_path}/ + +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. diff --git a/gcloud/notebooks/runtimes/help b/gcloud/notebooks/runtimes/help index a8df1387c..52da3166e 100644 --- a/gcloud/notebooks/runtimes/help +++ b/gcloud/notebooks/runtimes/help @@ -24,6 +24,9 @@ COMMANDS describe Request for describing runtimes. + diagnose + Request for diagnose runtimes. + list Request for listing runtimes. diff --git a/gcloud/notebooks/runtimes/list b/gcloud/notebooks/runtimes/list index 74a1d57a3..b01309d88 100644 --- a/gcloud/notebooks/runtimes/list +++ b/gcloud/notebooks/runtimes/list @@ -12,7 +12,7 @@ DESCRIPTION EXAMPLES To list runtimes in a particular location, run: - $ gcloud notebooks runtimes list --location=us-central1-a + $ gcloud notebooks runtimes list --location=us-central1 FLAGS Location resource - Location of this runtime. For example, us-central1-a diff --git a/gcloud/notebooks/runtimes/reset b/gcloud/notebooks/runtimes/reset index a2d74cd19..ae95a77fe 100644 --- a/gcloud/notebooks/runtimes/reset +++ b/gcloud/notebooks/runtimes/reset @@ -12,7 +12,7 @@ EXAMPLES To reset a runtime, run: $ gcloud notebooks runtimes reset example-runtime \ - --location=us-central1-a + --location=us-central1 POSITIONAL ARGUMENTS Runtime resource - User-defined unique name of this runtime. The runtime @@ -31,7 +31,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/notebooks/runtimes/start b/gcloud/notebooks/runtimes/start index 26815235a..8c1fbd606 100644 --- a/gcloud/notebooks/runtimes/start +++ b/gcloud/notebooks/runtimes/start @@ -12,7 +12,7 @@ EXAMPLES To start a runtime, run: $ gcloud notebooks runtimes start example-runtime \ - --location=us-central1-a + --location=us-central1 POSITIONAL ARGUMENTS Runtime resource - User-defined unique name of this runtime. The runtime @@ -31,7 +31,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/notebooks/runtimes/stop b/gcloud/notebooks/runtimes/stop index a138ac2a0..14ed701f4 100644 --- a/gcloud/notebooks/runtimes/stop +++ b/gcloud/notebooks/runtimes/stop @@ -12,7 +12,7 @@ EXAMPLES To stop a runtime, run: $ gcloud notebooks runtimes stop example-runtime \ - --location=us-central1-a + --location=us-central1 POSITIONAL ARGUMENTS Runtime resource - User-defined unique name of this runtime. The runtime @@ -31,7 +31,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/notebooks/runtimes/switch b/gcloud/notebooks/runtimes/switch index 3d3f1fbf8..28fbfa601 100644 --- a/gcloud/notebooks/runtimes/switch +++ b/gcloud/notebooks/runtimes/switch @@ -33,7 +33,7 @@ POSITIONAL ARGUMENTS RUNTIME ID of the runtime or fully qualified identifier for the runtime. To - set the rumtime attribute: + set the runtime attribute: ▸ provide the argument runtime on the command line. This positional argument must be specified if any of the other diff --git a/gcloud/pubsub/lite-subscriptions/create b/gcloud/pubsub/lite-subscriptions/create index 80b95238e..386745f25 100644 --- a/gcloud/pubsub/lite-subscriptions/create +++ b/gcloud/pubsub/lite-subscriptions/create @@ -6,7 +6,11 @@ SYNOPSIS gcloud pubsub lite-subscriptions create SUBSCRIPTION --topic=TOPIC [--delivery-requirement=DELIVERY_REQUIREMENT; default="deliver-immediately"] [--location=LOCATION] - [--starting-offset=STARTING_OFFSET; default="end"] + [--event-time=EVENT_TIME | --publish-time=PUBLISH_TIME + | --starting-offset=STARTING_OFFSET; default="end"] + [--export-pubsub-topic=EXPORT_PUBSUB_TOPIC + : --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + --export-desired-state=EXPORT_DESIRED_STATE; default="active"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -25,6 +29,13 @@ EXAMPLES --location=us-central1-a --topic=mytopic \ --starting-offset=beginning + To create a Pub/Sub Lite subscription that exports messages from a Pub/Sub + Lite topic to a Pub/Sub topic, run: + + $ gcloud pubsub lite-subscriptions create mysubscription \ + --location=us-central1-a --topic=mytopic \ + --export-pubsub-topic=pubsubtopic + POSITIONAL ARGUMENTS SUBSCRIPTION Subscription ID. @@ -58,11 +69,43 @@ OPTIONAL FLAGS ▸ provide the argument --location on the command line; ▸ provide the argument --zone on the command line. - --starting-offset=STARTING_OFFSET; default="end" - The offset at which a newly created or seeked subscription will start - receiving messages. A subscription can be initialized at the offset of - the oldest retained message (beginning), or at the current HEAD offset - (end). STARTING_OFFSET must be one of: beginning, end. + At most one of these can be specified: + + --event-time=EVENT_TIME + The event time to which you seek a subscription. The subscription + seeks to the first message with event time greater than or equal to + the specified event time. Messages missing an event time use publish + time as a fallback. As event times are user supplied, subsequent + messages may have event times less than the specified event time and + must be filtered by the client, if necessary. Run $ gcloud topic + datetimes for information on time formats. + + --publish-time=PUBLISH_TIME + The publish time to which you seek a subscription. Messages with + publish time greater than or equal to the specified time are + delivered after the seek operation. Run $ gcloud topic datetimes for + information on time formats. + + --starting-offset=STARTING_OFFSET; default="end" + The offset at which a newly created or seeked subscription starts + receiving messages. A subscription can be initialized at the offset + of the oldest retained message (beginning), or at the current HEAD + offset (end). STARTING_OFFSET must be one of: beginning, end. + + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC + The name of the destination Pub/Sub topic to which messages are + exported. Must be the topic's fully specified path if it is not in the + same project as the subscription to be created. + + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + The name of the Pub/Sub Lite topic to write messages that cannot be + exported. Must be in the same project and location as the subscription + to be created. Note that this is a Lite topic. + + --export-desired-state=EXPORT_DESIRED_STATE; default="active" + The desired state of the export. Process messages by setting the value + to ACTIVE or pause message processing by setting the value to PAUSED. + EXPORT_DESIRED_STATE must be one of: active, paused. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/pubsub/lite-subscriptions/seek b/gcloud/pubsub/lite-subscriptions/seek index fd3305cdf..2f256daa3 100644 --- a/gcloud/pubsub/lite-subscriptions/seek +++ b/gcloud/pubsub/lite-subscriptions/seek @@ -63,21 +63,22 @@ REQUIRED FLAGS Exactly one of these must be specified: --event-time=EVENT_TIME - The event time to seek a subscription to. Seeks to the first message - with event time greater than or equal to the specified event time. As - event times are user supplied, subsequent messages may have event - times less than the specified event time and should be filtered by - the client, if necessary. Messages missing an event time use publish - time as a fallback. Run $ gcloud topic datetimes for information on - time formats. + The event time to which you seek a subscription. The subscription + seeks to the first message with event time greater than or equal to + the specified event time. Messages missing an event time use publish + time as a fallback. As event times are user supplied, subsequent + messages may have event times less than the specified event time and + must be filtered by the client, if necessary. Run $ gcloud topic + datetimes for information on time formats. --publish-time=PUBLISH_TIME - The publish time to seek a subscription to. Messages with publish - time greater than or equal to this time will be delivered post-seek. - Run $ gcloud topic datetimes for information on time formats. + The publish time to which you seek a subscription. Messages with + publish time greater than or equal to the specified time are + delivered after the seek operation. Run $ gcloud topic datetimes for + information on time formats. --starting-offset=STARTING_OFFSET - The offset at which a newly created or seeked subscription will start + The offset at which a newly created or seeked subscription starts receiving messages. A subscription can be initialized at the offset of the oldest retained message (beginning), or at the current HEAD offset (end). STARTING_OFFSET must be one of: beginning, end. diff --git a/gcloud/pubsub/lite-subscriptions/update b/gcloud/pubsub/lite-subscriptions/update index c48c6d2e2..e03d179b7 100644 --- a/gcloud/pubsub/lite-subscriptions/update +++ b/gcloud/pubsub/lite-subscriptions/update @@ -5,13 +5,16 @@ NAME SYNOPSIS gcloud pubsub lite-subscriptions update (SUBSCRIPTION : --location=LOCATION) - --delivery-requirement=DELIVERY_REQUIREMENT [GCLOUD_WIDE_FLAG ...] + (--delivery-requirement=DELIVERY_REQUIREMENT + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + --export-desired-state=EXPORT_DESIRED_STATE + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC) [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update a Pub/Sub Lite subscription. EXAMPLES - To update a Cloud Pub/Sub lite-subscription, run: + To update a Pub/Sub Lite subscription, run: $ gcloud pubsub lite-subscriptions update mysubscription \ --location=us-central1-a \ @@ -47,12 +50,29 @@ POSITIONAL ARGUMENTS ▸ provide the argument --zone on the command line. REQUIRED FLAGS - --delivery-requirement=DELIVERY_REQUIREMENT - When this subscription should send messages to subscribers relative to - messages persistence in storage. See - https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions - for more info. DELIVERY_REQUIREMENT must be one of: - deliver-after-stored, deliver-immediately. + At least one of these must be specified: + + --delivery-requirement=DELIVERY_REQUIREMENT + When this subscription should send messages to subscribers relative + to messages persistence in storage. See + https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions + for more info. DELIVERY_REQUIREMENT must be one of: + deliver-after-stored, deliver-immediately. + + --export-dead-letter-topic=EXPORT_DEAD_LETTER_TOPIC + The name of the Pub/Sub Lite topic to write messages that cannot be + exported. Must be in the same project and location as the + subscription to be created. Note that this is a Lite topic. + + --export-desired-state=EXPORT_DESIRED_STATE + The desired state of the export. Process messages by setting the + value to ACTIVE or pause message processing by setting the value to + PAUSED. EXPORT_DESIRED_STATE must be one of: active, paused. + + --export-pubsub-topic=EXPORT_PUBSUB_TOPIC + The name of the destination Pub/Sub topic to which messages are + exported. Must be the topic's fully specified path if it is not in + the same project as the subscription to be created. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/pubsub/subscriptions/create b/gcloud/pubsub/subscriptions/create index 1c973e1cd..a0504a7b8 100644 --- a/gcloud/pubsub/subscriptions/create +++ b/gcloud/pubsub/subscriptions/create @@ -5,9 +5,9 @@ NAME SYNOPSIS gcloud pubsub subscriptions create SUBSCRIPTION [SUBSCRIPTION ...] (--topic=TOPIC : --topic-project=TOPIC_PROJECT) - [--ack-deadline=ACK_DEADLINE] [--enable-message-ordering] - [--expiration-period=EXPIRATION_PERIOD] [--labels=[KEY=VALUE,...]] - [--message-filter=MESSAGE_FILTER] + [--ack-deadline=ACK_DEADLINE] [--enable-exactly-once-delivery] + [--enable-message-ordering] [--expiration-period=EXPIRATION_PERIOD] + [--labels=[KEY=VALUE,...]] [--message-filter=MESSAGE_FILTER] [--message-retention-duration=MESSAGE_RETENTION_DURATION] [--push-auth-service-account=SERVICE_ACCOUNT_EMAIL] [--push-auth-token-audience=OPTIONAL_AUDIENCE_OVERRIDE] @@ -72,6 +72,14 @@ OPTIONAL FLAGS The number of seconds the system will wait for a subscriber to acknowledge receiving a message before re-attempting delivery. + --enable-exactly-once-delivery + Whether or not to enable exactly-once delivery on the subscription. If + true, Pub/Sub provides the following guarantees for the delivery of a + message with a given value of message_id on this subscription: The + message sent to a subscriber is guaranteed not to be resent before the + message's acknowledgment deadline expires. An acknowledged message will + not be resent to a subscriber. + --enable-message-ordering Whether to receive messages with the same ordering key in order. If set, messages with the same ordering key are sent to subscribers in the diff --git a/gcloud/pubsub/subscriptions/update b/gcloud/pubsub/subscriptions/update index de2c6fe6b..8d295fc1e 100644 --- a/gcloud/pubsub/subscriptions/update +++ b/gcloud/pubsub/subscriptions/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud pubsub subscriptions update SUBSCRIPTION - [--ack-deadline=ACK_DEADLINE] [--expiration-period=EXPIRATION_PERIOD] + [--ack-deadline=ACK_DEADLINE] [--enable-exactly-once-delivery] + [--expiration-period=EXPIRATION_PERIOD] [--message-retention-duration=MESSAGE_RETENTION_DURATION] [--push-auth-service-account=SERVICE_ACCOUNT_EMAIL] [--push-auth-token-audience=OPTIONAL_AUDIENCE_OVERRIDE] @@ -45,6 +46,15 @@ FLAGS The number of seconds the system will wait for a subscriber to acknowledge receiving a message before re-attempting delivery. + --enable-exactly-once-delivery + Whether or not to enable exactly-once delivery on the subscription. If + true, Pub/Sub provides the following guarantees for the delivery of a + message with a given value of message_id on this subscription: The + message sent to a subscriber is guaranteed not to be resent before the + message's acknowledgment deadline expires. An acknowledged message will + not be resent to a subscriber. To disable exactly-once delivery use + --no-enable-exactly-once-delivery. + --expiration-period=EXPIRATION_PERIOD The subscription will expire if it is inactive for the given period. Valid values are strings of the form INTEGER[UNIT], where UNIT is one diff --git a/gcloud/recommender/insight-type-config/describe b/gcloud/recommender/insight-type-config/describe index ca1ace004..3bc5c68a3 100644 --- a/gcloud/recommender/insight-type-config/describe +++ b/gcloud/recommender/insight-type-config/describe @@ -5,12 +5,12 @@ NAME SYNOPSIS gcloud recommender insight-type-config describe INSIGHT_TYPE --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...] DESCRIPTION Describe an insight type configuration based on a given entity (project, - organization), location, and insight type. + organization, billing account), location, and insight type. EXAMPLES To describe an insight type configuration, run: @@ -30,6 +30,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/recommender/insight-type-config/update b/gcloud/recommender/insight-type-config/update index 403fb15c9..bfc884789 100644 --- a/gcloud/recommender/insight-type-config/update +++ b/gcloud/recommender/insight-type-config/update @@ -5,13 +5,14 @@ NAME SYNOPSIS gcloud recommender insight-type-config update INSIGHT_TYPE --etag=ETAG --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [--annotations=KEY=VALUE,[KEY=VALUE,...]] [--config-file=CONFIG_FILE] - [--display-name=DISPLAY_NAME] [--validate-only] [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [--annotations=KEY=VALUE,[KEY=VALUE,...]] + [--config-file=CONFIG_FILE] [--display-name=DISPLAY_NAME] + [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update an insight type configuration based on a given entity (project, - organization), location, and insight type. + organization, billing account), location, and insight type. EXAMPLES To update an insight type configuration, run: @@ -35,6 +36,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/recommender/recommender-config/describe b/gcloud/recommender/recommender-config/describe index 7fff674eb..998479337 100644 --- a/gcloud/recommender/recommender-config/describe +++ b/gcloud/recommender/recommender-config/describe @@ -5,12 +5,12 @@ NAME SYNOPSIS gcloud recommender recommender-config describe RECOMMENDER --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [GCLOUD_WIDE_FLAG ...] DESCRIPTION Describe a recommender configuration based on a given entity (project, - organization), location, and recommender. + organization, billing account), location, and recommender. EXAMPLES To describe a recommender configuration, run: @@ -30,6 +30,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/recommender/recommender-config/update b/gcloud/recommender/recommender-config/update index 3d21da90b..15ce56f9c 100644 --- a/gcloud/recommender/recommender-config/update +++ b/gcloud/recommender/recommender-config/update @@ -5,13 +5,14 @@ NAME SYNOPSIS gcloud recommender recommender-config update RECOMMENDER --etag=ETAG --location=LOCATION - (--organization=ORGANIZATION_ID | --project=PROJECT_ID) - [--annotations=KEY=VALUE,[KEY=VALUE,...]] [--config-file=CONFIG_FILE] - [--display-name=DISPLAY_NAME] [--validate-only] [GCLOUD_WIDE_FLAG ...] + (--billing-account=BILLING_ACCOUNT | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [--annotations=KEY=VALUE,[KEY=VALUE,...]] + [--config-file=CONFIG_FILE] [--display-name=DISPLAY_NAME] + [--validate-only] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Update a recommender configuration based on a given entity (project, - organization), location, and recommender. + organization, billing account), location, and recommender. EXAMPLES To update a recommender configuration, run: @@ -35,6 +36,9 @@ REQUIRED FLAGS Exactly one of these must be specified: + --billing-account=BILLING_ACCOUNT + The Google Cloud billing account ID to use for this invocation. + --organization=ORGANIZATION_ID The Google Cloud organization ID to use for this invocation. diff --git a/gcloud/run/deploy b/gcloud/run/deploy index 9b54835f9..46e7fd8f0 100644 --- a/gcloud/run/deploy +++ b/gcloud/run/deploy @@ -23,6 +23,7 @@ SYNOPSIS [--image=IMAGE | --source=SOURCE] [--[no-]allow-unauthenticated --breakglass=JUSTIFICATION --clear-vpc-connector --[no-]cpu-throttling --description=DESCRIPTION + --execution-environment=EXECUTION_ENVIRONMENT --revision-suffix=REVISION_SUFFIX --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -210,7 +211,10 @@ FLAGS --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. + 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 @@ -380,6 +384,15 @@ FLAGS --description=DESCRIPTION Provides an optional, human-readable description of the service. + --execution-environment=EXECUTION_ENVIRONMENT + Selects the execution environment where the application will run. + EXECUTION_ENVIRONMENT must be one of: + + gen1 + Run the application in a first generation execution environment. + gen2 + Run the application in a second generation execution environment. + --revision-suffix=REVISION_SUFFIX Specify the suffix of the revision name. Revision names always start with the service name automatically. For example, specifying diff --git a/gcloud/run/services/update b/gcloud/run/services/update index a8aedd813..159bb9e0b 100644 --- a/gcloud/run/services/update +++ b/gcloud/run/services/update @@ -12,6 +12,7 @@ SYNOPSIS [--service-account=SERVICE_ACCOUNT] [--tag=TAG] [--timeout=TIMEOUT] [--no-traffic] [--[no-]use-http2] [--breakglass=JUSTIFICATION --clear-vpc-connector --[no-]cpu-throttling + --execution-environment=EXECUTION_ENVIRONMENT --revision-suffix=REVISION_SUFFIX --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -213,6 +214,15 @@ FLAGS serving requests. Use --cpu-throttling to enable and --no-cpu-throttling to disable. + --execution-environment=EXECUTION_ENVIRONMENT + Selects the execution environment where the application will run. + EXECUTION_ENVIRONMENT must be one of: + + gen1 + Run the application in a first generation execution environment. + gen2 + Run the application in a second generation execution environment. + --revision-suffix=REVISION_SUFFIX Specify the suffix of the revision name. Revision names always start with the service name automatically. For example, specifying @@ -297,7 +307,10 @@ FLAGS --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. + 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 diff --git a/gcloud/scc/assets/describe b/gcloud/scc/assets/describe index 6da5bb1a7..1ffaf010c 100644 --- a/gcloud/scc/assets/describe +++ b/gcloud/scc/assets/describe @@ -32,15 +32,17 @@ EXAMPLES $ gcloud scc assets describe folders/456/assets/5678 POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. REQUIRED FLAGS Exactly one of these must be specified: diff --git a/gcloud/scc/assets/group b/gcloud/scc/assets/group index ca8a1c8f6..84a3de685 100644 --- a/gcloud/scc/assets/group +++ b/gcloud/scc/assets/group @@ -53,15 +53,17 @@ EXAMPLES --group-by="state_change" POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/scc/assets/list b/gcloud/scc/assets/list index 971f790b0..6aadf8485 100644 --- a/gcloud/scc/assets/list +++ b/gcloud/scc/assets/list @@ -70,15 +70,17 @@ EXAMPLES $ gcloud scc assets list 123456 --compare-duration=86400s POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/scc/findings/create b/gcloud/scc/findings/create index 002028e33..9446e9a44 100644 --- a/gcloud/scc/findings/create +++ b/gcloud/scc/findings/create @@ -4,8 +4,8 @@ NAME SYNOPSIS gcloud scc findings create (FINDING : --organization=ORGANIZATION --source=SOURCE) - --category=CATEGORY --resource-name=RESOURCE_NAME - [--event-time=EVENT_TIME] [--external-uri=EXTERNAL_URI] + --category=CATEGORY --event-time=EVENT_TIME + --resource-name=RESOURCE_NAME [--external-uri=EXTERNAL_URI] [--source-properties=[SOURCE_PROPERTIES,...]] [--state=STATE] [GCLOUD_WIDE_FLAG ...] @@ -18,8 +18,9 @@ EXAMPLES $ gcloud scc findings create my-finding --organization=123456 \ --source=5678 --state=ACTIVE --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' Create an ACTIVE my-finding attached to example-project under project example-project and source 5678: @@ -27,8 +28,9 @@ EXAMPLES $ gcloud scc findings create \ projects/example-project/sources/5678/findings/my-finding \ --state=ACTIVE --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' Create an ACTIVE my-finding attached to example-project under folder 456 and source 5678: @@ -36,8 +38,9 @@ EXAMPLES $ gcloud scc findings create \ folders/456/sources/5678/findings/my-finding --state=ACTIVE \ --category='XSS_SCRIPTING' \ - --resource-name='//cloudresourcemanager.googleapis.com/v1/projec\ - ts/example-project' + --event-time=2023-01-11T07:00:06.861Z \ + --resource-name='//cloudresourcemanager.googleapis.com/projects/\ + example-project' POSITIONAL ARGUMENTS Finding resource - The finding to be used for the SCC (Security Command @@ -82,19 +85,18 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --category=CATEGORY Taxonomy group within findings from a given source. Example: - XSS_FLASH_INJECTION + XSS_SCRIPTING + + --event-time=EVENT_TIME + Time at which the issue is detected or the finding is created, in the + following format: YYYY-MM-DDThh:mm:ss.ffffffZ. Example: + 2023-01-11T07:00:06.861Z --resource-name=RESOURCE_NAME Full resource name of the Google Cloud Platform resource this finding is for. OPTIONAL FLAGS - --event-time=EVENT_TIME - Time at which the event took place. For example, if the finding - represents an open firewall it would capture the time the open firewall - was detected. If event-time is not provided, it will default to UTC - version of NOW. For example 2019-02-28T07:00:00Z - --external-uri=EXTERNAL_URI URI that, if available, points to a web page outside of Cloud SCC (Security Command Center) where additional information about the diff --git a/gcloud/scc/findings/group b/gcloud/scc/findings/group index 1ceb7de87..4eba726de 100644 --- a/gcloud/scc/findings/group +++ b/gcloud/scc/findings/group @@ -54,15 +54,17 @@ EXAMPLES --group-by="state_change" --compare-duration=86400s POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/scc/findings/list b/gcloud/scc/findings/list index cfb4b777e..a5aa45230 100644 --- a/gcloud/scc/findings/list +++ b/gcloud/scc/findings/list @@ -63,15 +63,17 @@ EXAMPLES --filter="state=\"ACTIVE\"" --read-time="2019-01-01T01:00:00Z" POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. FLAGS --compare-duration=COMPARE_DURATION diff --git a/gcloud/scc/notifications/list b/gcloud/scc/notifications/list index f3996f723..33f015e51 100644 --- a/gcloud/scc/notifications/list +++ b/gcloud/scc/notifications/list @@ -25,15 +25,17 @@ EXAMPLES $ gcloud scc notifications list projects/789 POSITIONAL ARGUMENTS - Parent resource - The parent to be used for the SCC (Security Command - Center) command. This represents a Cloud resource. + Parent resource - parent organization, folder, or project in the Google + Cloud resource hierarchy to be used for the gcloud scc command. Specify + the argument as either [RESOURCE_TYPE/RESOURCE_ID] or [RESOURCE_ID], as + shown in the preceding examples. This represents a Cloud resource. [PARENT] ID of the parent or fully qualified identifier for the parent. To set - the organization attribute: + the parent attribute: ▸ provide the argument parent on the command line; ▸ Set the parent property in configuration using gcloud config set - scc/parent if it is not specified in command line.. + scc/parent if it is not specified in command line. LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/services/api-keys/describe b/gcloud/services/api-keys/describe index 44d6a6e02..e7dafd48d 100644 --- a/gcloud/services/api-keys/describe +++ b/gcloud/services/api-keys/describe @@ -9,14 +9,20 @@ DESCRIPTION Describe an API key's metadata. EXAMPLES - To describe an API key: + To describe an API key using Key: - $ gcloud services api-keys describe \ - projects/myproject/locations/global/keys/1234 OR $ gcloud services api-keys describe 1234 OR - $ gcloud services api-keys describe 1234 --project=myproject OR + $ gcloud services api-keys describe \ + projects/myproject/locations/global/keys/1234 + + To describe an API key with key and project: + + $ gcloud services api-keys describe 1234 --project=myproject + + To describe an API key with key, project, and location: + $ gcloud services api-keys describe 1234 --project=myproject \ - --location=global + --location=global POSITIONAL ARGUMENTS Key resource - The name of the key to describe. The arguments in this @@ -54,7 +60,9 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This variant is also available: + These variants are also available: $ gcloud alpha services api-keys describe + $ gcloud beta services api-keys describe + diff --git a/gcloud/services/api-keys/help b/gcloud/services/api-keys/help index 8c0d45d90..ecc878f48 100644 --- a/gcloud/services/api-keys/help +++ b/gcloud/services/api-keys/help @@ -22,7 +22,9 @@ COMMANDS Lists API keys. NOTES - This variant is also available: + These variants are also available: $ gcloud alpha services api-keys + $ gcloud beta services api-keys + diff --git a/gcloud/services/api-keys/list b/gcloud/services/api-keys/list index 26335bf85..b69f4e716 100644 --- a/gcloud/services/api-keys/list +++ b/gcloud/services/api-keys/list @@ -64,7 +64,9 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. NOTES - This variant is also available: + These variants are also available: $ gcloud alpha services api-keys list + $ gcloud beta services api-keys list + diff --git a/gcloud/services/list b/gcloud/services/list index b12927dd5..f415e3316 100644 --- a/gcloud/services/list +++ b/gcloud/services/list @@ -3,8 +3,8 @@ NAME SYNOPSIS gcloud services list [--available | --enabled] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] - [GCLOUD_WIDE_FLAG ...] + [--limit=LIMIT] [--page-size=PAGE_SIZE; default=200] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command lists the services that are enabled or available to be enabled @@ -44,12 +44,11 @@ LIST COMMAND FLAGS flag interacts with other flags that are applied in this order: --flatten, --sort-by, --filter, --limit. - --page-size=PAGE_SIZE + --page-size=PAGE_SIZE; default=200 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. + specifies the maximum number of resources per page. The default is 200. + 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 diff --git a/gcloud/spanner/samples/run b/gcloud/spanner/samples/run index 4681c6995..f67a5689e 100644 --- a/gcloud/spanner/samples/run +++ b/gcloud/spanner/samples/run @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud spanner samples run APPNAME --instance-id=INSTANCE_ID [--no-cleanup] [--database-id=DATABASE_ID] [--duration=DURATION; default="1h"] - [GCLOUD_WIDE_FLAG ...] + [--skip-init] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Each Cloud Spanner sample application includes a backend gRPC service @@ -44,6 +44,9 @@ OPTIONAL FLAGS Duration of time allowed to run the sample app before stopping the service. + --skip-init + Use an existing database instead of creating a new one. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/sql/export/bak b/gcloud/sql/export/bak index cef032de9..38589eee7 100644 --- a/gcloud/sql/export/bak +++ b/gcloud/sql/export/bak @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud sql export bak INSTANCE URI --database=DATABASE,[DATABASE,...], -d - DATABASE,[DATABASE,...] [--async] [GCLOUD_WIDE_FLAG ...] + DATABASE,[DATABASE,...] [--async] [--stripe_count=STRIPE_COUNT] + [--[no-]striped] [GCLOUD_WIDE_FLAG ...] DESCRIPTION Export data from a Cloud SQL instance to a Google Cloud Storage bucket as a @@ -36,6 +37,13 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --stripe_count=STRIPE_COUNT + Specifies the number of stripes to use for SQL Server exports. + + --[no-]striped + Whether SQL Server export should be striped. Use --striped to enable + and --no-striped to disable. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/sql/import/bak b/gcloud/sql/import/bak index c86c5f413..195007c0c 100644 --- a/gcloud/sql/import/bak +++ b/gcloud/sql/import/bak @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud sql import bak INSTANCE URI --database=DATABASE, -d DATABASE - [--async] + [--async] [--[no-]striped] [--cert-path=CERT_PATH --pvk-path=PVK_PATH (--prompt-for-pvk-password | --pvk-password=PVK_PASSWORD)] [GCLOUD_WIDE_FLAG ...] @@ -49,6 +49,10 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --[no-]striped + Whether SQL Server import should be striped. Use --striped to enable + and --no-striped to disable. + Encryption info to support importing an encrypted .bak file --cert-path=CERT_PATH diff --git a/gcloud/sql/instances/clone b/gcloud/sql/instances/clone index 72f45e871..3593393a0 100644 --- a/gcloud/sql/instances/clone +++ b/gcloud/sql/instances/clone @@ -3,8 +3,10 @@ NAME SYNOPSIS gcloud sql instances clone SOURCE DESTINATION [--async] - [--point-in-time=POINT_IN_TIME | --bin-log-file-name=BIN_LOG_FILE_NAME - --bin-log-position=BIN_LOG_POSITION] [GCLOUD_WIDE_FLAG ...] + [--bin-log-file-name=BIN_LOG_FILE_NAME + --bin-log-position=BIN_LOG_POSITION | [--point-in-time=POINT_IN_TIME + : --restore-database-name=RESTORE_DATABASE_NAME]] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud sql instances clone creates a clone of a Cloud SQL instance. The @@ -21,6 +23,10 @@ DESCRIPTION the instance to clone. If not specified, the current state of the instance is cloned. + For SQL Server: The point in time, if specified, defines a past state of + the instance to clone. If not specified, the current state of the instance + is cloned. + EXAMPLES To clone an instance from its current state (most recent binary log coordinates): @@ -43,6 +49,11 @@ EXAMPLES $ gcloud sql instances clone instance-foo instance-bar \ --point-in-time '2012-11-15T16:19:00.094Z' + To clone a SQL Server source instance at a specific point in time: + + $ gcloud sql instances clone instance-foo instance-bar \ + --point-in-time '2012-11-15T16:19:00.094Z' + POSITIONAL ARGUMENTS SOURCE Cloud SQL instance ID of the source. @@ -57,17 +68,6 @@ FLAGS At most one of these can be specified: - --point-in-time=POINT_IN_TIME - Represents the state of an instance at any given point in time inside - a transaction log file. For MySQL, the binary log file is used for - transaction logs. For PostgreSQL, the write-ahead log file is used - for transaction logs. To create a transaction log, enable - point-in-time recovery on the source instance. Instance should have - transaction logs accumulated upto the point in time they want to - restore upto. Uses RFC 3339 format in UTC timezone. If specified, - defines a past state of the instance to clone. For example, - '2012-11-15T16:19:00.094Z'. - Binary log coordinates for point-in-time recovery. --bin-log-file-name=BIN_LOG_FILE_NAME @@ -90,6 +90,26 @@ FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --point-in-time=POINT_IN_TIME + Represents the state of an instance at any given point in time inside + a transaction log file. For MySQL, the binary log file is used for + transaction logs. For PostgreSQL, the write-ahead log file is used + for transaction logs. For SQL Server, the log backup file is used for + such purpose. To create a transaction log, enable point-in-time + recovery on the source instance. Instance should have transaction + logs accumulated up to the point in time they want to restore up to. + Uses RFC 3339 format in UTC timezone. If specified, defines a past + state of the instance to clone. For example, + '2012-11-15T16:19:00.094Z'. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --restore-database-name=RESTORE_DATABASE_NAME + The name of the database to be restored for a point-in-time restore. + If set, the destination instance will only restore the specified + database. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/sql/instances/create b/gcloud/sql/instances/create index ff5686d95..959628b6f 100644 --- a/gcloud/sql/instances/create +++ b/gcloud/sql/instances/create @@ -12,14 +12,15 @@ SYNOPSIS [--availability-type=AVAILABILITY_TYPE] [--no-backup] [--backup-location=BACKUP_LOCATION] [--backup-start-time=BACKUP_START_TIME] [--collation=COLLATION] - [--cpu=CPU] [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]] + [--connector-enforcement=CONNECTOR_ENFORCEMENT] [--cpu=CPU] + [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]] [--database-version=DATABASE_VERSION; default="MYSQL_8_0"] [--[no-]deletion-protection] [--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE] [--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE] [--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] - [--enable-bin-log] [--enable-password-policy] - [--enable-point-in-time-recovery] + [--enable-bin-log] [--enable-google-private-path] + [--enable-password-policy] [--enable-point-in-time-recovery] [--failover-replica-name=FAILOVER_REPLICA_NAME] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] @@ -42,6 +43,7 @@ SYNOPSIS [--root-password=ROOT_PASSWORD] [--[no-]storage-auto-increase] [--storage-size=STORAGE_SIZE] [--storage-type=STORAGE_TYPE] [--tier=TIER, -t TIER] [--time-zone=TIME_ZONE] + [--timeout=TIMEOUT; default=3600] [--disk-encryption-key=DISK_ENCRYPTION_KEY : --disk-encryption-key-keyring=DISK_ENCRYPTION_KEY_KEYRING --disk-encryption-key-location=DISK_ENCRYPTION_KEY_LOCATION @@ -98,8 +100,7 @@ FLAGS --[no-]assign-ip Assign a public IP address to the instance. This is a public, externally available IPv4 address that you can use to connect to your - instance when properly authorized. Use --assign-ip to enable a public - IP and --no-assign-ip to disable it. Use --assign-ip to enable and + instance when properly authorized. Use --assign-ip to enable and --no-assign-ip to disable. --async @@ -149,6 +150,21 @@ FLAGS Cloud SQL server-level collation setting, which specifies the set of rules for comparing characters in a character set. + --connector-enforcement=CONNECTOR_ENFORCEMENT + Cloud SQL Connector enforcement mode. It determines how Cloud SQL + Connectors are used in the connection. See the list of modes here + (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/instances#connectorenforcement). + CONNECTOR_ENFORCEMENT must be one of: + + CONNECTOR_ENFORCEMENT_UNSPECIFIED + The requirement for Cloud SQL connectors is unknown. + NOT_REQUIRED + Does not require Cloud SQL connectors. + REQUIRED + Requires all connections to use Cloud SQL connectors, including the + Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors. + Note: This disables all existing authorized networks. + --cpu=CPU Whole number value indicating how many cores are desired in the machine. Both --cpu and --memory must be specified if a custom machine @@ -176,9 +192,8 @@ FLAGS --[no-]deletion-protection Enable deletion protection on a Cloud SQL instance. Use - --deletion-protection to enable deletion protection on an instance and - --no-deletion-protection to disable it. Use --deletion-protection to - enable and --no-deletion-protection to disable. + --deletion-protection to enable and --no-deletion-protection to + disable. --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE Date when the deny maintenance period ends, that is 2021-01-10. @@ -194,6 +209,13 @@ FLAGS fraction of a second. Must have automatic backups enabled to use. Make sure storage can support at least 7 days of logs. + --enable-google-private-path + Enable a private path for Google Cloud services. This flag specifies + whether the instance is accessible to internal Google Cloud services + such as BigQuery. This is only applicable to MySQL and PostgreSQL + instances that don't use public IP. Currently, SQL Server isn't + supported. + --enable-password-policy Enable the password policy, which enforces user password management with the policies configured for the instance. This flag is only @@ -359,6 +381,12 @@ FLAGS --time-zone=TIME_ZONE Set a non-default time zone. Only available for SQL Server instances. + --timeout=TIMEOUT; default=3600 + Time to synchronously wait for the operation to complete, after which + the operation continues asynchronously. Ignored if --async flag is + specified. By default, set to 3600s. To wait indefinitely, set to + unlimited. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the instance. The 'Compute Engine Service Agent' service account must hold permission 'Cloud KMS CryptoKey diff --git a/gcloud/sql/instances/patch b/gcloud/sql/instances/patch index acd3b85b6..fc4a9d5c9 100644 --- a/gcloud/sql/instances/patch +++ b/gcloud/sql/instances/patch @@ -8,14 +8,14 @@ SYNOPSIS [--audit-retention-interval=AUDIT_RETENTION_INTERVAL] [--audit-upload-interval=AUDIT_UPLOAD_INTERVAL] [--availability-type=AVAILABILITY_TYPE] [--clear-password-policy] - [--cpu=CPU] [--database-version=DATABASE_VERSION] - [--[no-]deletion-protection] + [--connector-enforcement=CONNECTOR_ENFORCEMENT] [--cpu=CPU] + [--database-version=DATABASE_VERSION] [--[no-]deletion-protection] [--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE] [--deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE] [--deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME] [--diff] [--[no-]enable-bin-log] [--[no-]enable-database-replication] - [--enable-password-policy] [--enable-point-in-time-recovery] - [--follow-gae-app=FOLLOW_GAE_APP] + [--enable-google-private-path] [--enable-password-policy] + [--enable-point-in-time-recovery] [--follow-gae-app=FOLLOW_GAE_APP] [--[no-]insights-config-query-insights-enabled] [--insights-config-query-plans-per-minute=INSIGHTS_CONFIG_QUERY_PLANS_PER_MINUTE] [--insights-config-query-string-length=INSIGHTS_CONFIG_QUERY_STRING_LENGTH] @@ -69,8 +69,7 @@ FLAGS --[no-]assign-ip Assign a public IP address to the instance. This is a public, externally available IPv4 address that you can use to connect to your - instance when properly authorized. Use --assign-ip to enable a public - IP and --no-assign-ip to disable it. Use --assign-ip to enable and + instance when properly authorized. Use --assign-ip to enable and --no-assign-ip to disable. --async @@ -104,6 +103,21 @@ FLAGS Clear the existing password policy. This flag is only available for Postgres. + --connector-enforcement=CONNECTOR_ENFORCEMENT + Cloud SQL Connector enforcement mode. It determines how Cloud SQL + Connectors are used in the connection. See the list of modes here + (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1beta4/instances#connectorenforcement). + CONNECTOR_ENFORCEMENT must be one of: + + CONNECTOR_ENFORCEMENT_UNSPECIFIED + The requirement for Cloud SQL connectors is unknown. + NOT_REQUIRED + Does not require Cloud SQL connectors. + REQUIRED + Requires all connections to use Cloud SQL connectors, including the + Cloud SQL Auth Proxy and Cloud SQL Java, Python, and Go connectors. + Note: This disables all existing authorized networks. + --cpu=CPU Whole number value indicating how many cores are desired in the machine. Both --cpu and --memory must be specified if a custom machine @@ -123,9 +137,8 @@ FLAGS --[no-]deletion-protection Enable deletion protection on a Cloud SQL instance. Use - --deletion-protection to enable deletion protection on an instance and - --no-deletion-protection to disable it. Use --deletion-protection to - enable and --no-deletion-protection to disable. + --deletion-protection to enable and --no-deletion-protection to + disable. --deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE Date when the deny maintenance period ends, that is 2021-01-10. @@ -151,6 +164,13 @@ FLAGS --enable-database-replication to enable and --no-enable-database-replication to disable. + --enable-google-private-path + Enable a private path for Google Cloud services. This flag specifies + whether the instance is accessible to internal Google Cloud services + such as BigQuery. This is only applicable to MySQL and PostgreSQL + instances that don't use public IP. Currently, SQL Server isn't + supported. + --enable-password-policy Enable the password policy, which enforces user password management with the policies configured for the instance. This flag is only diff --git a/gcloud/storage/buckets/add-iam-policy-binding b/gcloud/storage/buckets/add-iam-policy-binding new file mode 100644 index 000000000..8fde82a56 --- /dev/null +++ b/gcloud/storage/buckets/add-iam-policy-binding @@ -0,0 +1,108 @@ +NAME + gcloud storage buckets add-iam-policy-binding - add an IAM policy binding + to a bucket + +SYNOPSIS + gcloud storage buckets add-iam-policy-binding URL --member=PRINCIPAL + --role=ROLE + [--condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Add an IAM policy binding to a bucket. For more information, see Cloud + Identity and Access Management + (https://cloud.google.com/storage/docs/access-control/iam). + +EXAMPLES + To grant a single role to a single principal for BUCKET: + + $ gcloud storage buckets add-iam-policy-binding gs://BUCKET \ + --member=user:john.doe@example.com \ + --role=roles/storage.objectCreator + + To make objects in BUCKET publicly readable: + + $ gcloud storage buckets add-iam-policy-binding gs://BUCKET \ + --member=AllUsers --role=roles/storage.objectViewer + + To specify a custom role for a principal on BUCKET: + + $ gcloud storage buckets add-iam-policy-binding gs://BUCKET \ + --member=user:john.doe@example.com --role=roles/customRoleName + +POSITIONAL ARGUMENTS + URL + URL of bucket to add IAM policy binding to. + +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 + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +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 variant is also available: + + $ gcloud alpha storage buckets add-iam-policy-binding + diff --git a/gcloud/storage/buckets/create b/gcloud/storage/buckets/create index 3c2fadf77..29fa8f213 100644 --- a/gcloud/storage/buckets/create +++ b/gcloud/storage/buckets/create @@ -2,13 +2,15 @@ NAME gcloud storage buckets create - create buckets for storing objects SYNOPSIS - gcloud storage buckets create URL + gcloud storage buckets create URL [--additional-headers=HEADER=VALUE] [--default-encryption-key=DEFAULT_ENCRYPTION_KEY, -k DEFAULT_ENCRYPTION_KEY] [--default-storage-class=DEFAULT_STORAGE_CLASS, -c DEFAULT_STORAGE_CLASS, -s DEFAULT_STORAGE_CLASS] - [--location=LOCATION, -l LOCATION] + [--[no-]enable-autoclass] [--location=LOCATION, -l LOCATION] [--[no-]pap, --[no-]public-access-prevention] + [--placement=REGION,REGION] + [--recovery-point-objective=SETTING, --rpo=SETTING] [--retention-period=RETENTION_PERIOD] [--[no-]uniform-bucket-level-access, -b] [GCLOUD_WIDE_FLAG ...] @@ -32,6 +34,12 @@ POSITIONAL ARGUMENTS The URL of the bucket to create. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --default-encryption-key=DEFAULT_ENCRYPTION_KEY, -k DEFAULT_ENCRYPTION_KEY Set the default KMS key using the full path to the key, which has the following form: @@ -43,6 +51,11 @@ FLAGS If not specified, the default storage class used by Cloud Storage is "Standard". + --[no-]enable-autoclass + The Autoclass feature automatically selects the best storage class for + objects based on access patterns. Use --enable-autoclass to enable and + --no-enable-autoclass to disable. + --location=LOCATION, -l LOCATION Location (https://cloud.google.com/storage/docs/locations) for the bucket. If not specified, the location used by Cloud Storage is us. A @@ -51,10 +64,28 @@ FLAGS --[no-]pap, --[no-]public-access-prevention Sets public access prevention to "enforced". For details on how exactly public access is blocked, see: - http://cloud/storage/docs/public-access-prevention. Use + http://cloud.google.com/storage/docs/public-access-prevention. Use --public-access-prevention to enable and --no-public-access-prevention to disable. + --placement=REGION,REGION + A comma-separated list of exactly 2 regions that form the custom + dual-region. Only regions within the same continent are or will ever be + valid. Invalid location pairs (such as mixed-continent, or with + unsupported regions) will return an error. + + --recovery-point-objective=SETTING, --rpo=SETTING + Sets the recovery point objective + (https://cloud.google.com/architecture/dr-scenarios-planning-guide#basics_of_dr_planning) + of a bucket. This flag can only be used with multi-region and + dual-region buckets. DEFAULT option is valid for multi-region and + dual-regions buckets. ASYNC_TURBO option is only valid for dual-region + buckets. If unspecified when the bucket is created, it defaults to + DEFAULT for dual-region and multi-region buckets. For more information, + see Turbo Replication + (https://cloud.google.com/storage/docs/turbo-replication). SETTING must + be one of: ASYNC_TURBO, DEFAULT. + --retention-period=RETENTION_PERIOD Minimum retention period (https://cloud.google.com/storage/docs/bucket-lock#retention-periods) diff --git a/gcloud/storage/buckets/delete b/gcloud/storage/buckets/delete index 5cd6e170c..67c176994 100644 --- a/gcloud/storage/buckets/delete +++ b/gcloud/storage/buckets/delete @@ -2,7 +2,8 @@ NAME gcloud storage buckets delete - deletes Cloud Storage buckets SYNOPSIS - gcloud storage buckets delete URLS [URLS ...] [--continue-on-error, -c] + gcloud storage buckets delete URLS [URLS ...] + [--additional-headers=HEADER=VALUE] [--continue-on-error, -c] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -22,6 +23,12 @@ POSITIONAL ARGUMENTS Specifies the URLs of the buckets to delete. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --continue-on-error, -c If any operations are unsuccessful, the command will exit with a non-zero exit status after completing the remaining operations. This diff --git a/gcloud/storage/buckets/describe b/gcloud/storage/buckets/describe index 7ff1d55b2..ec03c5503 100644 --- a/gcloud/storage/buckets/describe +++ b/gcloud/storage/buckets/describe @@ -2,7 +2,8 @@ NAME gcloud storage buckets describe - describes Cloud Storage buckets SYNOPSIS - gcloud storage buckets describe URL [GCLOUD_WIDE_FLAG ...] + gcloud storage buckets describe URL [--additional-headers=HEADER=VALUE] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Describe a Cloud Storage bucket. @@ -21,6 +22,13 @@ POSITIONAL ARGUMENTS URL Specifies URL of bucket to describe. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/storage/buckets/get-iam-policy b/gcloud/storage/buckets/get-iam-policy new file mode 100644 index 000000000..62cd6033f --- /dev/null +++ b/gcloud/storage/buckets/get-iam-policy @@ -0,0 +1,37 @@ +NAME + gcloud storage buckets get-iam-policy - get the IAM policy for a bucket + +SYNOPSIS + gcloud storage buckets get-iam-policy URL [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get the IAM policy for a bucket. For more information, see Cloud Identity + and Access Management + (https://cloud.google.com/storage/docs/access-control/iam). + +EXAMPLES + To get the IAM policy for BUCKET: + + $ gcloud storage buckets get-iam-policy gs://BUCKET + + To output the IAM policy for BUCKET to a file: + + $ gcloud storage buckets get-iam-policy gs://BUCKET > policy.txt + +POSITIONAL ARGUMENTS + URL + Request IAM policy for this bucket. + +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 variant is also available: + + $ gcloud alpha storage buckets get-iam-policy + diff --git a/gcloud/storage/buckets/help b/gcloud/storage/buckets/help index 3722a2c8b..98473364b 100644 --- a/gcloud/storage/buckets/help +++ b/gcloud/storage/buckets/help @@ -21,6 +21,9 @@ GROUPS COMMANDS COMMAND is one of the following: + add-iam-policy-binding + Add an IAM policy binding to a bucket. + create Create buckets for storing objects. @@ -30,9 +33,18 @@ COMMANDS describe Describes Cloud Storage buckets. + get-iam-policy + Get the IAM policy for a bucket. + list Lists Cloud Storage buckets. + remove-iam-policy-binding + Remove an IAM policy binding from a bucket. + + set-iam-policy + Set the IAM policy for a bucket. + update Update bucket settings. diff --git a/gcloud/storage/buckets/list b/gcloud/storage/buckets/list index e5538a4d4..30b7ba8ed 100644 --- a/gcloud/storage/buckets/list +++ b/gcloud/storage/buckets/list @@ -2,9 +2,9 @@ NAME gcloud storage buckets list - lists Cloud Storage buckets SYNOPSIS - gcloud storage buckets list [URLS ...] [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud storage buckets list [URLS ...] [--additional-headers=HEADER=VALUE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION List Cloud Storage buckets. @@ -26,6 +26,13 @@ POSITIONAL ARGUMENTS [URLS ...] Specifies URL of buckets to List. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/storage/buckets/notifications/create b/gcloud/storage/buckets/notifications/create index 6b8582c1f..b7dfc4802 100644 --- a/gcloud/storage/buckets/notifications/create +++ b/gcloud/storage/buckets/notifications/create @@ -27,8 +27,8 @@ DESCRIPTION the create command uses the Cloud Pub/Sub topic projects/default-project/topics/example-bucket. - In order to enable notifications, your project's [Cloud Storage service - agent] (https://cloud.google.com/storage/docs/projects#service-accounts) + In order to enable notifications, your project's Cloud Storage service + agent (https://cloud.google.com/storage/docs/projects#service-accounts) must have the IAM permission "pubsub.topics.publish". This command checks to see if the destination Cloud Pub/Sub topic grants the service agent this permission. If not, the create command attempts to grant it. diff --git a/gcloud/storage/buckets/remove-iam-policy-binding b/gcloud/storage/buckets/remove-iam-policy-binding new file mode 100644 index 000000000..432c5c7a4 --- /dev/null +++ b/gcloud/storage/buckets/remove-iam-policy-binding @@ -0,0 +1,104 @@ +NAME + gcloud storage buckets remove-iam-policy-binding - remove an IAM policy + binding from a bucket + +SYNOPSIS + gcloud storage buckets remove-iam-policy-binding URL --member=PRINCIPAL + --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Removes a policy binding from the IAM policy of a bucket, given a bucket + URL and the binding. For more information, see Cloud Identity and Access + Management (https://cloud.google.com/storage/docs/access-control/iam). + +EXAMPLES + To remove an IAM policy binding from the role of + roles/storage.objectCreator for the user john.doe@example.com on BUCKET: + + $ gcloud storage buckets remove-iam-policy-binding gs://BUCKET \ + --member=user:john.doe@example.com \ + --role=roles/storage.objectCreator + +POSITIONAL ARGUMENTS + URL + URL of bucket to remove IAM policy binding from. + +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 + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +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 variant is also available: + + $ gcloud alpha storage buckets remove-iam-policy-binding + diff --git a/gcloud/storage/buckets/set-iam-policy b/gcloud/storage/buckets/set-iam-policy new file mode 100644 index 000000000..8704f13c8 --- /dev/null +++ b/gcloud/storage/buckets/set-iam-policy @@ -0,0 +1,57 @@ +NAME + gcloud storage buckets set-iam-policy - set the IAM policy for a bucket + +SYNOPSIS + gcloud storage buckets set-iam-policy URLS [URLS ...] POLICY_FILE + [--continue-on-error, -c] [--etag=ETAG, -e ETAG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Set the IAM policy for a bucket. For more information, see Cloud Identity + and Access Management + (https://cloud.google.com/storage/docs/access-control/iam). + +EXAMPLES + To set the IAM policy in POLICY-FILE on BUCKET: + + $ gcloud storage buckets set-iam-policy gs://BUCKET POLICY-FILE + + To set the IAM policy in POLICY-FILE on all buckets beginning with "b": + + $ gcloud storage buckets set-iam-policy gs://b* POLICY-FILE + +POSITIONAL ARGUMENTS + URLS [URLS ...] + URLs for buckets to apply the IAM policy to. Can include wildcards. + + 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 + --continue-on-error, -c + If any operations are unsuccessful, the command will exit with a + non-zero exit status after completing the remaining operations. This + flag takes effect only in sequential execution mode (i.e. processor and + thread count are set to 1). Parallelism is default. + + --etag=ETAG, -e ETAG + Custom etag to set on IAM policy. API will reject etags that do not + match this value, making it useful as a precondition during concurrent + operations. + +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 variant is also available: + + $ gcloud alpha storage buckets set-iam-policy + diff --git a/gcloud/storage/buckets/update b/gcloud/storage/buckets/update index c04554cf7..f411402b6 100644 --- a/gcloud/storage/buckets/update +++ b/gcloud/storage/buckets/update @@ -3,11 +3,20 @@ NAME SYNOPSIS gcloud storage buckets update URL [URL ...] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL] - [--continue-on-error, -c] - [--default-storage-class=DEFAULT_STORAGE_CLASS] [--[no-]requester-pays] - [--[no-]versioning] [--clear-cors | --cors-file=CORS_FILE] + [--additional-headers=HEADER=VALUE] [--continue-on-error, -c] + [--[no-]default-event-based-hold] [--[no-]enable-autoclass] + [--lock-retention-period] + [--recovery-point-objective=SETTING, --rpo=SETTING] + [--[no-]requester-pays] [--[no-]uniform-bucket-level-access] + [--[no-]versioning] + [--acl-file=ACL_FILE --add-acl-grant=[ACL_GRANT,...] + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, + -a PREDEFINED_ACL --remove-acl-grant=REMOVE_ACL_GRANT] + [--add-default-object-acl-grant=[DEFAULT_OBJECT_ACL_GRANT,...] + --default-object-acl-file=DEFAULT_OBJECT_ACL_FILE + --predefined-default-object-acl=PREDEFINED_DEFAULT_OBJECT_ACL + --remove-default-object-acl-grant=REMOVE_DEFAULT_OBJECT_ACL_GRANT] + [--clear-cors | --cors-file=CORS_FILE] [--clear-default-encryption-key | --default-encryption-key=DEFAULT_ENCRYPTION_KEY] [--clear-labels | --labels-file=LABELS_FILE @@ -18,6 +27,7 @@ SYNOPSIS [--clear-log-object-prefix | --log-object-prefix=LOG_OBJECT_PREFIX] [--clear-pap, --clear-public-access-prevention | --[no-]pap, --[no-]public-access-prevention] + [--clear-retention-period | --retention-period=RETENTION_PERIOD] [--clear-web-error-page | --web-error-page=WEB_ERROR_PAGE] [--clear-web-main-page-suffix | --web-main-page-suffix=WEB_MAIN_PAGE_SUFFIX] [GCLOUD_WIDE_FLAG ...] @@ -32,15 +42,27 @@ EXAMPLES $ gcloud storage buckets update gs://my-bucket \ --default-storage-class=NEARLINE --requester-pays + The following command updates the retention period of a Cloud Storage + bucket named "my-bucket" to one year and thirty-six minutes: + + $ gcloud storage buckets update gs://my-bucket \ + --retention-period=1y36m + + The following command clears the retention period of a bucket: + + $ gcloud storage buckets update gs://my-bucket \ + --clear-retention-period + POSITIONAL ARGUMENTS URL [URL ...] URLs of the buckets to update. FLAGS - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. --continue-on-error, -c If any operations are unsuccessful, the command will exit with a @@ -48,18 +70,87 @@ FLAGS flag takes effect only in sequential execution mode (i.e. processor and thread count are set to 1). Parallelism is default. - --default-storage-class=DEFAULT_STORAGE_CLASS - Sets the default storage class for the bucket. + --[no-]default-event-based-hold + Sets the default value for an event-based hold on the bucket. By + setting the default event-based hold on a bucket, newly-created objects + inherit that value as their event-based hold (it is not applied + retroactively). Use --default-event-based-hold to enable and + --no-default-event-based-hold to disable. + + --[no-]enable-autoclass + The Autoclass feature automatically selects the best storage class for + objects based on access patterns. Use --enable-autoclass to enable and + --no-enable-autoclass to disable. + + --lock-retention-period + Locks an unlocked retention policy on the buckets. Caution: A locked + retention policy cannot be removed from a bucket or reduced in + duration. Once locked, deleting the bucket is the only way to "remove" + a retention policy. + + --recovery-point-objective=SETTING, --rpo=SETTING + Sets the recovery point objective + (https://cloud.google.com/architecture/dr-scenarios-planning-guide#basics_of_dr_planning) + of a bucket. This flag can only be used with multi-region and + dual-region buckets. DEFAULT option is valid for multi-region and + dual-regions buckets. ASYNC_TURBO option is only valid for dual-region + buckets. If unspecified when the bucket is created, it defaults to + DEFAULT for dual-region and multi-region buckets. For more information, + see Turbo Replication + (https://cloud.google.com/storage/docs/turbo-replication). SETTING must + be one of: ASYNC_TURBO, DEFAULT. --[no-]requester-pays Allows you to configure a Cloud Storage bucket so that the requester pays all costs related to accessing the bucket and its objects. Use --requester-pays to enable and --no-requester-pays to disable. + --[no-]uniform-bucket-level-access + Enables or disables uniform bucket-level access + (https://cloud.google.com/storage/docs/bucket-policy-only) for the + buckets. Use --uniform-bucket-level-access to enable and + --no-uniform-bucket-level-access to disable. + --[no-]versioning Allows you to configure a Cloud Storage bucket to keep old versions of objects. Use --versioning to enable and --no-versioning to disable. + --acl-file=ACL_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + The output of gcloud storage [buckets|objects] describe + --format="multi(acl:format=json)" is a valid file and can be edited for + more fine-grained control. + + --add-acl-grant=[ACL_GRANT,...] + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud + Storage,--add-acl-grant=entity=user-tim@gmail.com,role=OWNER + + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + + --remove-acl-grant=REMOVE_ACL_GRANT + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud Storage, --remove-acl-grant=ENTITY, where + ENTITY has a valid ACL entity format, such as user-tim@gmail.com, + group-admins, allUsers, etc. + + --add-default-object-acl-grant=[DEFAULT_OBJECT_ACL_GRANT,...] + Adds default object ACL grant. See --add-acl-grant help text for more + details. + + --default-object-acl-file=DEFAULT_OBJECT_ACL_FILE + Sets the default object ACL from file for the bucket. + + --predefined-default-object-acl=PREDEFINED_DEFAULT_OBJECT_ACL + Apply a predefined set of default object access controls tobuckets + + --remove-default-object-acl-grant=REMOVE_DEFAULT_OBJECT_ACL_GRANT + Removes default object ACL grant. See --remove-acl-grant help text for + more details. + At most one of these can be specified: --clear-cors @@ -164,10 +255,24 @@ FLAGS If True, sets public access prevention to "enforced". If False, sets public access prevention to "inherited". For details on how exactly public access is blocked, see: - http://cloud/storage/docs/public-access-prevention. Use + http://cloud.google.com/storage/docs/public-access-prevention. Use --public-access-prevention to enable and --no-public-access-prevention to disable. + At most one of these can be specified: + + --clear-retention-period + Clears the object retention period for a bucket. + + --retention-period=RETENTION_PERIOD + Minimum retention period + (https://cloud.google.com/storage/docs/bucket-lock#retention-periods) + for objects stored in the bucket, for example + --retention-period=1Y1M1D5S. Objects added to the bucket cannot be + deleted until they've been stored for the specified length of time. + Default is no retention period. Only available for Cloud Storage + using the JSON API. + At most one of these can be specified: --clear-web-error-page diff --git a/gcloud/storage/cat b/gcloud/storage/cat index b831318f6..c209bd80f 100644 --- a/gcloud/storage/cat +++ b/gcloud/storage/cat @@ -2,9 +2,9 @@ NAME gcloud storage cat - outputs the contents of one or more URLs to stdout SYNOPSIS - gcloud storage cat URL [URL ...] [--display-url, -d] - [--range=RANGE, -r RANGE] [--decryption-keys=[DECRYPTION_KEY,...]] - [GCLOUD_WIDE_FLAG ...] + gcloud storage cat URL [URL ...] [--additional-headers=HEADER=VALUE] + [--display-url, -d] [--range=RANGE, -r RANGE] + [--decryption-keys=[DECRYPTION_KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION The cat command outputs the contents of one or more URLs to stdout. While @@ -38,6 +38,12 @@ POSITIONAL ARGUMENTS The url of objects to list. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --display-url, -d Prints the header before each object. diff --git a/gcloud/storage/cp b/gcloud/storage/cp index 8c23c44f7..8b92d472d 100644 --- a/gcloud/storage/cp +++ b/gcloud/storage/cp @@ -2,7 +2,8 @@ NAME gcloud storage cp - upload, download, and copy Cloud Storage objects SYNOPSIS - gcloud storage cp [SOURCE ...] DESTINATION [--all-versions, -A] + gcloud storage cp [SOURCE ...] DESTINATION + [--additional-headers=HEADER=VALUE] [--all-versions, -A] [--no-clobber, -n] [--continue-on-error, -c] [--daisy-chain, -D] [--do-not-decompress] [--ignore-symlinks] [--manifest-path=MANIFEST_PATH, -L MANIFEST_PATH] @@ -10,9 +11,8 @@ SYNOPSIS [--read-paths-from-stdin, -I] [--recursive, -R, -r] [--skip-unsupported, -U] [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - | --[no-]preserve-acl, -p] + [--canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, + -a PREDEFINED_ACL --[no-]preserve-acl, -p] [--gzip-in-flight=[FILE_EXTENSIONS,...], -j [FILE_EXTENSIONS,...] | --gzip-in-flight-all, -J | --gzip-local=[FILE_EXTENSIONS,...], -z [FILE_EXTENSIONS,...] @@ -76,6 +76,12 @@ POSITIONAL ARGUMENTS The destination path. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -A Copy all source versions from a source bucket or folder. If not set, only the live version of each source object is copied. @@ -171,21 +177,18 @@ FLAGS the default storage class of the destination bucket is used. This option is not valid for copying to non-cloud destinations. - At most one of these can be specified: + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - - --[no-]preserve-acl, -p - Preserves ACLs when copying in the cloud. This option is Google Cloud - Storage-only, and you need OWNER access to all copied objects. If all - objects in the destination bucket should have the same ACL, you can - also set a default object ACL on that bucket instead of using this - flag. Preserving ACLs is the default behavior for updating existing - objects. Use --preserve-acl to enable and --no-preserve-acl to - disable. + --[no-]preserve-acl, -p + Preserves ACLs when copying in the cloud. This option is Google Cloud + Storage-only, and you need OWNER access to all copied objects. If all + objects in the destination bucket should have the same ACL, you can + also set a default object ACL on that bucket instead of using this + flag. Preserving ACLs is the default behavior for updating existing + objects. Use --preserve-acl to enable and --no-preserve-acl to disable. At most one of these can be specified: diff --git a/gcloud/storage/ls b/gcloud/storage/ls index c790e82ab..55337467f 100644 --- a/gcloud/storage/ls +++ b/gcloud/storage/ls @@ -2,9 +2,10 @@ NAME gcloud storage ls - list Cloud Storage buckets and objects SYNOPSIS - gcloud storage ls [PATH ...] [--all-versions, -a] [--buckets, -b] - [--etag, -e] [--format=FORMAT] [--readable-sizes] [--recursive, -R, -r] - [--full, -L | --json, -j | --long, -l] + gcloud storage ls [PATH ...] [--additional-headers=HEADER=VALUE] + [--all-versions, -a] [--buckets, -b] [--etag, -e] + [--fetch-encrypted-object-hashes] [--format=FORMAT] [--readable-sizes] + [--recursive, -R, -r] [--full, -L | --json, -j | --long, -l] [--decryption-keys=[DECRYPTION_KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -73,6 +74,12 @@ POSITIONAL ARGUMENTS gs:// and is allowed to contain wildcard characters. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -a Include non-current object versions in the listing. This flag is typically only useful for buckets with object versioning @@ -89,6 +96,12 @@ FLAGS --etag, -e Include ETag metadata in listings that use the --long flag. + --fetch-encrypted-object-hashes + API requests to the LIST endpoint do not fetch the hashes for encrypted + objects by default. If this flag is set, a GET request is sent for each + encrypted object in order to fetch hashes. This can significantly + increase the cost of the command. + --format=FORMAT Use "gsutil" to get the style of the older gsutil CLI. (e.g. "--format=gsutil"). Other format values (e.g. "json") do not work. See diff --git a/gcloud/storage/mv b/gcloud/storage/mv index 4475ddb5b..670e01ad7 100644 --- a/gcloud/storage/mv +++ b/gcloud/storage/mv @@ -2,16 +2,16 @@ NAME gcloud storage mv - moves or renames objects SYNOPSIS - gcloud storage mv [SOURCE ...] DESTINATION [--all-versions, -A] + gcloud storage mv [SOURCE ...] DESTINATION + [--additional-headers=HEADER=VALUE] [--all-versions, -A] [--no-clobber, -n] [--continue-on-error, -c] [--daisy-chain, -D] [--do-not-decompress] [--ignore-symlinks] [--manifest-path=MANIFEST_PATH, -L MANIFEST_PATH] [--preserve-posix, -P] [--print-created-message, -v] [--read-paths-from-stdin, -I] [--skip-unsupported, -U] [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - | --[no-]preserve-acl, -p] + [--canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, + -a PREDEFINED_ACL --[no-]preserve-acl, -p] [--gzip-in-flight=[FILE_EXTENSIONS,...], -j [FILE_EXTENSIONS,...] | --gzip-in-flight-all, -J | --gzip-local=[FILE_EXTENSIONS,...], -z [FILE_EXTENSIONS,...] @@ -86,6 +86,12 @@ POSITIONAL ARGUMENTS The destination path. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -A Copy all source versions from a source bucket or folder. If not set, only the live version of each source object is copied. @@ -177,21 +183,18 @@ FLAGS the default storage class of the destination bucket is used. This option is not valid for copying to non-cloud destinations. - At most one of these can be specified: + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl - - --[no-]preserve-acl, -p - Preserves ACLs when copying in the cloud. This option is Google Cloud - Storage-only, and you need OWNER access to all copied objects. If all - objects in the destination bucket should have the same ACL, you can - also set a default object ACL on that bucket instead of using this - flag. Preserving ACLs is the default behavior for updating existing - objects. Use --preserve-acl to enable and --no-preserve-acl to - disable. + --[no-]preserve-acl, -p + Preserves ACLs when copying in the cloud. This option is Google Cloud + Storage-only, and you need OWNER access to all copied objects. If all + objects in the destination bucket should have the same ACL, you can + also set a default object ACL on that bucket instead of using this + flag. Preserving ACLs is the default behavior for updating existing + objects. Use --preserve-acl to enable and --no-preserve-acl to disable. At most one of these can be specified: diff --git a/gcloud/storage/objects/compose b/gcloud/storage/objects/compose index 1ecfa767a..139569880 100644 --- a/gcloud/storage/objects/compose +++ b/gcloud/storage/objects/compose @@ -4,6 +4,7 @@ NAME SYNOPSIS gcloud storage objects compose SOURCE [SOURCE ...] DESTINATION + [--additional-headers=HEADER=VALUE] [--if-generation-match=GENERATION --if-metageneration-match=METAGENERATION] [GCLOUD_WIDE_FLAG ...] @@ -31,6 +32,13 @@ POSITIONAL ARGUMENTS DESTINATION The destination object. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + PRECONDITION FLAGS --if-generation-match=GENERATION Execute only if the generation matches the generation of the requested diff --git a/gcloud/storage/objects/describe b/gcloud/storage/objects/describe index 753aa234b..21e1cc6a9 100644 --- a/gcloud/storage/objects/describe +++ b/gcloud/storage/objects/describe @@ -2,7 +2,8 @@ NAME gcloud storage objects describe - describe a Cloud Storage object SYNOPSIS - gcloud storage objects describe URL + gcloud storage objects describe URL [--additional-headers=HEADER=VALUE] + [--fetch-encrypted-object-hashes] [--decryption-keys=[DECRYPTION_KEY,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -23,6 +24,19 @@ POSITIONAL ARGUMENTS URL Specifies URL of object to describe. +FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + + --fetch-encrypted-object-hashes + If the initial GET request returns an object encrypted with a + customer-supplied encryption key, the hash fields will be null. If the + matching decryption key is present on the system, this flag retries the + GET request with the key. + ENCRYPTION FLAGS --decryption-keys=[DECRYPTION_KEY,...] A comma-separated list of customer-supplied encryption keys (RFC 4648 diff --git a/gcloud/storage/objects/list b/gcloud/storage/objects/list index 4fdbc25a2..1f2a2c753 100644 --- a/gcloud/storage/objects/list +++ b/gcloud/storage/objects/list @@ -2,8 +2,9 @@ NAME gcloud storage objects list - lists Cloud Storage objects SYNOPSIS - gcloud storage objects list URLS [URLS ...] [--stat] - [--decryption-keys=[DECRYPTION_KEY,...]] [--filter=EXPRESSION] + gcloud storage objects list URLS [URLS ...] + [--additional-headers=HEADER=VALUE] [--fetch-encrypted-object-hashes] + [--stat] [--decryption-keys=[DECRYPTION_KEY,...]] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -32,6 +33,18 @@ POSITIONAL ARGUMENTS Specifies URL of objects to list. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + + --fetch-encrypted-object-hashes + API requests to the LIST endpoint do not fetch the hashes for encrypted + objects by default. If this flag is set, a GET request is sent for each + encrypted object in order to fetch hashes. This can significantly + increase the cost of the command. + --stat Emulates gsutil stat-style behavior. Does not show past object versions and changes output format. diff --git a/gcloud/storage/objects/update b/gcloud/storage/objects/update index fa7bfe434..441d17f6b 100644 --- a/gcloud/storage/objects/update +++ b/gcloud/storage/objects/update @@ -2,12 +2,15 @@ NAME gcloud storage objects update - update Cloud Storage objects SYNOPSIS - gcloud storage objects update [URL ...] [--continue-on-error, -c] + gcloud storage objects update [URL ...] [--additional-headers=HEADER=VALUE] + [--all-versions] [--continue-on-error, -c] [--[no-]event-based-hold] [--read-paths-from-stdin, -I] [--recursive, -R, -r] [--storage-class=STORAGE_CLASS, -s STORAGE_CLASS] - [--canned-acl=PREDEFINED_ACL, - --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - | --[no-]preserve-acl, -p] + [--[no-]temporary-hold] + [--acl-file=ACL_FILE --add-acl-grant=[ACL_GRANT,...] + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a + PREDEFINED_ACL + --[no-]preserve-acl, -p --remove-acl-grant=REMOVE_ACL_GRANT] [--clear-encryption-key --decryption-keys=[DECRYPTION_KEY,...] --encryption-key=ENCRYPTION_KEY] [--cache-control=CACHE_CONTROL --clear-cache-control @@ -49,12 +52,25 @@ POSITIONAL ARGUMENTS Specifies URLs of objects to update. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + + --all-versions + Perform the operation on all object versions. + --continue-on-error, -c If any operations are unsuccessful, the command will exit with a non-zero exit status after completing the remaining operations. This flag takes effect only in sequential execution mode (i.e. processor and thread count are set to 1). Parallelism is default. + --[no-]event-based-hold + Enables or disables an event-based hold on objects. Use + --event-based-hold to enable and --no-event-based-hold to disable. + --read-paths-from-stdin, -I Read the list of objects to update from stdin. No need to enter a source argument if this flag is present. Example: "storage objects @@ -68,21 +84,39 @@ FLAGS Specify the storage class of the object. Using this flag triggers a rewrite of underlying object data. - At most one of these can be specified: + --[no-]temporary-hold + Enables or disables a temporary hold on objects. Use --temporary-hold + to enable and --no-temporary-hold to disable. - --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL - Applies predefined, or "canned," ACLs to a resource. See docs for a - list of predefined ACL constants: - https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + --acl-file=ACL_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + The output of gcloud storage [buckets|objects] describe + --format="multi(acl:format=json)" is a valid file and can be edited for + more fine-grained control. - --[no-]preserve-acl, -p - Preserves ACLs when copying in the cloud. This option is Google Cloud - Storage-only, and you need OWNER access to all copied objects. If all - objects in the destination bucket should have the same ACL, you can - also set a default object ACL on that bucket instead of using this - flag. Preserving ACLs is the default behavior for updating existing - objects. Use --preserve-acl to enable and --no-preserve-acl to - disable. + --add-acl-grant=[ACL_GRANT,...] + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud + Storage,--add-acl-grant=entity=user-tim@gmail.com,role=OWNER + + --canned-acl=PREDEFINED_ACL, --predefined-acl=PREDEFINED_ACL, -a PREDEFINED_ACL + Applies predefined, or "canned," ACLs to a resource. See docs for a + list of predefined ACL constants: + https://cloud.google.com/storage/docs/access-control/lists#predefined-acl + + --[no-]preserve-acl, -p + Preserves ACLs when copying in the cloud. This option is Google Cloud + Storage-only, and you need OWNER access to all copied objects. If all + objects in the destination bucket should have the same ACL, you can + also set a default object ACL on that bucket instead of using this + flag. Preserving ACLs is the default behavior for updating existing + objects. Use --preserve-acl to enable and --no-preserve-acl to disable. + + --remove-acl-grant=REMOVE_ACL_GRANT + Key-value pairs mirroring the JSON accepted by your cloud provider. For + example, for Google Cloud Storage, --remove-acl-grant=ENTITY, where + ENTITY has a valid ACL entity format, such as user-tim@gmail.com, + group-admins, allUsers, etc. ENCRYPTION FLAGS --clear-encryption-key diff --git a/gcloud/storage/rm b/gcloud/storage/rm index f8e832a9f..8efff218a 100644 --- a/gcloud/storage/rm +++ b/gcloud/storage/rm @@ -2,7 +2,8 @@ NAME gcloud storage rm - delete objects and buckets SYNOPSIS - gcloud storage rm [URLS ...] [--all-versions, -a] [--continue-on-error, -c] + gcloud storage rm [URLS ...] [--additional-headers=HEADER=VALUE] + [--all-versions, -a] [--continue-on-error, -c] [--read-paths-from-stdin, -I] [--recursive, -R, -r] [--if-generation-match=GENERATION --if-metageneration-match=METAGENERATION] [GCLOUD_WIDE_FLAG ...] @@ -51,6 +52,12 @@ POSITIONAL ARGUMENTS The URLs of the resources to delete. FLAGS + --additional-headers=HEADER=VALUE + Includes arbitrary headers in storage API calls. Accepts a comma + separated list of key=value pairs, e.g. header1=value1,header2=value2. + Overrides the default storage/additional_headers property value for + this command invocation. + --all-versions, -a Delete all versions (https://cloud.google.com/storage/docs/object-versioning) of an object. diff --git a/gcloud/topic/help b/gcloud/topic/help index 3d908bbff..3adbfc607 100644 --- a/gcloud/topic/help +++ b/gcloud/topic/help @@ -37,6 +37,9 @@ TOPICS datetimes Date/time input format supplementary help. + endpoint-override + gcloud endpoint override supplementary help. + escaping List/dictionary-type argument escaping supplementary help. @@ -66,3 +69,11 @@ TOPICS uninstall Supplementary help for uninstalling Google Cloud CLI. + +NOTES + These variants are also available: + + $ gcloud alpha topic + + $ gcloud beta topic + diff --git a/gcloud/transfer/agents/install b/gcloud/transfer/agents/install index a4b43d531..5f3b20a21 100644 --- a/gcloud/transfer/agents/install +++ b/gcloud/transfer/agents/install @@ -3,7 +3,8 @@ NAME SYNOPSIS gcloud transfer agents install --pool=POOL [--count=COUNT] - [--creds-file=CREDS_FILE] [--enable-multipart] [--id-prefix=ID_PREFIX] + [--creds-file=CREDS_FILE] [--[no-]enable-multipart] + [--id-prefix=ID_PREFIX] [--logs-directory=LOGS_DIRECTORY; default="/tmp"] [--memlock-limit=MEMLOCK_LIMIT; default=64000000] [--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY] @@ -15,15 +16,22 @@ DESCRIPTION locally on your machine and run inside Docker containers. EXAMPLES + To create an agent pool for your agent, see the gcloud transfer agent-pools + create command. + To install an agent that authenticates with your user account credentials and has default agent parameters, run: - $ gcloud transfer agents install + $ gcloud transfer agents install --pool=AGENT_POOL + + You will be prompted to run a command to generate a credentials file if one + does not already exist. To install an agent that authenticates with a service account with credentials stored at '/example/path.json', run: - $ gcloud transfer agents install --creds-file=/example/path.json + $ gcloud transfer agents install --creds-file=/example/path.json \ + --pool=AGENT_POOL REQUIRED FLAGS --pool=POOL @@ -48,11 +56,12 @@ OPTIONAL FLAGS Note that the credentials location will be mounted to the agent container. - --enable-multipart + --[no-]enable-multipart Split up files and transfer the resulting chunks in parallel before merging them at the destination. Can be used make transfers of large files faster as long as the network and disk speed are not limiting - factors. + factors. If unset, agent decides when to use the feature. Use + --enable-multipart to enable and --no-enable-multipart to disable. --id-prefix=ID_PREFIX An optional prefix to add to the agent ID to help identify the agent. diff --git a/gcloud/transfer/jobs/create b/gcloud/transfer/jobs/create index d02b7c286..0c0f0e3da 100644 --- a/gcloud/transfer/jobs/create +++ b/gcloud/transfer/jobs/create @@ -9,6 +9,9 @@ SYNOPSIS --destination-agent-pool=DESTINATION_AGENT_POOL --intermediate-storage-path=INTERMEDIATE_STORAGE_PATH --manifest-file=MANIFEST_FILE] + [--event-stream-name=EVENT_STREAM_NAME + --event-stream-starts=EVENT_STREAM_STARTS + --event-stream-expires=EVENT_STREAM_EXPIRES] [--do-not-run --schedule-starts=SCHEDULE_STARTS --schedule-repeats-every=SCHEDULE_REPEATS_EVERY --schedule-repeats-until=SCHEDULE_REPEATS_UNTIL] @@ -24,7 +27,7 @@ SYNOPSIS [--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC --notification-event-types=[EVENT_TYPES,...] --notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT] - [--log-actions=[LOG_ACTIONS,...] + [--[no-]enable-posix-transfer-logs --log-actions=[LOG_ACTIONS,...] --log-action-states=[LOG_ACTION_STATES,...]] [--source-endpoint=SOURCE_ENDPOINT --source-signing-region=SOURCE_SIGNING_REGION @@ -153,6 +156,36 @@ FLAGS gs://mybucket/manifest.csv. For manifest file formatting, see https://cloud.google.com/storage-transfer/docs/manifest. + EVENT STREAM + + Configure an event stream to transfer data whenever it is added or changed + at your source, enabling you to act on the data in near real time. This + event-driven transfer execution mode is available for transfers from + Google Cloud Storage and Amazon S3. For formatting information, see + https://cloud.google.com/sdk/gcloud/reference/topic/datetimes. + + --event-stream-name=EVENT_STREAM_NAME + Specify an event stream that Storage Transfer Service can use to + listen for when objects are created or updated. For Google Cloud + Storage sources, specify a Cloud Pub/Sub subscription, using format + "projects/yourproject/subscriptions/yoursubscription". For Amazon S3 + sources, specify the Amazon Resource Name (ARN) of an Amazon Simple + Queue Service (SQS) queue using format + "arn:aws:sqs:region:account_id:queue_name". + + --event-stream-starts=EVENT_STREAM_STARTS + Set when to start listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will start running + and listening for events upon the successful submission of the create + job command. + + --event-stream-expires=EVENT_STREAM_EXPIRES + Set when to stop listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will continue running + and listening for events indefinitely. + SCHEDULE A job's schedule determines when and how often the job will run. For @@ -269,9 +302,20 @@ FLAGS --custom-storage-class=CUSTOM_STORAGE_CLASS Specifies the storage class to set on objects being transferred to - Google Cloud Storage buckets. If unspecified, the behavior is to - match the destination bucket default. The value "preserve" will use - the class from the object's Google Cloud Storage source bucket. + Cloud Storage buckets. If unspecified, the objects' storage class is + set to the destination bucket default. Valid values are: + + ▸ Any of the values listed in the Cloud Storage documentation: + Available storage classes + (https://cloud.google.com/storage/docs/storage-classes#classes). + ▸ preserve - Preserves each object's original storage class. Only + supported for transfers between Cloud Storage buckets. + + Custom storage class settings are ignored if the destination bucket + is Autoclass-enabled + (https://cloud.google.com/storage/docs/autoclass). Objects + transferred into Autoclass-enabled buckets are initially set to the + STANDARD storage class. NOTIFICATION CONFIG @@ -302,6 +346,12 @@ FLAGS are generated for this job. Logs can be viewed by running the following command: gcloud logging read "resource.type=storage_transfer_job" + --[no-]enable-posix-transfer-logs + Sets whether to generate logs for transfers with a POSIX filesystem + source. This setting will later be merged with other log + configurations. Use --enable-posix-transfer-logs to enable and + --no-enable-posix-transfer-logs to disable. + --log-actions=[LOG_ACTIONS,...] Define the transfer operation actions to report in logs. Separate multiple actions with commas, omitting spaces after the commas (e.g., diff --git a/gcloud/transfer/jobs/update b/gcloud/transfer/jobs/update index cc8469b87..29cb771a0 100644 --- a/gcloud/transfer/jobs/update +++ b/gcloud/transfer/jobs/update @@ -12,6 +12,9 @@ SYNOPSIS --destination-agent-pool=DESTINATION_AGENT_POOL --intermediate-storage-path=INTERMEDIATE_STORAGE_PATH --manifest-file=MANIFEST_FILE] + [--event-stream-name=EVENT_STREAM_NAME + --event-stream-starts=EVENT_STREAM_STARTS + --event-stream-expires=EVENT_STREAM_EXPIRES --clear-event-stream] [--clear-schedule --schedule-starts=SCHEDULE_STARTS --schedule-repeats-every=SCHEDULE_REPEATS_EVERY --schedule-repeats-until=SCHEDULE_REPEATS_UNTIL] @@ -34,7 +37,8 @@ SYNOPSIS --notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC --notification-event-types=[EVENT_TYPES,...] --notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT] - [--clear-log-config --log-actions=[LOG_ACTIONS,...] + [--clear-log-config --[no-]enable-posix-transfer-logs + --log-actions=[LOG_ACTIONS,...] --log-action-states=[LOG_ACTION_STATES,...]] [--source-endpoint=SOURCE_ENDPOINT --source-signing-region=SOURCE_SIGNING_REGION @@ -176,6 +180,41 @@ FLAGS gs://mybucket/manifest.csv. For manifest file formatting, see https://cloud.google.com/storage-transfer/docs/manifest. + EVENT STREAM + + Configure an event stream to transfer data whenever it is added or changed + at your source, enabling you to act on the data in near real time. This + event-driven transfer execution mode is available for transfers from + Google Cloud Storage and Amazon S3. For formatting information, see + https://cloud.google.com/sdk/gcloud/reference/topic/datetimes. + + --event-stream-name=EVENT_STREAM_NAME + Specify an event stream that Storage Transfer Service can use to + listen for when objects are created or updated. For Google Cloud + Storage sources, specify a Cloud Pub/Sub subscription, using format + "projects/yourproject/subscriptions/yoursubscription". For Amazon S3 + sources, specify the Amazon Resource Name (ARN) of an Amazon Simple + Queue Service (SQS) queue using format + "arn:aws:sqs:region:account_id:queue_name". + + --event-stream-starts=EVENT_STREAM_STARTS + Set when to start listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will start running + and listening for events upon the successful submission of the create + job command. + + --event-stream-expires=EVENT_STREAM_EXPIRES + Set when to stop listening for events UTC using the + %Y-%m-%dT%H:%M:%S%z datetime format (e.g., + 2020-04-12T06:42:12+04:00). If not set, the job will continue running + and listening for events indefinitely. + + --clear-event-stream + Remove the job's entire event stream configuration by clearing all + scheduling all event stream flags. The job will no longer listen for + events unless a new configuratin is specified. + SCHEDULE A job's schedule determines when and how often the job will run. For @@ -325,9 +364,20 @@ FLAGS --custom-storage-class=CUSTOM_STORAGE_CLASS Specifies the storage class to set on objects being transferred to - Google Cloud Storage buckets. If unspecified, the behavior is to - match the destination bucket default. The value "preserve" will use - the class from the object's Google Cloud Storage source bucket. + Cloud Storage buckets. If unspecified, the objects' storage class is + set to the destination bucket default. Valid values are: + + ▸ Any of the values listed in the Cloud Storage documentation: + Available storage classes + (https://cloud.google.com/storage/docs/storage-classes#classes). + ▸ preserve - Preserves each object's original storage class. Only + supported for transfers between Cloud Storage buckets. + + Custom storage class settings are ignored if the destination bucket + is Autoclass-enabled + (https://cloud.google.com/storage/docs/autoclass). Objects + transferred into Autoclass-enabled buckets are initially set to the + STANDARD storage class. NOTIFICATION CONFIG @@ -368,6 +418,12 @@ FLAGS --clear-log-config Remove the job's full logging config. + --[no-]enable-posix-transfer-logs + Sets whether to generate logs for transfers with a POSIX filesystem + source. This setting will later be merged with other log + configurations. Use --enable-posix-transfer-logs to enable and + --no-enable-posix-transfer-logs to disable. + --log-actions=[LOG_ACTIONS,...] Define the transfer operation actions to report in logs. Separate multiple actions with commas, omitting spaces after the commas (e.g., diff --git a/gcloud/vmware/help b/gcloud/vmware/help new file mode 100644 index 000000000..4f26a764f --- /dev/null +++ b/gcloud/vmware/help @@ -0,0 +1,34 @@ +NAME + gcloud vmware - manage Google Cloud VMware Engine resources + +SYNOPSIS + gcloud vmware GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Google Cloud VMware Engine resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + locations + List locations in Google Cloud VMware Engine. + + network-policies + Manage VMware Engine network policies in Google Cloud VMware Engine. + + networks + Manage VMware Engine networks in Google Cloud VMware Engine. + + node-types + Show node types in Google Cloud VMware Engine. + + operations + List and describe operations in Google Cloud VMware Engine. + + private-clouds + Manage private clouds in Google Cloud VMware Engine. diff --git a/gcloud/vmware/locations/help b/gcloud/vmware/locations/help new file mode 100644 index 000000000..8e77a4f87 --- /dev/null +++ b/gcloud/vmware/locations/help @@ -0,0 +1,19 @@ +NAME + gcloud vmware locations - list locations in Google Cloud VMware Engine + +SYNOPSIS + gcloud vmware locations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List locations in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + List Google Cloud VMware Engine locations. diff --git a/gcloud/vmware/locations/list b/gcloud/vmware/locations/list new file mode 100644 index 000000000..c19a9dfdc --- /dev/null +++ b/gcloud/vmware/locations/list @@ -0,0 +1,55 @@ +NAME + gcloud vmware locations list - list Google Cloud VMware Engine locations + +SYNOPSIS + gcloud vmware locations list [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List supported VMware Engine locations. + +EXAMPLES + To list VMware Engine locations, run: + + $ gcloud vmware locations list + +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. diff --git a/gcloud/vmware/network-policies/create b/gcloud/vmware/network-policies/create new file mode 100644 index 000000000..b99226382 --- /dev/null +++ b/gcloud/vmware/network-policies/create @@ -0,0 +1,104 @@ +NAME + gcloud vmware network-policies create - create a VMware Engine network + policy + +SYNOPSIS + gcloud vmware network-policies create + (NETWORK_POLICY : --location=LOCATION) + --edge-services-cidr=EDGE_SERVICES_CIDR + --vmware-engine-network=VMWARE_ENGINE_NETWORK [--async] + [--description=DESCRIPTION] [--external-ip-access] [--internet-access] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a VMware Engine network policy. Only one network policy applies to a + VMware Engine network per region. Check the progress of a network policy + creation using gcloud vmware network-policies list. + +EXAMPLES + To create a network policy called my-network-policy which connects to the + VMware Engine network my-vmware-engine-network using the edge services + address range 192.168.0.0/26 with the internet access service enabled and + the external IP access service disabled, run: + + $ gcloud vmware network-policies create my-network-policy \ + --location=us-west2 --project=my-project \ + --vmware-engine-network=my-vmware-engine-network \ + --edge-services-cidr=192.168.0.0/26 --internet-access \ + --no-external-ip-access + + Or: + + $ gcloud vmware network-policies create my-network-policy \ + --vmware-engine-network=my-vmware-engine-network \ + --edge-services-cidr=192.168.0.0/26 --internet-access + + In the second example, the project and the location are taken from gcloud + properties core/project and compute/region respectively. If the + --external-ip-access flag is not specified, it is taken as False. + +POSITIONAL ARGUMENTS + VMware Engine Network Policy resource - network_policy. 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 network_policy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + NETWORK_POLICY + ID of the VMware Engine Network Policy or fully qualified identifier + for the VMware Engine Network Policy. To set the network-policy + attribute: + ▸ provide the argument network_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument network_policy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/region. + +REQUIRED FLAGS + --edge-services-cidr=EDGE_SERVICES_CIDR + IP address range to use for internet access and external IP access + gateways, in CIDR notation. An RFC 1918 CIDR block with a "/26" prefix + is required. + + --vmware-engine-network=VMWARE_ENGINE_NETWORK + Resource ID of the VMware Engine network to attach the new policy to. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + User-provided description of the network policy. + + --external-ip-access + Enable or disable network service that allows external IP addresses to + be assigned to VMware workloads. To enable this service, + internet-access must also be enabled. Use --no-external-ip-access to + disable. If the flag is not provided, access to VMware workloads + through external IP addresses is disabled. + + --internet-access + Enable or disable network service that allows VMware workloads to + access the internet. Use --no-internet-access to disable. If the flag + is not provided, internet access is disabled. + +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. diff --git a/gcloud/vmware/network-policies/delete b/gcloud/vmware/network-policies/delete new file mode 100644 index 000000000..156df21d2 --- /dev/null +++ b/gcloud/vmware/network-policies/delete @@ -0,0 +1,66 @@ +NAME + gcloud vmware network-policies delete - delete a VMware Engine network + policy + +SYNOPSIS + gcloud vmware network-policies delete + (NETWORK_POLICY : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a VMware Engine network policy. + +EXAMPLES + To delete a network policy called my-network-policy in project my-project + and region us-west2, run: + + $ gcloud vmware network-policies delete my-network-policy \ + --location=us-west2 --project=my-project + + Or: + + $ gcloud vmware network-policies delete my-network-policy + + In the second example, the project and the location are taken from gcloud + properties core/project and compute/region respectively. + +POSITIONAL ARGUMENTS + VMware Engine Network Policy resource - network_policy. 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 network_policy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + NETWORK_POLICY + ID of the VMware Engine Network Policy or fully qualified identifier + for the VMware Engine Network Policy. To set the network-policy + attribute: + ▸ provide the argument network_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument network_policy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/network-policies/describe b/gcloud/vmware/network-policies/describe new file mode 100644 index 000000000..991171aff --- /dev/null +++ b/gcloud/vmware/network-policies/describe @@ -0,0 +1,60 @@ +NAME + gcloud vmware network-policies describe - describe a VMware Engine network + policy + +SYNOPSIS + gcloud vmware network-policies describe + (NETWORK_POLICY : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a VMware Engine network policy. + +EXAMPLES + To get a description of a network policy called my-network-policy in + project my-project and region us-west2, run: + + $ gcloud vmware network-policies describe my-network-policy \ + --location=us-west2 --project=my-project + + Or: + + $ gcloud vmware network-policies describe my-network-policy + + In the second example, the project and the location are taken from gcloud + properties core/project and compute/region respectively. + +POSITIONAL ARGUMENTS + VMware Engine Network Policy resource - network_policy. 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 network_policy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + NETWORK_POLICY + ID of the VMware Engine Network Policy or fully qualified identifier + for the VMware Engine Network Policy. To set the network-policy + attribute: + ▸ provide the argument network_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument network_policy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/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. diff --git a/gcloud/vmware/network-policies/help b/gcloud/vmware/network-policies/help new file mode 100644 index 000000000..9a81b4f69 --- /dev/null +++ b/gcloud/vmware/network-policies/help @@ -0,0 +1,32 @@ +NAME + gcloud vmware network-policies - manage VMware Engine network policies in + Google Cloud VMware Engine + +SYNOPSIS + gcloud vmware network-policies GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage VMware Engine network policies in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a VMware Engine network policy. + + delete + Delete a VMware Engine network policy. + + describe + Describe a VMware Engine network policy. + + list + List VMware Engine network policies. + + update + Update a VMware Engine network policy. diff --git a/gcloud/vmware/network-policies/list b/gcloud/vmware/network-policies/list new file mode 100644 index 000000000..28d2dcd87 --- /dev/null +++ b/gcloud/vmware/network-policies/list @@ -0,0 +1,92 @@ +NAME + gcloud vmware network-policies list - list VMware Engine network policies + +SYNOPSIS + gcloud vmware network-policies list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List VMware Engine network policies. + +EXAMPLES + To list network policies in your project in the region us-west2 sorted from + oldest to newest, run: + + $ gcloud vmware network-policies list --location=us-west2 \ + --project=my-project --sort-by=~create_time + + Or: + + $ gcloud vmware network-policies list --sort-by=~create_time + + In the second example, the project and the location are taken from gcloud + properties core/project and compute/region respectively. + + To list network policies in your project from all regions, run: + + $ gcloud vmware network-policies list --location=- \ + --project=my-project + + Or: + + $ gcloud vmware network-policies list --location=- + + In the last example, the project is taken from gcloud properties + core/project. + +FLAGS + Location resource - location. 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 --location on the command line with a fully + specified name; + ◆ set the property compute/region with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property compute/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. diff --git a/gcloud/vmware/network-policies/update b/gcloud/vmware/network-policies/update new file mode 100644 index 000000000..b19055819 --- /dev/null +++ b/gcloud/vmware/network-policies/update @@ -0,0 +1,86 @@ +NAME + gcloud vmware network-policies update - update a VMware Engine network + policy + +SYNOPSIS + gcloud vmware network-policies update + (NETWORK_POLICY : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--edge-services-cidr=EDGE_SERVICES_CIDR] + [--external-ip-access] [--internet-access] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a VMware Engine network policy. + +EXAMPLES + To update a network policy named my-network-policy so that it disables the + external IP access service, run: + + $ gcloud vmware network-policies update my-network-policy \ + --location=us-west2 --project=my-project --no-external-ip-access + + Or: + + $ gcloud vmware network-policies update my-network-policy \ + --no-external-ip-access + + In the second example, the project and the location are taken from gcloud + properties core/project and compute/regions respectively. + +POSITIONAL ARGUMENTS + VMware Engine Network Policy resource - network_policy. 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 network_policy on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + NETWORK_POLICY + ID of the VMware Engine Network Policy or fully qualified identifier + for the VMware Engine Network Policy. To set the network-policy + attribute: + ▸ provide the argument network_policy on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument network_policy on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + Updated description for the network policy. + + --edge-services-cidr=EDGE_SERVICES_CIDR + Updated IP address range to use for internet access and external IP + access gateways, in CIDR notation. + + --external-ip-access + Enable or disable network service that allows external IP addresses to + be assigned to VMware workloads. To enable this service, + internet-access must also be enabled. Use --no-external-ip-access to + disable. + + --internet-access + Enable or disable network service that allows VMware workloads to + access the internet. Use --no-internet-access to disable. + +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. diff --git a/gcloud/vmware/networks/create b/gcloud/vmware/networks/create new file mode 100644 index 000000000..025c48abd --- /dev/null +++ b/gcloud/vmware/networks/create @@ -0,0 +1,98 @@ +NAME + gcloud vmware networks create - create a Google Cloud VMware Engine network + +SYNOPSIS + gcloud vmware networks create (VMWARE_ENGINE_NETWORK : --location=LOCATION) + --type=TYPE [--async] [--description=DESCRIPTION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a VMware Engine network. VMware Engine network creation is + considered finished when the VMware Engine network is in ACTIVE state. + Check the progress of a VMware Engine network creation using gcloud vmware + networks list. + +EXAMPLES + To create a VMware Engine network of type STANDARD, run: + + $ gcloud vmware networks create my-network --type=STANDARD \ + --location=global --project=my-project + + Or: + + $ gcloud vmware networks create my-network --type=STANDARD + + In the second example, the project is taken from gcloud properties + core/project and the location is taken as global. + + To create a VMware Engine network of type LEGACY in the us-west2 region, + run: + + $ gcloud vmware networks create my-network --type=LEGACY \ + --location=us-west2 --project=my-project + + Or: + + $ gcloud vmware networks create my-network --type=LEGACY \ + --location=us-west2 + + In the last example, the project is taken from gcloud properties + core/project. For VMware Engine networks of type LEGACY, you must always + specify a region as the location. + +POSITIONAL ARGUMENTS + VMware Engine network resource - vmware_engine_network. 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 vmware_engine_network on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + VMWARE_ENGINE_NETWORK + ID of the VMware Engine network or fully qualified identifier for the + VMware Engine network. To set the vmware-engine-network attribute: + ▸ provide the argument vmware_engine_network on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument vmware_engine_network on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default) or a region. + +REQUIRED FLAGS + --type=TYPE + Type of the VMware Engine network. TYPE must be one of: + + LEGACY + Network type used by private clouds created in projects without a + network of type STANDARD. This network type is only used for new + PCs in existing projects that continue to use LEGACY network. A + VMware Engine network of type LEGACY is a regional resource. + STANDARD + Standard network type used for private cloud connectivity. A VMware + Engine network of type STANDARD is a global resource. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + Text describing the VMware Engine network. + +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. diff --git a/gcloud/vmware/networks/delete b/gcloud/vmware/networks/delete new file mode 100644 index 000000000..90d3d811d --- /dev/null +++ b/gcloud/vmware/networks/delete @@ -0,0 +1,78 @@ +NAME + gcloud vmware networks delete - delete a Google Cloud VMware Engine network + +SYNOPSIS + gcloud vmware networks delete (VMWARE_ENGINE_NETWORK : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a VMware Engine network. + +EXAMPLES + To delete a network called my-network of type STANDARD in project + my-project and region global, run: + + $ gcloud vmware networks delete my-network --location=global \ + --project=my-project + + Or: + + $ gcloud vmware networks delete my-network + + In the second example, the project is taken from gcloud properties + core/project and the location is taken as global. + + To delete a network called my-network of type LEAGACY in project my-project + and region us-west2, run: + + $ gcloud vmware networks delete my-network --location=us-west2 \ + --project=my-project + + Or: + + $ gcloud vmware networks delete my-network --location=us-west2 + + In the last example, the project is taken from gcloud properties + core/project. For VMware Engine networks of type LEGACY, you must always + specify a region as the location. + +POSITIONAL ARGUMENTS + VMware Engine network resource - vmware_engine_network. 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 vmware_engine_network on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + VMWARE_ENGINE_NETWORK + ID of the VMware Engine network or fully qualified identifier for the + VMware Engine network. To set the vmware-engine-network attribute: + ▸ provide the argument vmware_engine_network on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument vmware_engine_network on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default) or a region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/networks/describe b/gcloud/vmware/networks/describe new file mode 100644 index 000000000..57354f146 --- /dev/null +++ b/gcloud/vmware/networks/describe @@ -0,0 +1,73 @@ +NAME + gcloud vmware networks describe - describe a Google Cloud VMware Engine + network + +SYNOPSIS + gcloud vmware networks describe + (VMWARE_ENGINE_NETWORK : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a VMware Engine network. + +EXAMPLES + To get a description of a network called my-network of type STANDARD in + project my-project and region global, run: + + $ gcloud vmware networks describe my-network --location=global \ + --project=my-project + + Or: + + $ gcloud vmware networks describe my-network + + In the second example, the project is taken from gcloud properties + core/project and the location is taken as global. + + To get a description of a network called my-network of type LEGACY in + project my-project and region us-west2, run: + + $ gcloud vmware networks describe my-network --location=us-west2 \ + --project=my-project + + Or: + + $ gcloud vmware networks describe my-network --location=us-west2 + + In the last example, the project is taken from gcloud properties + core/project. For VMware Engine networks of type LEGACY, you must always + specify a region as the location. + +POSITIONAL ARGUMENTS + VMware Engine network resource - vmware_engine_network. 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 vmware_engine_network on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + VMWARE_ENGINE_NETWORK + ID of the VMware Engine network or fully qualified identifier for the + VMware Engine network. To set the vmware-engine-network attribute: + ▸ provide the argument vmware_engine_network on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument vmware_engine_network on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default) or a 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. diff --git a/gcloud/vmware/networks/help b/gcloud/vmware/networks/help new file mode 100644 index 000000000..376ae9823 --- /dev/null +++ b/gcloud/vmware/networks/help @@ -0,0 +1,32 @@ +NAME + gcloud vmware networks - manage VMware Engine networks in Google Cloud + VMware Engine + +SYNOPSIS + gcloud vmware networks COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage VMware Engine networks in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Google Cloud VMware Engine network. + + delete + Delete a Google Cloud VMware Engine network. + + describe + Describe a Google Cloud VMware Engine network. + + list + List Google Cloud VMware Engine networks. + + update + Update a Google Cloud VMware Engine network. diff --git a/gcloud/vmware/networks/list b/gcloud/vmware/networks/list new file mode 100644 index 000000000..e0d03aecd --- /dev/null +++ b/gcloud/vmware/networks/list @@ -0,0 +1,93 @@ +NAME + gcloud vmware networks list - list Google Cloud VMware Engine networks + +SYNOPSIS + gcloud vmware networks list [--location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List VMware Engine networks. + +EXAMPLES + To list VMware Engine networks of type STANDARD in your project, run: + + $ gcloud vmware networks list --location=global --project=my-project + + Or: + + $ gcloud vmware networks list + + In the second example, the project is taken from gcloud properties + core/project and the location is taken as global. + + To list VMware Engine networks of type LEGACY in the location us-west2 in + your project, run: + + $ gcloud vmware networks list --location=us-west2 \ + --project=my-project + + Or: + + $ gcloud vmware networks list --location=us-west2 + + In the last example, the project is taken from gcloud properties + core/project. For VMware Engine networks of type LEGACY, you must always + specify a region as the location. + +FLAGS + Location resource - location. 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 --location on the command line with a fully + specified name; + ◆ set location as 'global' (default) or a region with a fully specified + name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default) or a 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. diff --git a/gcloud/vmware/networks/update b/gcloud/vmware/networks/update new file mode 100644 index 000000000..23fb5a9b4 --- /dev/null +++ b/gcloud/vmware/networks/update @@ -0,0 +1,83 @@ +NAME + gcloud vmware networks update - update a Google Cloud VMware Engine network + +SYNOPSIS + gcloud vmware networks update (VMWARE_ENGINE_NETWORK : --location=LOCATION) + [--async] [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a VMware Engine network. + +EXAMPLES + To update a network named my-network of type STANDARD by changing its + description to Example description, run: + + $ gcloud vmware networks update my-network --location=global \ + --project=my-project --description='Example description' + + Or: + + $ gcloud vmware networks update my-network \ + --description='Example description' + + In the second example, the project is taken from gcloud properties + core/project and the location is taken as global. + + To update a network named my-network of type LEGACY by changing its + description to Example description, run: + + $ gcloud vmware networks update my-network --location=us-west2 \ + --project=my-project --description='Example description' + + Or: + + $ gcloud vmware networks update my-network --location=us-west2 \ + --description='Example description' + + In the last example, the project is taken from gcloud properties + core/project. For VMware Engine networks of type LEGACY, you must always + specify a region as the location. + +POSITIONAL ARGUMENTS + VMware Engine network resource - vmware_engine_network. 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 vmware_engine_network on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + VMWARE_ENGINE_NETWORK + ID of the VMware Engine network or fully qualified identifier for the + VMware Engine network. To set the vmware-engine-network attribute: + ▸ provide the argument vmware_engine_network on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. To set the location attribute: + ▸ provide the argument vmware_engine_network on the command line + with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default) or a region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + Text describing the VMware Engine network + +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. diff --git a/gcloud/vmware/node-types/describe b/gcloud/vmware/node-types/describe new file mode 100644 index 000000000..ff54ec783 --- /dev/null +++ b/gcloud/vmware/node-types/describe @@ -0,0 +1,59 @@ +NAME + gcloud vmware node-types describe - display data associated with a Google + Cloud VMware Engine node type + +SYNOPSIS + gcloud vmware node-types describe (NODE_TYPE : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Display data associated with a VMware Engine node type, such as its + compute, storage, and memory. + +EXAMPLES + To describe node type standard-72 in location us-west1-a, run: + + $ gcloud vmware node-types describe standard-72 \ + --location=us-central1 --project=my-project + + Or: + + $ gcloud vmware node-types describe standard-72 + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Node type resource - node_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 node_type on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + NODE_TYPE + ID of the node type or fully qualified identifier for the node type. + To set the node-type attribute: + ▸ provide the argument node_type on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument node_type on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/node-types/help b/gcloud/vmware/node-types/help new file mode 100644 index 000000000..59f37a9c6 --- /dev/null +++ b/gcloud/vmware/node-types/help @@ -0,0 +1,22 @@ +NAME + gcloud vmware node-types - show node types in Google Cloud VMware Engine + +SYNOPSIS + gcloud vmware node-types COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show node types in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Display data associated with a Google Cloud VMware Engine node type. + + list + List supported Google Cloud VMware Engine node types. diff --git a/gcloud/vmware/node-types/list b/gcloud/vmware/node-types/list new file mode 100644 index 000000000..3ff87f0f0 --- /dev/null +++ b/gcloud/vmware/node-types/list @@ -0,0 +1,80 @@ +NAME + gcloud vmware node-types list - list supported Google Cloud VMware Engine + node types + +SYNOPSIS + gcloud vmware node-types list [--location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List VMware Engine node types. + +EXAMPLES + To list VMware Engine node types, run: + + $ gcloud vmware node-types list --location=us-central1 \ + --project=my-project + + Or: + + $ gcloud vmware node-types list + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +FLAGS + Location resource - location. 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 --location on the command line with a fully + specified name; + ◆ set the property compute/zone with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/operations/describe b/gcloud/vmware/operations/describe new file mode 100644 index 000000000..6e515d911 --- /dev/null +++ b/gcloud/vmware/operations/describe @@ -0,0 +1,61 @@ +NAME + gcloud vmware operations describe - describe a Google Cloud VMware Engine + operation + +SYNOPSIS + gcloud vmware operations describe (OPERATION : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a VMware Engine operation. An operation contains information about + the status of a previous request. + +EXAMPLES + To get details about an operation on a private cloud with the operation ID + operation-111-222-333-444, run: + + $ gcloud vmware operations describe operation-111-222-333-444 \ + --location=us-central1 --project=my-project + + Or: + + $ gcloud vmware operations describe operation-111-222-333-444 \ + --location=us-central1 + + In the second example, the location is taken from gcloud property + compute/zone. + +POSITIONAL ARGUMENTS + Operation resource - operation. 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 operation on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/operations/help b/gcloud/vmware/operations/help new file mode 100644 index 000000000..b50ec8edc --- /dev/null +++ b/gcloud/vmware/operations/help @@ -0,0 +1,23 @@ +NAME + gcloud vmware operations - list and describe operations in Google Cloud + VMware Engine + +SYNOPSIS + gcloud vmware operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List and describe operations in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe a Google Cloud VMware Engine operation. + + list + List Google Cloud VMware Engine operations. diff --git a/gcloud/vmware/operations/list b/gcloud/vmware/operations/list new file mode 100644 index 000000000..e36606cf8 --- /dev/null +++ b/gcloud/vmware/operations/list @@ -0,0 +1,78 @@ +NAME + gcloud vmware operations list - list Google Cloud VMware Engine operations + +SYNOPSIS + gcloud vmware operations list [--location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List VMware Engine operations in a location. + +EXAMPLES + To list VMware Engine operations in a location us-west2-a, run: + + $ gcloud vmware operations list --location=us-west2-a + + Or: + + $ gcloud vmware operations list + + In the second example, the location is taken from gcloud property + compute/zone. + +FLAGS + Location resource - location. 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 --location on the command line with a fully + specified name; + ◆ set the property compute/zone with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/clusters/create b/gcloud/vmware/private-clouds/clusters/create new file mode 100644 index 000000000..8e2d3f7ef --- /dev/null +++ b/gcloud/vmware/private-clouds/clusters/create @@ -0,0 +1,93 @@ +NAME + gcloud vmware private-clouds clusters create - create a Google Cloud VMware + Engine cluster + +SYNOPSIS + gcloud vmware private-clouds clusters create + (CLUSTER : --location=LOCATION --private-cloud=PRIVATE_CLOUD) + --node-type-config=[count=COUNT], + [custom-core-count=CUSTOM-CORE-COUNT],[type=TYPE] [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a cluster in a VMware Engine private cloud. Successful creation of a + cluster results in a cluster in READY state. Check the progress of a + cluster using gcloud vmware private-clouds clusters list. + +EXAMPLES + To create a cluster called my-cluster in private cloud my-private-cloud, + with 3 initial standard-72 nodes in zone us-west2-a, run: + + $ gcloud vmware private-clouds clusters create my-cluster \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud \ + --node-type-config=type=standard-72,count=3 + + Or: + + $ gcloud vmware private-clouds clusters create my-cluster \ + --private-cloud=my-private-cloud \ + --node-type-config=type=standard-72,count=3 + + In the second example, the project and location are taken from gcloud properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Cluster resource - cluster. 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 cluster on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + + --private-cloud=PRIVATE_CLOUD + VMware Engine private cloud. To set the private-cloud attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --private-cloud on the command line. + +REQUIRED FLAGS + --node-type-config=[count=COUNT],[custom-core-count=CUSTOM-CORE-COUNT],[type=TYPE] + Information about the type and number of nodes associated with the + cluster. + + type (required): canonical identifier of the node type. + + count (required): number of nodes of this type in the cluster. + + custom-core-count (optional): customized number of cores available to + each node of the type. To get a list of valid values for your node + type, run the gcloud vmware node-types describe command and reference + the availableCustomCoreCounts field in the output. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/clusters/delete b/gcloud/vmware/private-clouds/clusters/delete new file mode 100644 index 000000000..83b1e318c --- /dev/null +++ b/gcloud/vmware/private-clouds/clusters/delete @@ -0,0 +1,74 @@ +NAME + gcloud vmware private-clouds clusters delete - delete a Google Cloud VMware + Engine cluster + +SYNOPSIS + gcloud vmware private-clouds clusters delete + (CLUSTER : --location=LOCATION --private-cloud=PRIVATE_CLOUD) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a cluster in a VMware Engine private cloud. + +EXAMPLES + To delete a cluster called my-cluster in private cloud my-private-cloud and + zone us-west2-a, run: + + $ gcloud vmware private-clouds clusters delete my-cluster \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud + + Or: + + $ gcloud vmware private-clouds clusters delete my-cluster \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Cluster resource - cluster. 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 cluster on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + + --private-cloud=PRIVATE_CLOUD + VMware Engine private cloud. To set the private-cloud attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --private-cloud on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/clusters/describe b/gcloud/vmware/private-clouds/clusters/describe new file mode 100644 index 000000000..5f0cbc367 --- /dev/null +++ b/gcloud/vmware/private-clouds/clusters/describe @@ -0,0 +1,68 @@ +NAME + gcloud vmware private-clouds clusters describe - describe a Google Cloud + VMware Engine cluster + +SYNOPSIS + gcloud vmware private-clouds clusters describe + (CLUSTER : --location=LOCATION --private-cloud=PRIVATE_CLOUD) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Display data associated with a VMware Engine cluster, such as its node + count, node type, and status. + +EXAMPLES + To describe a cluster called my-cluster in private cloud my-private-cloud + and zone us-west2-a, run: + + $ gcloud vmware private-clouds clusters describe my-cluster \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud + + Or: + + $ gcloud vmware private-clouds clusters describe my-cluster \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Cluster resource - cluster. 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 cluster on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + + --private-cloud=PRIVATE_CLOUD + VMware Engine private cloud. To set the private-cloud attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --private-cloud 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. diff --git a/gcloud/vmware/private-clouds/clusters/help b/gcloud/vmware/private-clouds/clusters/help new file mode 100644 index 000000000..26b787920 --- /dev/null +++ b/gcloud/vmware/private-clouds/clusters/help @@ -0,0 +1,32 @@ +NAME + gcloud vmware private-clouds clusters - manage clusters in Google Cloud + VMware Engine + +SYNOPSIS + gcloud vmware private-clouds clusters COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage clusters in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Google Cloud VMware Engine cluster. + + delete + Delete a Google Cloud VMware Engine cluster. + + describe + Describe a Google Cloud VMware Engine cluster. + + list + List clusters in a Google Cloud VMware Engine private cloud. + + update + Update a Google Cloud VMware Engine cluster. diff --git a/gcloud/vmware/private-clouds/clusters/list b/gcloud/vmware/private-clouds/clusters/list new file mode 100644 index 000000000..d67e9709d --- /dev/null +++ b/gcloud/vmware/private-clouds/clusters/list @@ -0,0 +1,93 @@ +NAME + gcloud vmware private-clouds clusters list - list clusters in a Google + Cloud VMware Engine private cloud + +SYNOPSIS + gcloud vmware private-clouds clusters list + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List clusters in a VMware Engine private cloud. + +EXAMPLES + To list clusters in the my-private-cloud private cloud run: + + $ gcloud vmware private-clouds clusters list --location=us-west2-a \ + --project=my-project --private-cloud=my-private-cloud + + Or: + + $ gcloud vmware private-clouds clusters list \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/clusters/update b/gcloud/vmware/private-clouds/clusters/update new file mode 100644 index 000000000..3318237b5 --- /dev/null +++ b/gcloud/vmware/private-clouds/clusters/update @@ -0,0 +1,93 @@ +NAME + gcloud vmware private-clouds clusters update - update a Google Cloud VMware + Engine cluster + +SYNOPSIS + gcloud vmware private-clouds clusters update + (CLUSTER : --location=LOCATION --private-cloud=PRIVATE_CLOUD) + --node-type-config=[count=COUNT], + [custom-core-count=CUSTOM-CORE-COUNT],[type=TYPE] [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Adjust the number of nodes in the VMware Engine cluster. Successful + addition or removal of a node results in a cluster in READY state. Check + the progress of a cluster using gcloud vmware private-clouds clusters list. + +EXAMPLES + To resize a cluster called my-cluster in private cloud my-private-cloud and + zone us-west2-a to have ``3'' nodes, run: + + $ gcloud vmware private-clouds clusters update my-cluster \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud \ + --node-type-config=type=standard-72,count=3 + + Or: + + $ gcloud vmware private-clouds clusters update my-cluster \ + --private-cloud=my-private-cloud \ + --node-type-config=type=standard-72,count=3 + + In the second example, the project and location are taken from gcloud properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Cluster resource - cluster. 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 cluster on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument cluster on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + + --private-cloud=PRIVATE_CLOUD + VMware Engine private cloud. To set the private-cloud attribute: + ▸ provide the argument cluster on the command line with a fully + specified name; + ▸ provide the argument --private-cloud on the command line. + +REQUIRED FLAGS + --node-type-config=[count=COUNT],[custom-core-count=CUSTOM-CORE-COUNT],[type=TYPE] + Information about the type and number of nodes associated with the + cluster. + + type (required): canonical identifier of the node type. + + count (required): number of nodes of this type in the cluster. + + custom-core-count (optional): customized number of cores available to + each node of the type. To get a list of valid values for your node + type, run the gcloud vmware node-types describe command and reference + the availableCustomCoreCounts field in the output. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/create b/gcloud/vmware/private-clouds/create new file mode 100644 index 000000000..89b698d66 --- /dev/null +++ b/gcloud/vmware/private-clouds/create @@ -0,0 +1,125 @@ +NAME + gcloud vmware private-clouds create - create a VMware Engine private cloud + +SYNOPSIS + gcloud vmware private-clouds create (PRIVATE_CLOUD : --location=LOCATION) + --cluster=CLUSTER --management-range=MANAGEMENT_RANGE + --node-type-config=[count=COUNT], + [custom-core-count=CUSTOM-CORE-COUNT],[type=TYPE] + --vmware-engine-network=VMWARE_ENGINE_NETWORK [--async] + [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a VMware Engine private cloud. Private cloud creation is considered + finished when the private cloud is in READY state. Check the progress of a + private cloud using gcloud vmware private-clouds list. + +EXAMPLES + To create a private cloud in the us-west2-a zone using standard-72 nodes + that connects to the my-network VMware Engine network, run: + + $ gcloud vmware private-clouds create my-private-cloud \ + --location=us-west2-a --project=my-project \ + --cluster=my-management-cluster \ + --node-type-config=type=standard-72,count=3 \ + --management-range=192.168.0.0/24 \ + --vmware-engine-network=my-network + + Or: + + $ gcloud vmware private-clouds create my-private-cloud \ + --cluster=my-management-cluster \ + --node-type-config=type=standard-72,count=3 \ + --management-range=192.168.0.0/24 \ + --vmware-engine-network=my-network + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Private cloud resource - private_cloud. 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 private_cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument private_cloud on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument private_cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +REQUIRED FLAGS + Cluster resource - cluster. 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 --cluster 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 + location attribute: + ◆ provide the argument --cluster on the command line with a fully + specified name; + ◆ set the property compute/zone. To set the private-cloud attribute: + ◆ provide the argument --cluster on the command line with a fully + specified name. + + This must be specified. + + --cluster=CLUSTER + ID of the cluster or fully qualified identifier for the cluster. To + set the cluster attribute: + ▸ provide the argument --cluster on the command line. + + --management-range=MANAGEMENT_RANGE + IP address range in the private cloud to use for management appliances, + in CIDR format. Use an IP address range that meets the VMware Engine + networking requirements + (https://cloud.google.com/vmware-engine/docs/quickstart-networking-requirements). + + --node-type-config=[count=COUNT],[custom-core-count=CUSTOM-CORE-COUNT],[type=TYPE] + Information about the type and number of nodes associated with the + cluster. + + type (required): canonical identifier of the node type. + + count (required): number of nodes of this type in the cluster. + + custom-core-count (optional): customized number of cores available to + each node of the type. To get a list of valid values for your node + type, run the gcloud vmware node-types describe command and reference + the availableCustomCoreCounts field in the output. + + --vmware-engine-network=VMWARE_ENGINE_NETWORK + Resource ID of the VMware Engine network attached to the private cloud. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + Text describing the private cloud. + +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. diff --git a/gcloud/vmware/private-clouds/delete b/gcloud/vmware/private-clouds/delete new file mode 100644 index 000000000..c8c714dd9 --- /dev/null +++ b/gcloud/vmware/private-clouds/delete @@ -0,0 +1,71 @@ +NAME + gcloud vmware private-clouds delete - delete a Google Cloud VMware Engine + private cloud + +SYNOPSIS + gcloud vmware private-clouds delete (PRIVATE_CLOUD : --location=LOCATION) + [--async] [--delay-hours=DELAY_HOURS; default=3] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Marks a VMware Engine private cloud for deletion. The resource is deleted 3 + hours after being marked for deletion. This process can be reversed by + using gcloud vmware private-clouds undelete. + +EXAMPLES + To mark a private cloud called my-private-cloud for deletion, run: + + $ gcloud vmware private-clouds delete my-private-cloud \ + --location=us-west2-a --project=my-project + + Or: + + $ gcloud vmware private-clouds delete my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Private cloud resource - private_cloud. 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 private_cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument private_cloud on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument private_cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --delay-hours=DELAY_HOURS; default=3 + Number of hours to wait before deleting the private cloud. Specifying a + value of 0 for this field begins the deletion process immediately. + DELAY_HOURS must be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8. + +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. diff --git a/gcloud/vmware/private-clouds/describe b/gcloud/vmware/private-clouds/describe new file mode 100644 index 000000000..472e84dc5 --- /dev/null +++ b/gcloud/vmware/private-clouds/describe @@ -0,0 +1,59 @@ +NAME + gcloud vmware private-clouds describe - describe a Google Cloud VMware + Engine private cloud + +SYNOPSIS + gcloud vmware private-clouds describe (PRIVATE_CLOUD : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Describe a VMware Engine private cloud. + +EXAMPLES + To get a description of a private cloud called my-private-cloud in project + my-project and zone us-west2-a, run: + + $ gcloud vmware private-clouds describe my-private-cloud \ + --location=us-west2-a --project=my-project + + Or: + + $ gcloud vmware private-clouds describe my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Private cloud resource - private_cloud. 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 private_cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument private_cloud on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument private_cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/hcx/activationkeys/create b/gcloud/vmware/private-clouds/hcx/activationkeys/create new file mode 100644 index 000000000..ce7521aaa --- /dev/null +++ b/gcloud/vmware/private-clouds/hcx/activationkeys/create @@ -0,0 +1,78 @@ +NAME + gcloud vmware private-clouds hcx activationkeys create - create a Google + Cloud VMware HCX activation key + +SYNOPSIS + gcloud vmware private-clouds hcx activationkeys create + (HCX_ACTIVATION_KEY + : --location=LOCATION --private-cloud=PRIVATE_CLOUD) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a HCX activation key in a VMware Engine private cloud. Successful + creation of a HCX activation key results in a HCX activation key in + AVAILABLE state. Check the progress of a HCX activation key using gcloud + vmware private-clouds hcx activationkeys list. + +EXAMPLES + To create a HCX activation key called key1 in private cloud + my-private-cloud in zone us-west2-a, run: + + $ gcloud vmware private-clouds hcx activationkeys create key1 \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud + + Or: + + $ gcloud vmware private-clouds hcx activationkeys create \ + my-cluster --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + HCX activation key resource - hcxactivationkey. 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 hcx_activation_key on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + HCX_ACTIVATION_KEY + ID of the HCX activation key or fully qualified identifier for the + HCX activation key. To set the hcx-activation-key attribute: + ▸ provide the argument hcx_activation_key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument hcx_activation_key on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + + --private-cloud=PRIVATE_CLOUD + VMware Engine private cloud. To set the private-cloud attribute: + ▸ provide the argument hcx_activation_key on the command line with + a fully specified name; + ▸ provide the argument --private-cloud on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/hcx/activationkeys/describe b/gcloud/vmware/private-clouds/hcx/activationkeys/describe new file mode 100644 index 000000000..93b476ee8 --- /dev/null +++ b/gcloud/vmware/private-clouds/hcx/activationkeys/describe @@ -0,0 +1,69 @@ +NAME + gcloud vmware private-clouds hcx activationkeys describe - describe a + Google Cloud VMware HCX activation key + +SYNOPSIS + gcloud vmware private-clouds hcx activationkeys describe + (HCX_ACTIVATION_KEY + : --location=LOCATION --private-cloud=PRIVATE_CLOUD) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Display data associated with an HCX activation key, such as the key itself, + its resource name, and when it was created. + +EXAMPLES + To describe a HCX activation key called key1 in private cloud + my-private-cloud in zone us-west2-a, run: + + $ gcloud vmware private-clouds hcx activationkeys describe key1 \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud + + Or: + + $ gcloud vmware private-clouds hcx activationkeys describe key1 \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + HCX activation key resource - hcxactivationkey. 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 hcx_activation_key on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + HCX_ACTIVATION_KEY + ID of the HCX activation key or fully qualified identifier for the + HCX activation key. To set the hcx-activation-key attribute: + ▸ provide the argument hcx_activation_key on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument hcx_activation_key on the command line with + a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + + --private-cloud=PRIVATE_CLOUD + VMware Engine private cloud. To set the private-cloud attribute: + ▸ provide the argument hcx_activation_key on the command line with + a fully specified name; + ▸ provide the argument --private-cloud 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. diff --git a/gcloud/vmware/private-clouds/hcx/activationkeys/help b/gcloud/vmware/private-clouds/hcx/activationkeys/help new file mode 100644 index 000000000..b38eda4ee --- /dev/null +++ b/gcloud/vmware/private-clouds/hcx/activationkeys/help @@ -0,0 +1,27 @@ +NAME + gcloud vmware private-clouds hcx activationkeys - manage VMware HCX + activation keys using Google Cloud VMware Engine + +SYNOPSIS + gcloud vmware private-clouds hcx activationkeys COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage VMware HCX activation keys using Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Google Cloud VMware HCX activation key. + + describe + Describe a Google Cloud VMware HCX activation key. + + list + List HCX activation keys in a Google Cloud VMware Engine private cloud. diff --git a/gcloud/vmware/private-clouds/hcx/activationkeys/list b/gcloud/vmware/private-clouds/hcx/activationkeys/list new file mode 100644 index 000000000..3dd630186 --- /dev/null +++ b/gcloud/vmware/private-clouds/hcx/activationkeys/list @@ -0,0 +1,94 @@ +NAME + gcloud vmware private-clouds hcx activationkeys list - list HCX activation + keys in a Google Cloud VMware Engine private cloud + +SYNOPSIS + gcloud vmware private-clouds hcx activationkeys list + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List HCX activation keys in a VMware Engine private cloud. + +EXAMPLES + To list HCX activation keys in the my-private-cloud private cloud run: + + $ gcloud vmware private-clouds hcx activationkeys list \ + --location=us-west2-a --project=my-project \ + --private-cloud=my-private-cloud + + Or: + + $ gcloud vmware private-clouds hcx activationkeys list \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/hcx/help b/gcloud/vmware/private-clouds/hcx/help new file mode 100644 index 000000000..72d055a05 --- /dev/null +++ b/gcloud/vmware/private-clouds/hcx/help @@ -0,0 +1,20 @@ +NAME + gcloud vmware private-clouds hcx - manage HCX using Google Cloud VMware + Engine + +SYNOPSIS + gcloud vmware private-clouds hcx GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage HCX using Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + activationkeys + Manage VMware HCX activation keys using Google Cloud VMware Engine. diff --git a/gcloud/vmware/private-clouds/help b/gcloud/vmware/private-clouds/help new file mode 100644 index 000000000..8cc486a5b --- /dev/null +++ b/gcloud/vmware/private-clouds/help @@ -0,0 +1,53 @@ +NAME + gcloud vmware private-clouds - manage private clouds in Google Cloud VMware + Engine + +SYNOPSIS + gcloud vmware private-clouds GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage private clouds in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + clusters + Manage clusters in Google Cloud VMware Engine. + + hcx + Manage HCX using Google Cloud VMware Engine. + + nsx + Manage NSX using Google Cloud VMware Engine. + + subnets + Manage vmware subnets in Google Cloud VMware Engine. + + vcenter + Manage vCenter resources in Google Cloud VMware Engine. + +COMMANDS + COMMAND is one of the following: + + create + Create a VMware Engine private cloud. + + delete + Delete a Google Cloud VMware Engine private cloud. + + describe + Describe a Google Cloud VMware Engine private cloud. + + list + List Google Cloud VMware Engine private clouds. + + undelete + Cancel deletion of a Google Cloud VMware Engine private cloud. + + update + Update a Google Cloud VMware Engine private cloud. diff --git a/gcloud/vmware/private-clouds/list b/gcloud/vmware/private-clouds/list new file mode 100644 index 000000000..8b13341d3 --- /dev/null +++ b/gcloud/vmware/private-clouds/list @@ -0,0 +1,79 @@ +NAME + gcloud vmware private-clouds list - list Google Cloud VMware Engine private + clouds + +SYNOPSIS + gcloud vmware private-clouds list [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List VMware Engine private clouds. + +EXAMPLES + To list VMware Engine operations in the location us-west2-a, run: + + $ gcloud vmware private-clouds list --location=us-west2-a + + Or: + + $ gcloud vmware private-clouds list + + In the second example, the location is taken from gcloud properties + compute/zone. + +FLAGS + Location resource - location. 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 --location on the command line with a fully + specified name; + ◆ set the property compute/zone with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/nsx/credentials/describe b/gcloud/vmware/private-clouds/nsx/credentials/describe new file mode 100644 index 000000000..9aa20929c --- /dev/null +++ b/gcloud/vmware/private-clouds/nsx/credentials/describe @@ -0,0 +1,63 @@ +NAME + gcloud vmware private-clouds nsx credentials describe - retrieve VMware NSX + sign-in credentials associated with a Google Cloud VMware Engine + private cloud + +SYNOPSIS + gcloud vmware private-clouds nsx credentials describe + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve VMware NSX sign-in credentials associated with a VMware Engine + private cloud. + +EXAMPLES + To get sign-in credentials for NSX in private cloud my-private-cloud, run: + + $ gcloud vmware private-clouds nsx credentials describe \ + --private-cloud=my-private-cloud --location=us-west2-a \ + --project=my-project + + Or: + + $ gcloud vmware private-clouds nsx credentials describe \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/nsx/credentials/help b/gcloud/vmware/private-clouds/nsx/credentials/help new file mode 100644 index 000000000..6306d93c1 --- /dev/null +++ b/gcloud/vmware/private-clouds/nsx/credentials/help @@ -0,0 +1,25 @@ +NAME + gcloud vmware private-clouds nsx credentials - manage VMware NSX + credentials using Google Cloud VMware Engine + +SYNOPSIS + gcloud vmware private-clouds nsx credentials COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage VMware NSX credentials using Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Retrieve VMware NSX sign-in credentials associated with a Google Cloud + VMware Engine private cloud. + + reset + Reset VMware NSX sign-in credentials associated with a Google Cloud + VMware Engine private cloud. diff --git a/gcloud/vmware/private-clouds/nsx/credentials/reset b/gcloud/vmware/private-clouds/nsx/credentials/reset new file mode 100644 index 000000000..85a28b694 --- /dev/null +++ b/gcloud/vmware/private-clouds/nsx/credentials/reset @@ -0,0 +1,70 @@ +NAME + gcloud vmware private-clouds nsx credentials reset - reset VMware NSX + sign-in credentials associated with a Google Cloud VMware Engine + private cloud + +SYNOPSIS + gcloud vmware private-clouds nsx credentials reset + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Reset VMware NSX sign-in credentials associated with a VMware Engine + private cloud. + +EXAMPLES + To reset sign-in credentials for NSX in private cloud my-private-cloud, + run: + + $ gcloud vmware private-clouds nsx credentials reset \ + --private-cloud=my-private-cloud --location=us-west2-a \ + --project=my-project + + Or: + + $ gcloud vmware private-clouds nsx credentials reset \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/nsx/help b/gcloud/vmware/private-clouds/nsx/help new file mode 100644 index 000000000..d74a62a74 --- /dev/null +++ b/gcloud/vmware/private-clouds/nsx/help @@ -0,0 +1,20 @@ +NAME + gcloud vmware private-clouds nsx - manage NSX using Google Cloud VMware + Engine + +SYNOPSIS + gcloud vmware private-clouds nsx GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage NSX using Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + credentials + Manage VMware NSX credentials using Google Cloud VMware Engine. diff --git a/gcloud/vmware/private-clouds/subnets/help b/gcloud/vmware/private-clouds/subnets/help new file mode 100644 index 000000000..5fcdf17bc --- /dev/null +++ b/gcloud/vmware/private-clouds/subnets/help @@ -0,0 +1,20 @@ +NAME + gcloud vmware private-clouds subnets - manage vmware subnets in Google + Cloud VMware Engine + +SYNOPSIS + gcloud vmware private-clouds subnets COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage vmware subnets in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + List subnets in a VMware Engine private cloud. diff --git a/gcloud/vmware/private-clouds/subnets/list b/gcloud/vmware/private-clouds/subnets/list new file mode 100644 index 000000000..5f9ae4264 --- /dev/null +++ b/gcloud/vmware/private-clouds/subnets/list @@ -0,0 +1,86 @@ +NAME + gcloud vmware private-clouds subnets list - list subnets in a VMware Engine + private cloud + +SYNOPSIS + gcloud vmware private-clouds subnets list + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List subnets in a VMware Engine private cloud. + +EXAMPLES + To list subnets in the my-privatecloud private cloud, run: + + $ gcloud vmware private-clouds subnets list \ + --private-cloud=my-privatecloud --project=my-project \ + --location=us-east2-b + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/undelete b/gcloud/vmware/private-clouds/undelete new file mode 100644 index 000000000..32e4d839e --- /dev/null +++ b/gcloud/vmware/private-clouds/undelete @@ -0,0 +1,65 @@ +NAME + gcloud vmware private-clouds undelete - cancel deletion of a Google Cloud + VMware Engine private cloud + +SYNOPSIS + gcloud vmware private-clouds undelete (PRIVATE_CLOUD : --location=LOCATION) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Unmark a VMware Engine private cloud that was previously marked for + deletion by gcloud vmware private-clouds delete. + +EXAMPLES + To unmark a private cloud called my-private-cloud for deletion, run: + + $ gcloud vmware private-clouds undelete my-private-cloud \ + --location=us-west2-a --project=my-project + + Or: + + $ gcloud vmware private-clouds undelete my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Private cloud resource - private_cloud. 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 private_cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument private_cloud on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument private_cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/update b/gcloud/vmware/private-clouds/update new file mode 100644 index 000000000..e4b6020a9 --- /dev/null +++ b/gcloud/vmware/private-clouds/update @@ -0,0 +1,70 @@ +NAME + gcloud vmware private-clouds update - update a Google Cloud VMware Engine + private cloud + +SYNOPSIS + gcloud vmware private-clouds update (PRIVATE_CLOUD : --location=LOCATION) + [--async] [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a VMware Engine private cloud. + +EXAMPLES + To update a private cloud named my-private-cloud by changing its + description to Example description run: + + $ gcloud vmware private-clouds update my-private-cloud \ + --location=us-west2-a --project=my-project \ + --description='Example description' + + Or: + + $ gcloud vmware private-clouds update my-private-cloud \ + --description='Example description' + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +POSITIONAL ARGUMENTS + Private cloud resource - private_cloud. 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 private_cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument private_cloud on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument private_cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + + --description=DESCRIPTION + Text describing the private cloud + +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. diff --git a/gcloud/vmware/private-clouds/vcenter/credentials/describe b/gcloud/vmware/private-clouds/vcenter/credentials/describe new file mode 100644 index 000000000..e926f49df --- /dev/null +++ b/gcloud/vmware/private-clouds/vcenter/credentials/describe @@ -0,0 +1,63 @@ +NAME + gcloud vmware private-clouds vcenter credentials describe - describe Google + Cloud VMware Engine vCenter credentials + +SYNOPSIS + gcloud vmware private-clouds vcenter credentials describe + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve VMware vCenter sign-in credentials associated with a VMware Engine + private cloud. + +EXAMPLES + To get sign-in credentials for vCenter in private cloud my-private-cloud, + run: + + $ gcloud vmware private-clouds vcenter credentials describe \ + --private-cloud=my-private-cloud --location=us-west2-a \ + --project=my-project + + Or: + + $ gcloud vmware private-clouds vcenter credentials describe \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +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. diff --git a/gcloud/vmware/private-clouds/vcenter/credentials/help b/gcloud/vmware/private-clouds/vcenter/credentials/help new file mode 100644 index 000000000..dd5115f92 --- /dev/null +++ b/gcloud/vmware/private-clouds/vcenter/credentials/help @@ -0,0 +1,25 @@ +NAME + gcloud vmware private-clouds vcenter credentials - manage VMware vCenter + credentials using Google Cloud VMware Engine + +SYNOPSIS + gcloud vmware private-clouds vcenter credentials COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage VMware vCenter credentials using Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + Describe Google Cloud VMware Engine vCenter credentials. + + reset + Reset VMware vCenter sign-in credentials associated with a Google Cloud + VMware Engine private cloud. diff --git a/gcloud/vmware/private-clouds/vcenter/credentials/reset b/gcloud/vmware/private-clouds/vcenter/credentials/reset new file mode 100644 index 000000000..5948442cb --- /dev/null +++ b/gcloud/vmware/private-clouds/vcenter/credentials/reset @@ -0,0 +1,70 @@ +NAME + gcloud vmware private-clouds vcenter credentials reset - reset VMware + vCenter sign-in credentials associated with a Google Cloud VMware + Engine private cloud + +SYNOPSIS + gcloud vmware private-clouds vcenter credentials reset + (--private-cloud=PRIVATE_CLOUD : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Reset VMware vCenter sign-in credentials associated with a VMware Engine + private cloud. + +EXAMPLES + To reset sign-in credentials for vCenter in private cloud my-private-cloud, + run: + + $ gcloud vmware private-clouds vcenter credentials reset \ + --private-cloud=my-private-cloud --location=us-west2-a \ + --project=my-project + + Or: + + $ gcloud vmware private-clouds vcenter credentials reset \ + --private-cloud=my-private-cloud + + In the second example, the project and location are taken from gcloud + properties core/project and compute/zone. + +REQUIRED FLAGS + Private cloud resource - private_cloud. 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 --private-cloud on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + --private-cloud=PRIVATE_CLOUD + ID of the private cloud or fully qualified identifier for the private + cloud. To set the private-cloud attribute: + ▸ provide the argument --private-cloud on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Zone of the private cloud or cluster. To set the location attribute: + ▸ provide the argument --private-cloud on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property compute/zone. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. The default is True. Enabled by default, use --no-async to + disable. + +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. diff --git a/gcloud/vmware/private-clouds/vcenter/help b/gcloud/vmware/private-clouds/vcenter/help new file mode 100644 index 000000000..a17dd2646 --- /dev/null +++ b/gcloud/vmware/private-clouds/vcenter/help @@ -0,0 +1,20 @@ +NAME + gcloud vmware private-clouds vcenter - manage vCenter resources in Google + Cloud VMware Engine + +SYNOPSIS + gcloud vmware private-clouds vcenter GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage vCenter resources in Google Cloud VMware Engine. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + credentials + Manage VMware vCenter credentials using Google Cloud VMware Engine.