diff --git a/gcloud/_version b/gcloud/_version index 6e164c143..c7975de6d 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 406.0.0 -alpha 2022.10.17 -beta 2022.10.17 +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.17 +core 2022.10.21 gcloud-crc32c 1.0.0 -gsutil 5.14 +gsutil 5.15 diff --git a/gcloud/alpha/ai/endpoints/deploy-model b/gcloud/alpha/ai/endpoints/deploy-model index 719b4e4b0..52bc91764 100644 --- a/gcloud/alpha/ai/endpoints/deploy-model +++ b/gcloud/alpha/ai/endpoints/deploy-model @@ -67,9 +67,9 @@ OPTIONAL FLAGS selected. type - The type of the accelerator. Choices are 'nvidia-tesla-a100', - 'nvidia-tesla-k80', 'nvidia-tesla-p100', 'nvidia-tesla-p4', - 'nvidia-tesla-t4', 'nvidia-tesla-v100'. + The type of the accelerator. Choices are 'nvidia-a100-80gb', + 'nvidia-tesla-a100', 'nvidia-tesla-k80', 'nvidia-tesla-p100', + 'nvidia-tesla-p4', 'nvidia-tesla-t4', 'nvidia-tesla-v100'. count The number of accelerators to attach to each machine running the diff --git a/gcloud/alpha/alloydb/instances/create-secondary b/gcloud/alpha/alloydb/instances/create-secondary deleted file mode 100644 index 9448cca2e..000000000 --- a/gcloud/alpha/alloydb/instances/create-secondary +++ /dev/null @@ -1,50 +0,0 @@ -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/help b/gcloud/alpha/alloydb/instances/help index d666d05c2..def1ada99 100644 --- a/gcloud/alpha/alloydb/instances/help +++ b/gcloud/alpha/alloydb/instances/help @@ -20,10 +20,6 @@ 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. diff --git a/gcloud/alpha/assured/workloads/create b/gcloud/alpha/assured/workloads/create index 8b45704a2..79032785a 100644 --- a/gcloud/alpha/assured/workloads/create +++ b/gcloud/alpha/assured/workloads/create @@ -8,7 +8,7 @@ SYNOPSIS --location=LOCATION --organization=ORGANIZATION [--enable-sovereign-controls=ENABLE_SOVEREIGN_CONTROLS] [--external-identifier=EXTERNAL_IDENTIFIER] [--labels=[KEY=VALUE,...]] - [--next-rotation-time=NEXT_ROTATION_TIME] + [--next-rotation-time=NEXT_ROTATION_TIME] [--partner=PARTNER] [--provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT] [--resource-settings=[KEY=VALUE,...]] [--rotation-period=ROTATION_PERIOD] [GCLOUD_WIDE_FLAG ...] @@ -51,7 +51,7 @@ REQUIRED FLAGS The compliance regime of the new Assured Workloads environment. COMPLIANCE_REGIME must be one of: CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, IL4, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, - CA_REGIONS_AND_SUPPORT, ITAR. + CA_REGIONS_AND_SUPPORT, ITAR, ASSURED_WORKLOADS_FOR_PARTNERS. --display-name=DISPLAY_NAME The display name of the new Assured Workloads environment @@ -81,6 +81,11 @@ OPTIONAL FLAGS The next rotation time of the KMS settings of new Assured Workloads environment, for example, 2020-12-30T10:15:30.00Z + --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. + --provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT The parent of the provisioned projects, for example, folders/{FOLDER_ID} diff --git a/gcloud/alpha/bigtable/backups/copy b/gcloud/alpha/bigtable/backups/copy index 17f96e9d7..a89f767e5 100644 --- a/gcloud/alpha/bigtable/backups/copy +++ b/gcloud/alpha/bigtable/backups/copy @@ -4,80 +4,86 @@ NAME SYNOPSIS gcloud alpha bigtable backups copy - (--destination=DESTINATION : --destination-cluster=DESTINATION_CLUSTER - --destination-instance=DESTINATION_INSTANCE) + (--destination-backup=DESTINATION_BACKUP + : --destination-cluster=DESTINATION_CLUSTER + --destination-instance=DESTINATION_INSTANCE + --destination-project=DESTINATION_PROJECT) (--expiration-date=EXPIRATION_DATE | --retention-period=RETENTION_PERIOD) - (--source=SOURCE - : --source-cluster=SOURCE_CLUSTER --source-instance=SOURCE_INSTANCE) + (--source-backup=SOURCE_BACKUP : --source-cluster=SOURCE_CLUSTER + --source-instance=SOURCE_INSTANCE --source-project=SOURCE_PROJECT) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command copies a Cloud Bigtable backup to a new backup. EXAMPLES - To copy backup SOURCE_BACKUP to DESTINATION_BACKUP, run: + To copy a backup within the same project, run: $ gcloud alpha bigtable backups copy \ --source-instance=SOURCE_INSTANCE \ - --source-cluster=SOURCE_CLUSTER --source=SOURCE_BACKUP \ + --source-cluster=SOURCE_CLUSTER --source-backup=SOURCE_BACKUP \ --destination-instance=DESTINATION_INSTANCE \ --destination-cluster=DESTINATION_CLUSTER \ - --destination=DESTINATION_BACKUP \ + --destination-backup=DESTINATION_BACKUP \ --expiration-date=2022-08-01T10:49:41Z - To copy backup SOURCE_BACKUP to DESTINATION_BACKUP using relative names, - run: + To copy a backup to a different project, run: $ gcloud alpha bigtable backups copy \ - --source=projects/SOURCE_PROJECT/instances/SOURCE_INSTANCE/\ - clusters/SOURCE_CLUSTER/backups/SOURCE_BACKUP \ - --destination=projects/DESTINATION_PROJECT/instances/\ + --source-backup=projects/SOURCE_PROJECT/instances/\ + SOURCE_INSTANCE/clusters/SOURCE_CLUSTER/backups/SOURCE_BACKUP \ + --destination-backup=projects/DESTINATION_PROJECT/instances/\ DESTINATION_INSTANCE/clusters/DESTINATION_CLUSTER/backups/\ DESTINATION_BACKUP --expiration-date=2022-08-01T10:49:41Z To set retention period and run asyncronously, run: $ gcloud alpha bigtable backups copy \ - --source=projects/SOURCE_PROJECT/instances/SOURCE_INSTANCE/\ - clusters/SOURCE_CLUSTER/backups/SOURCE_BACKUP \ - --destination=projects/DESTINATION_PROJECT/instances/\ + --source-backup=projects/SOURCE_PROJECT/instances/\ + SOURCE_INSTANCE/clusters/SOURCE_CLUSTER/backups/SOURCE_BACKUP \ + --destination-backup=projects/DESTINATION_PROJECT/instances/\ DESTINATION_INSTANCE/clusters/DESTINATION_CLUSTER/backups/\ DESTINATION_BACKUP --retention-period=2w --async REQUIRED FLAGS - Backup resource - The destination to copy 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 --destination on the command line with a fully - specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. + Backup resource - The destination backup to copy to. The arguments in this + group can be used to specify the attributes of this resource. This must be specified. - --destination=DESTINATION + --destination-backup=DESTINATION_BACKUP ID of the backup or fully qualified identifier for the backup. To set - the source attribute: - ▸ provide the argument --destination on the command line. + the backup attribute: + ▸ provide the argument --destination-backup on the command line. This flag argument must be specified if any of the other arguments in this group are specified. --destination-cluster=DESTINATION_CLUSTER - Name of the Cloud Bigtable cluster. To set the cluster attribute: - ▸ provide the argument --destination on the command line with a - fully specified name; + Cloud Bigtable cluster for the backup. To set the cluster attribute: + ▸ provide the argument --destination-backup on the command line + with a fully specified name; ▸ provide the argument --destination-cluster on the command line. --destination-instance=DESTINATION_INSTANCE - Name of the Cloud Bigtable instance. To set the instance attribute: - ▸ provide the argument --destination on the command line with a - fully specified name; + Cloud Bigtable instance for the backup. To set the instance + attribute: + ▸ provide the argument --destination-backup on the command line + with a fully specified name; ▸ provide the argument --destination-instance on the command line; ▸ provide the argument --source-instance on the command line. + --destination-project=DESTINATION_PROJECT + Project ID of the Google Cloud project for the backup. To set the + project attribute: + ▸ provide the argument --destination-backup on the command line + with a fully specified name; + ▸ provide the argument --destination-project on the command line; + ▸ provide the argument --source-project on the command line; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + Exactly one of these must be specified: --expiration-date=EXPIRATION_DATE @@ -90,38 +96,43 @@ REQUIRED FLAGS hours and at most 30 days. See $ gcloud topic datetimes for information on duration formats. - Backup resource - The source to copy 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 --source on the command line with a fully - specified name; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. + Backup resource - The source backup to copy from. The arguments in this + group can be used to specify the attributes of this resource. This must be specified. - --source=SOURCE + --source-backup=SOURCE_BACKUP ID of the backup or fully qualified identifier for the backup. To set - the source attribute: - ▸ provide the argument --source on the command line. + the backup attribute: + ▸ provide the argument --source-backup on the command line. This flag argument must be specified if any of the other arguments in this group are specified. --source-cluster=SOURCE_CLUSTER - Name of the Cloud Bigtable cluster. To set the cluster attribute: - ▸ provide the argument --source on the command line with a fully - specified name; + Cloud Bigtable cluster for the backup. To set the cluster attribute: + ▸ provide the argument --source-backup on the command line with a + fully specified name; ▸ provide the argument --source-cluster on the command line. --source-instance=SOURCE_INSTANCE - Name of the Cloud Bigtable instance. To set the instance attribute: - ▸ provide the argument --source on the command line with a fully - specified name; + Cloud Bigtable instance for the backup. To set the instance + attribute: + ▸ provide the argument --source-backup on the command line with a + fully specified name; ▸ provide the argument --source-instance on the command line; ▸ provide the argument --destination-instance on the command line. + --source-project=SOURCE_PROJECT + Project ID of the Google Cloud project for the backup. To set the + project attribute: + ▸ provide the argument --source-backup on the command line with a + fully specified name; + ▸ provide the argument --source-project on the command line; + ▸ provide the argument --destination-project on the command line; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/alpha/bigtable/instances/tables/restore b/gcloud/alpha/bigtable/instances/tables/restore index 8498617fd..fed90e1fa 100644 --- a/gcloud/alpha/bigtable/instances/tables/restore +++ b/gcloud/alpha/bigtable/instances/tables/restore @@ -11,8 +11,7 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) This command restores a Cloud Bigtable backup to a new table in the - same instance. + (ALPHA) This command restores a Cloud Bigtable backup to a new table. EXAMPLES To restore table 'table2' from backup 'backup1', run: diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/create b/gcloud/alpha/builds/enterprise-config/bitbucketserver/create index f7bd7059e..3c82e577a 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/create +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/create @@ -9,8 +9,8 @@ SYNOPSIS --read-access-token-secret-version=READ_ACCESS_TOKEN_SECRET_VERSION --user-name=USER_NAME --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION - [--peered-network=PEERED_NETWORK] [--ssl-ca-file=SSL_CA_FILE] - [GCLOUD_WIDE_FLAG ...] + [--peered-network=PEERED_NETWORK] [--region=REGION] + [--ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a Bitbucket Server config for use by Google Cloud Build. @@ -51,6 +51,11 @@ OPTIONAL FLAGS If not specified, calls will be made over the public internet. + --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". + --ssl-ca-file=SSL_CA_FILE Path to a local file that contains SSL certificate to use for requests to Bitbucket Server. The certificate should be in PEM format. diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete b/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete index 4623899d7..dff0a8d73 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/delete @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha builds enterprise-config bitbucketserver delete CONFIG - [GCLOUD_WIDE_FLAG ...] + [--region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Delete a Bitbucket Server config from Google Cloud Build. @@ -13,6 +13,12 @@ POSITIONAL ARGUMENTS CONFIG The id of the Bitbucket Server Config +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". + 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/builds/enterprise-config/bitbucketserver/describe b/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe index ab52b3f83..12b6086de 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/describe @@ -4,7 +4,7 @@ NAME SYNOPSIS gcloud alpha builds enterprise-config bitbucketserver describe CONFIG - [GCLOUD_WIDE_FLAG ...] + [--region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Describe a Bitbucket Server config in a Google Cloud project. @@ -13,6 +13,12 @@ POSITIONAL ARGUMENTS CONFIG The id of the Bitbucket Server Config +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". + 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/builds/enterprise-config/bitbucketserver/list b/gcloud/alpha/builds/enterprise-config/bitbucketserver/list index 9c7233f52..95b7033c5 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/list +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/list @@ -4,12 +4,19 @@ NAME SYNOPSIS gcloud alpha builds enterprise-config bitbucketserver list - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] - [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + [--region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) List all Bitbucket Server configs in a Google Cloud project. +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". + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/builds/enterprise-config/bitbucketserver/update b/gcloud/alpha/builds/enterprise-config/bitbucketserver/update index 219772240..02c74fc2f 100644 --- a/gcloud/alpha/builds/enterprise-config/bitbucketserver/update +++ b/gcloud/alpha/builds/enterprise-config/bitbucketserver/update @@ -7,7 +7,7 @@ SYNOPSIS [--admin-access-token-secret-version=ADMIN_ACCESS_TOKEN_SECRET_VERSION] [--api-key=API_KEY] [--host-uri=HOST_URI] [--read-access-token-secret-version=READ_ACCESS_TOKEN_SECRET_VERSION] - [--ssl-ca-file=SSL_CA_FILE] [--user-name=USER_NAME] + [--region=REGION] [--ssl-ca-file=SSL_CA_FILE] [--user-name=USER_NAME] [--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION] [GCLOUD_WIDE_FLAG ...] @@ -35,6 +35,11 @@ FLAGS specified in resource URL format projects/{secret_project}/secrets/{secret_name}/versions/{secret_version}. + --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". + --ssl-ca-file=SSL_CA_FILE Path to a local file that contains SSL certificate to use for requests to Bitbucket Server. The certificate should be in PEM format. diff --git a/gcloud/alpha/compute/help b/gcloud/alpha/compute/help index 476e7943e..05e082336 100644 --- a/gcloud/alpha/compute/help +++ b/gcloud/alpha/compute/help @@ -99,6 +99,9 @@ GROUPS machine-types (ALPHA) Read Compute Engine virtual machine types. + network-attachments + (ALPHA) Manage Compute Engine network attachment resources. + network-edge-security-services (ALPHA) Read and manipulate network edge security services. diff --git a/gcloud/alpha/compute/instances/resume b/gcloud/alpha/compute/instances/resume index 0e01c7fd4..bc5929c47 100644 --- a/gcloud/alpha/compute/instances/resume +++ b/gcloud/alpha/compute/instances/resume @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud alpha compute instances resume INSTANCE_NAMES [INSTANCE_NAMES ...] - [--async] [--csek-key-file=FILE] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--async] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute instances resume is used to resume a @@ -25,15 +25,6 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --csek-key-file=FILE - Path to a Customer-Supplied Encryption Key (CSEK) key file that maps - Compute Engine resources to user managed keys to be used when creating, - mounting, or taking snapshots of disks. - - If you pass - as value of the flag, the CSEK is read from stdin. See - https://cloud.google.com/compute/docs/disks/customer-supplied-encryption - for more details. - --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/interconnects/attachments/dedicated/create b/gcloud/alpha/compute/interconnects/attachments/dedicated/create index e332dd521..1e120c4d5 100644 --- a/gcloud/alpha/compute/interconnects/attachments/dedicated/create +++ b/gcloud/alpha/compute/interconnects/attachments/dedicated/create @@ -10,8 +10,8 @@ SYNOPSIS [--cloud-router-ipv6-interface-id=INTERFACE_ID] [--customer-router-ipv6-interface-id=PEER_INTERFACE_ID] [--description=DESCRIPTION] [--dry-run] [--enable-admin] [--mtu=MTU] - [--region=REGION] [--stack-type=STACK_TYPE] [--vlan=VLAN] - [GCLOUD_WIDE_FLAG ...] + [--region=REGION] [--stack-type=STACK_TYPE] + [--subnet-length=SUBNET_LENGTH] [--vlan=VLAN] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute interconnects attachments dedicated create is @@ -73,11 +73,12 @@ OPTIONAL FLAGS Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space. - Google will attempt to select an unused /29 from the supplied candidate - subnet(s), or all of link-local space if no subnets supplied. Google - will not re-use a /29 already in-use by your project, even if it's - contained in one of the candidate subnets. The request will fail if all - /29s within the candidate subnets are in use at Google's edge. + Google will attempt to select an unused subnet of SUBNET_LENGTH from + the supplied candidate subnet(s), or all of link-local space if no + subnets supplied. Google will not re-use a subnet already in-use by + your project, even if it's contained in one of the candidate subnets. + The request will fail if all candidate subnets are in use at Google's + edge. --cloud-router-ipv6-interface-id=INTERFACE_ID If supplied, the interface id (index within the subnet) to be used for @@ -137,6 +138,21 @@ OPTIONAL FLAGS IPV4_ONLY Only IPv4 protocol is enabled on this attachment. + --subnet-length=SUBNET_LENGTH + The length of the IPv4 subnet mask for this attachment. 29 is the + default value, except for attachments on Cross-Cloud Interconnects + whose remote location's "constraints.subnetLengthRange" field specifies + a minimum subnet length of 30. In that case, the default value is 30. + The default value is recommended when there's no requirement on the + subnet length. SUBNET_LENGTH must be one of: + + 29: + subnet length 29. + 30: + subnet length 30. + + SUBNET_LENGTH must be one of: 29, 30. + --vlan=VLAN Desired VLAN for this attachment, in the range 2-4094. If not supplied, Google will automatically select a VLAN. diff --git a/gcloud/alpha/compute/interconnects/create b/gcloud/alpha/compute/interconnects/create index a322a751b..0a9bfdee1 100644 --- a/gcloud/alpha/compute/interconnects/create +++ b/gcloud/alpha/compute/interconnects/create @@ -4,11 +4,11 @@ NAME SYNOPSIS gcloud alpha compute interconnects create NAME - --customer-name=CUSTOMER_NAME --interconnect-type=INTERCONNECT_TYPE - --link-type=LINK_TYPE --location=LOCATION - --requested-link-count=REQUESTED_LINK_COUNT [--admin-enabled] + --interconnect-type=INTERCONNECT_TYPE --link-type=LINK_TYPE + --location=LOCATION --requested-link-count=REQUESTED_LINK_COUNT + [--admin-enabled] [--customer-name=CUSTOMER_NAME] [--description=DESCRIPTION] [--noc-contact-email=NOC_CONTACT_EMAIL] - [GCLOUD_WIDE_FLAG ...] + [--remote-location=REMOTE_LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) gcloud alpha compute interconnects create is used to create @@ -28,15 +28,21 @@ EXAMPLES --noc-contact-email=noc@example.com \ --description="Example interconnect" + To create a Cross-Cloud Interconnect, run: + + $ gcloud alpha compute interconnects create \ + example-cc-interconnect --interconnect-type=DEDICATED \ + --link-type=LINK_TYPE_ETHERNET_100G_LR \ + --location=example-zone1-1 --requested-link-count=1 \ + --remote-location=example-remote-location \ + --noc-contact-email=noc@example.com \ + --description="Example Cross-Cloud Interconnect" + POSITIONAL ARGUMENTS NAME Name of the interconnect to create. REQUIRED FLAGS - --customer-name=CUSTOMER_NAME - Customer name to put in the Letter of Authorization as the party - authorized to request an interconnect. - --interconnect-type=INTERCONNECT_TYPE Type of the interconnect. INTERCONNECT_TYPE must be one of: @@ -71,6 +77,12 @@ OPTIONAL FLAGS operational and will carry traffic across any functioning linked interconnect attachments. Use --no-admin-enabled to disable it. + --customer-name=CUSTOMER_NAME + Customer name to put in the Letter of Authorization as the party + authorized to request an interconnect. This field is required for most + Interconnects, however it is prohibited when creating a Cross-Cloud + Interconnect. + --description=DESCRIPTION An optional, textual description for the interconnect. @@ -78,6 +90,12 @@ OPTIONAL FLAGS Email address to contact the customer NOC for operations and maintenance notifications regarding this interconnect. + --remote-location=REMOTE_LOCATION + The remote location for a Cross-Cloud Interconnect. The remote + locations can be listed by using the gcloud alpha compute interconnects + remote-locations list command to find the appropriate remote location + to use when creating a Cross-Cloud Interconnect. + 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/interconnects/help b/gcloud/alpha/compute/interconnects/help index f648b8da4..6b4bf5de2 100644 --- a/gcloud/alpha/compute/interconnects/help +++ b/gcloud/alpha/compute/interconnects/help @@ -33,6 +33,10 @@ GROUPS (ALPHA) Read and manipulate Compute Engine interconnect MACsec configuration. + remote-locations + (ALPHA) Read and manipulate Compute Engine interconnect remote + locations. + COMMANDS COMMAND is one of the following: diff --git a/gcloud/alpha/compute/interconnects/remote-locations/describe b/gcloud/alpha/compute/interconnects/remote-locations/describe new file mode 100644 index 000000000..417f1cbd4 --- /dev/null +++ b/gcloud/alpha/compute/interconnects/remote-locations/describe @@ -0,0 +1,35 @@ +NAME + gcloud alpha compute interconnects remote-locations describe - describe a + Compute Engine interconnect remote location + +SYNOPSIS + gcloud alpha compute interconnects remote-locations describe NAME + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Displays all data associated with Compute Engine interconnect + remote location in a project. + + Example of usage: + + $ gcloud alpha compute interconnects remote-locations describe \ + my-remote-location + +POSITIONAL ARGUMENTS + NAME + Name of the interconnect remote location to describe. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/interconnects/remote-locations/help b/gcloud/alpha/compute/interconnects/remote-locations/help new file mode 100644 index 000000000..bb7f9340f --- /dev/null +++ b/gcloud/alpha/compute/interconnects/remote-locations/help @@ -0,0 +1,31 @@ +NAME + gcloud alpha compute interconnects remote-locations - read and manipulate + Compute Engine interconnect remote locations + +SYNOPSIS + gcloud alpha compute interconnects remote-locations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Read and manipulate Cloud Interconnect remote locations. + +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 Compute Engine interconnect remote location. + + list + (ALPHA) List Google Compute Engine interconnect remote 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/compute/interconnects/remote-locations/list b/gcloud/alpha/compute/interconnects/remote-locations/list new file mode 100644 index 000000000..adf7a2604 --- /dev/null +++ b/gcloud/alpha/compute/interconnects/remote-locations/list @@ -0,0 +1,68 @@ +NAME + gcloud alpha compute interconnects remote-locations list - list Google + Compute Engine interconnect remote locations + +SYNOPSIS + gcloud alpha compute interconnects remote-locations list + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha compute interconnects remote-locations list displays + all Google Compute Engine interconnect remote locations in a project. + +EXAMPLES + To list all interconnect remote locations in a project in table form, run: + + $ gcloud alpha compute interconnects remote-locations list + + To list the URIs of all interconnect remote locations in a project, run: + + $ gcloud alpha compute interconnects remote-locations list --uri + +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/compute/network-attachments/create b/gcloud/alpha/compute/network-attachments/create new file mode 100644 index 000000000..0742a0451 --- /dev/null +++ b/gcloud/alpha/compute/network-attachments/create @@ -0,0 +1,81 @@ +NAME + gcloud alpha compute network-attachments create - create a Google Compute + Engine network attachment + +SYNOPSIS + gcloud alpha compute network-attachments create NAME + --subnets=SUBNETS,[SUBNETS,...] + [--connection-preference=CONNECTION_PREFERENCE; + default="ACCEPT_AUTOMATIC"] [--description=DESCRIPTION] + [--producer-accept-list=[ACCEPT_LIST,...]] + [--producer-reject-list=[REJECT_LIST,...]] [--region=REGION] + [--subnets-region=SUBNETS_REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Google Compute Engine network attachment. + +POSITIONAL ARGUMENTS + NAME + Name of the network attachment to create. + +REQUIRED FLAGS + --subnets=SUBNETS,[SUBNETS,...] + The subnetworks provided by the consumer for the producers + +OPTIONAL FLAGS + --connection-preference=CONNECTION_PREFERENCE; default="ACCEPT_AUTOMATIC" + The connection preference of network attachment. The value can be set + to ACCEPT_AUTOMATIC or ACCEPT_MANUAL. An ACCEPT_AUTOMATIC network + attachment is one that always accepts the connection from producer NIC. + An ACCEPT_MANUAL network attachment is one that requires an explicit + addition of the producer project id or project number to the producer + accept list. CONNECTION_PREFERENCE must be one of: ACCEPT_AUTOMATIC, + ACCEPT_MANUAL. + + --description=DESCRIPTION + An optional, textual description for the network attachment. + + --producer-accept-list=[ACCEPT_LIST,...] + Projects that are allowed to connect to this network attachment. + + --producer-reject-list=[REJECT_LIST,...] + Projects that are not allowed to connect to this network attachment. + + --region=REGION + Region of the network attachment to create. 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. + + --subnets-region=SUBNETS_REGION + Region of the subnetworks 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, + --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/network-attachments/delete b/gcloud/alpha/compute/network-attachments/delete new file mode 100644 index 000000000..20256b692 --- /dev/null +++ b/gcloud/alpha/compute/network-attachments/delete @@ -0,0 +1,50 @@ +NAME + gcloud alpha compute network-attachments delete - delete one or more Google + Compute Engine network attachments + +SYNOPSIS + gcloud alpha compute network-attachments delete NAME [NAME ...] + [--region=REGION] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete one or more Google Compute Engine network attachments. + +POSITIONAL ARGUMENTS + NAME [NAME ...] + Names of the network attachments to delete. + +FLAGS + --region=REGION + Region of the network attachments to delete. 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/network-attachments/describe b/gcloud/alpha/compute/network-attachments/describe new file mode 100644 index 000000000..5c68eb3c6 --- /dev/null +++ b/gcloud/alpha/compute/network-attachments/describe @@ -0,0 +1,50 @@ +NAME + gcloud alpha compute network-attachments describe - describes a Google + Compute Engine network attachment + +SYNOPSIS + gcloud alpha compute network-attachments describe NAME [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Describes a Google Compute Engine network attachment. + +POSITIONAL ARGUMENTS + NAME + Name of the network attachment to describe. + +FLAGS + --region=REGION + Region of the network attachment to describe. 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/network-attachments/help b/gcloud/alpha/compute/network-attachments/help new file mode 100644 index 000000000..3a3d67fc9 --- /dev/null +++ b/gcloud/alpha/compute/network-attachments/help @@ -0,0 +1,36 @@ +NAME + gcloud alpha compute network-attachments - manage Compute Engine network + attachment resources + +SYNOPSIS + gcloud alpha compute network-attachments COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List, create, describe, update and delete network attachments. + +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 Google Compute Engine network attachment. + + delete + (ALPHA) Delete one or more Google Compute Engine network attachments. + + describe + (ALPHA) Describes a Google Compute Engine network attachment. + + list + (ALPHA) List Google Compute Engine network attachments. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/network-attachments/list b/gcloud/alpha/compute/network-attachments/list new file mode 100644 index 000000000..b5de07b54 --- /dev/null +++ b/gcloud/alpha/compute/network-attachments/list @@ -0,0 +1,78 @@ +NAME + gcloud alpha compute network-attachments list - list Google Compute Engine + network attachments + +SYNOPSIS + gcloud alpha compute network-attachments list [NAME ...] + [--regexp=REGEXP, -r REGEXP] [--regions=REGION,[REGION,...]] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Google Compute Engine network attachments. + +POSITIONAL ARGUMENTS + [NAME ...] + (DEPRECATED) If provided, show details for the specified names and/or + URIs of resources. + + Argument NAME is deprecated. Use --filter="name=( 'NAME' ... )" + instead. + +FLAGS + --regexp=REGEXP, -r REGEXP + (DEPRECATED) Regular expression to filter the names of the results on. + Any names that do not match the entire regular expression will be + filtered out. + + Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. + + --regions=REGION,[REGION,...] + If provided, only resources from the given regions are queried. + +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/clusters/create b/gcloud/alpha/container/clusters/create index 933cc8802..af48f7496 100644 --- a/gcloud/alpha/container/clusters/create +++ b/gcloud/alpha/container/clusters/create @@ -33,7 +33,7 @@ SYNOPSIS [--enable-master-global-access] [--enable-network-policy] [--enable-pod-security-policy] [--enable-service-externalips] [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] - [--enable-vertical-pod-autoscaling] + [--enable-vertical-pod-autoscaling] [--gateway-api=GATEWAY_API] [--identity-provider=IDENTITY_PROVIDER] [--image-type=IMAGE_TYPE] [--ipv6-access-type=IPV6_ACCESS_TYPE] [--issue-client-certificate] [--istio-config=[auth=MTLS_PERMISSIVE,...]] [--labels=[KEY=VALUE,...]] @@ -538,6 +538,19 @@ FLAGS --enable-vertical-pod-autoscaling Enable vertical pod autoscaling for a cluster. + --gateway-api=GATEWAY_API + Enables GKE Gateway controller in this cluster. The value of the flag + specifies which Open Source Gateway API release channel will be used to + define Gateway resources. GATEWAY_API must be one of: + + disabled + Gateway controller will be disabled in the cluster. + + standard + Gateway controller will be enabled in the cluster. Resource + definitions from the standard OSS Gateway API release channel will + be installed. + --identity-provider=IDENTITY_PROVIDER Enable 3P identity provider on the cluster. diff --git a/gcloud/alpha/container/clusters/update b/gcloud/alpha/container/clusters/update index c0257c69c..5024d0565 100644 --- a/gcloud/alpha/container/clusters/update +++ b/gcloud/alpha/container/clusters/update @@ -19,7 +19,8 @@ SYNOPSIS | --enable-network-policy | --enable-pod-security-policy | --enable-service-externalips | --enable-shielded-nodes | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling - | --generate-password | --identity-provider=IDENTITY_PROVIDER + | --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,...] @@ -312,6 +313,19 @@ REQUIRED FLAGS --enable-vertical-pod-autoscaling Enable vertical pod autoscaling for a cluster. + --gateway-api=GATEWAY_API + Enables GKE Gateway controller in this cluster. The value of the flag + specifies which Open Source Gateway API release channel will be used + to define Gateway resources. GATEWAY_API must be one of: + + disabled + Gateway controller will be disabled in the cluster. + + standard + Gateway controller will be enabled in the cluster. Resource + definitions from the standard OSS Gateway API release channel + will be installed. + --generate-password Ask the server to generate a secure password and use that as the basic auth password, keeping the existing username. diff --git a/gcloud/alpha/container/fleet/memberships/register b/gcloud/alpha/container/fleet/memberships/register index a1e8857a2..6a496a314 100644 --- a/gcloud/alpha/container/fleet/memberships/register +++ b/gcloud/alpha/container/fleet/memberships/register @@ -7,11 +7,11 @@ SYNOPSIS (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - (--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE - | [--enable-workload-identity : --has-private-issuer - | --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip] + [--install-connect-agent] [--internal-ip] [--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY] - [GCLOUD_WIDE_FLAG ...] + [--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE + | [--enable-workload-identity : --has-private-issuer + | --public-issuer-url=PUBLIC_ISSUER_URL]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command registers a cluster with the fleet by: @@ -19,103 +19,99 @@ DESCRIPTION 1. Creating a Fleet Membership resource corresponding to the cluster. 2. Adding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet. - 3. Installing the Connect Agent into this cluster. + 3. Installing the Connect agent into this cluster (optional for GKE). A successful registration implies that the cluster is now exclusive to a - single fleet. + single Fleet. If the cluster is already registered to another Fleet, the + registration will not be successful. - For more information about Connect Agent, go to: + To register a GKE cluster, use --gke-cluster or --gke-uri flag (no + --kubeconfig flag is required). Connect agent will not be installed by + default for GKE clusters. To install it, specify --install-connect-agent. + + To register a non-GKE or GKE On-Prem cluster, use --context flag (with an + optional --kubeconfig flag). Connect agent will always be installed for + non-GKE clusters. + + If Connect agent is to be installed, its authentication needs to be + configured by --enable-workload-identity or --service-account-key-file. For + the latter case, the corresponding service account must have been granted + gkehub.connect permissions. For more information about Connect agent, go + to: https://cloud.google.com/anthos/multicluster-management/connect/overview/ - To register a non-GKE or GKE On-Prem cluster use --context flag (with an - optional --kubeconfig flag). - - To register a GKE cluster use --gke-cluster or --gke-uri flag (no - --kubeconfig flag is required). - - In all cases, the Connect Agent that is installed in the target cluster - must authenticate to Google using a --service-account-key-file that - corresponds to a service account that has been granted gkehub.connect - permissions. - - If the cluster is already registered to another fleet, the registration is - not successful. - Rerunning this command against the same cluster with the same - MEMBERSHIP_NAME and target fleet is successful and upgrades the Connect - Agent if a new agent is available. + MEMBERSHIP_NAME and target fleet is successful, and will upgrade the + Connect agent if it is supposed to be installed and a newer version is + avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect Agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json + + Register a GKE cluster referenced from a GKE URI: + + $ gcloud alpha container fleet memberships register my-cluster \ + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect - Agent: + agent using service account key file: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE Cluster location and name, and - install the Connect Agent: + Register a GKE cluster first, and install the Connect agent later. $ gcloud alpha container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --service-account-key-file=/tmp/keyfile.json - - Register a GKE cluster, and install a specific version of the Connect - Agent: + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud alpha container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity + + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install - the Connect Agent: + Register a GKE cluster and output a manifest that can be used to install the + Connect agent: $ gcloud alpha container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json - - $ gcloud alpha container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS Membership resource - The group of arguments defining a membership. The @@ -181,7 +177,27 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. - Exactly one of these must be specified: +OPTIONAL FLAGS + --install-connect-agent + If set to True for a GKE cluster, Connect agent will be installed in + the cluster. No-op for Non-GKE clusters, where Connect agent will + always be installed. + + --internal-ip + Whether to use the internal IP address of the cluster endpoint. + + --manifest-output-file=MANIFEST_OUTPUT_FILE + The full path of the file into which the Connect agent installation + manifest should be stored. If this option is provided, then the + manifest will be written to this file and will not be deployed into the + cluster by gcloud, and it will need to be deployed manually. + + --proxy=PROXY + The proxy address in the format of http[s]://{hostname}. The proxy must + support the HTTP CONNECT method in order for this connection to + succeed. + + At most one of these can be specified: --service-account-key-file=SERVICE_ACCOUNT_KEY_FILE The JSON file of a Google Cloud service account private key. This @@ -238,21 +254,6 @@ REQUIRED FLAGS account JWTs are served at a public endpoint different from the cluster API server. Requires --enable-workload-identity. -OPTIONAL FLAGS - --internal-ip - Whether to use the internal IP address of the cluster endpoint. - - --manifest-output-file=MANIFEST_OUTPUT_FILE - The full path of the file into which the Connect Agent installation - manifest should be stored. If this option is provided, then the - manifest will be written to this file and will not be deployed into the - cluster by gcloud, and it will need to be deployed manually. - - --proxy=PROXY - The proxy address in the format of http[s]://{hostname}. The proxy must - support the HTTP CONNECT method in order for this connection to - succeed. - 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/memberships/unregister b/gcloud/alpha/container/fleet/memberships/unregister index 76583e79b..0484381f3 100644 --- a/gcloud/alpha/container/fleet/memberships/unregister +++ b/gcloud/alpha/container/fleet/memberships/unregister @@ -7,7 +7,7 @@ SYNOPSIS (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - [GCLOUD_WIDE_FLAG ...] + [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command unregisters a cluster with the fleet by: @@ -17,19 +17,19 @@ DESCRIPTION 2. Removing the corresponding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet (a.k.a `kubectl delete memberships membership`). - 3. Uninstalling the Connect Agent from this cluster (a.k.a - `kubectl delete on the gke-connect namespace`). + 3. [Optional for GKE cluster] Uninstalling the Connect agent from this + cluster (a.k.a `kubectl delete on the gke-connect namespace`). The unregister command makes additional internal checks to ensure that all three steps can be safely done to properly clean-up in-Fleet and in-cluster resources. - To register a non-GKE cluster use --context flag (with an optional - --kubeconfig flag). - To register a GKE cluster use --gke-cluster or --gke-uri flag (no --kubeconfig flag is required). + To register a non-GKE cluster use --context flag (with an optional + --kubeconfig`s flag). + To only delete the Fleet Membership resource, consider using the command: gcloud alpha container fleet memberships delete. This command is intended to delete stale Fleet Membership resources as doing so on a fully @@ -58,6 +58,13 @@ EXAMPLES $ gcloud alpha container fleet memberships unregister \ my-membership --gke-cluster=my-cluster-region-or-zone/my-cluster + Unregister a GKE cluster and uninstall Connect agent: + + $ gcloud alpha container fleet memberships unregister \ + my-membership \ + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --uninstall-connect-agent + POSITIONAL ARGUMENTS Membership resource - The group of arguments defining a membership. The arguments in this group can be used to specify the attributes of this @@ -121,6 +128,12 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. +OPTIONAL FLAGS + --uninstall-connect-agent + If set to True for a GKE cluster, Connect agent will be uninstalled + from the cluster. No-op for Non-GKE clusters, where Connect agent will + always be uninstalled. + 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/memberships/register b/gcloud/alpha/container/hub/memberships/register index 75b14813a..7fb88ba95 100644 --- a/gcloud/alpha/container/hub/memberships/register +++ b/gcloud/alpha/container/hub/memberships/register @@ -7,11 +7,11 @@ SYNOPSIS (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - (--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE - | [--enable-workload-identity : --has-private-issuer - | --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip] + [--install-connect-agent] [--internal-ip] [--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY] - [GCLOUD_WIDE_FLAG ...] + [--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE + | [--enable-workload-identity : --has-private-issuer + | --public-issuer-url=PUBLIC_ISSUER_URL]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command registers a cluster with the fleet by: @@ -19,103 +19,99 @@ DESCRIPTION 1. Creating a Fleet Membership resource corresponding to the cluster. 2. Adding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet. - 3. Installing the Connect Agent into this cluster. + 3. Installing the Connect agent into this cluster (optional for GKE). A successful registration implies that the cluster is now exclusive to a - single fleet. + single Fleet. If the cluster is already registered to another Fleet, the + registration will not be successful. - For more information about Connect Agent, go to: + To register a GKE cluster, use --gke-cluster or --gke-uri flag (no + --kubeconfig flag is required). Connect agent will not be installed by + default for GKE clusters. To install it, specify --install-connect-agent. + + To register a non-GKE or GKE On-Prem cluster, use --context flag (with an + optional --kubeconfig flag). Connect agent will always be installed for + non-GKE clusters. + + If Connect agent is to be installed, its authentication needs to be + configured by --enable-workload-identity or --service-account-key-file. For + the latter case, the corresponding service account must have been granted + gkehub.connect permissions. For more information about Connect agent, go + to: https://cloud.google.com/anthos/multicluster-management/connect/overview/ - To register a non-GKE or GKE On-Prem cluster use --context flag (with an - optional --kubeconfig flag). - - To register a GKE cluster use --gke-cluster or --gke-uri flag (no - --kubeconfig flag is required). - - In all cases, the Connect Agent that is installed in the target cluster - must authenticate to Google using a --service-account-key-file that - corresponds to a service account that has been granted gkehub.connect - permissions. - - If the cluster is already registered to another fleet, the registration is - not successful. - Rerunning this command against the same cluster with the same - MEMBERSHIP_NAME and target fleet is successful and upgrades the Connect - Agent if a new agent is available. + MEMBERSHIP_NAME and target fleet is successful, and will upgrade the + Connect agent if it is supposed to be installed and a newer version is + avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect Agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json + + Register a GKE cluster referenced from a GKE URI: + + $ gcloud alpha container hub memberships register my-cluster \ + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect - Agent: + agent using service account key file: $ gcloud alpha container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE Cluster location and name, and - install the Connect Agent: + Register a GKE cluster first, and install the Connect agent later. $ gcloud alpha container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --service-account-key-file=/tmp/keyfile.json - - Register a GKE cluster, and install a specific version of the Connect - Agent: + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud alpha container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity + + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud alpha container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install - the Connect Agent: + Register a GKE cluster and output a manifest that can be used to install the + Connect agent: $ gcloud alpha container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json - - $ gcloud alpha container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS Membership resource - The group of arguments defining a membership. The @@ -181,7 +177,27 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. - Exactly one of these must be specified: +OPTIONAL FLAGS + --install-connect-agent + If set to True for a GKE cluster, Connect agent will be installed in + the cluster. No-op for Non-GKE clusters, where Connect agent will + always be installed. + + --internal-ip + Whether to use the internal IP address of the cluster endpoint. + + --manifest-output-file=MANIFEST_OUTPUT_FILE + The full path of the file into which the Connect agent installation + manifest should be stored. If this option is provided, then the + manifest will be written to this file and will not be deployed into the + cluster by gcloud, and it will need to be deployed manually. + + --proxy=PROXY + The proxy address in the format of http[s]://{hostname}. The proxy must + support the HTTP CONNECT method in order for this connection to + succeed. + + At most one of these can be specified: --service-account-key-file=SERVICE_ACCOUNT_KEY_FILE The JSON file of a Google Cloud service account private key. This @@ -238,21 +254,6 @@ REQUIRED FLAGS account JWTs are served at a public endpoint different from the cluster API server. Requires --enable-workload-identity. -OPTIONAL FLAGS - --internal-ip - Whether to use the internal IP address of the cluster endpoint. - - --manifest-output-file=MANIFEST_OUTPUT_FILE - The full path of the file into which the Connect Agent installation - manifest should be stored. If this option is provided, then the - manifest will be written to this file and will not be deployed into the - cluster by gcloud, and it will need to be deployed manually. - - --proxy=PROXY - The proxy address in the format of http[s]://{hostname}. The proxy must - support the HTTP CONNECT method in order for this connection to - succeed. - 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/memberships/unregister b/gcloud/alpha/container/hub/memberships/unregister index 34fd3a268..6db5fb962 100644 --- a/gcloud/alpha/container/hub/memberships/unregister +++ b/gcloud/alpha/container/hub/memberships/unregister @@ -7,7 +7,7 @@ SYNOPSIS (MEMBERSHIP_NAME : --location=LOCATION) (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - [GCLOUD_WIDE_FLAG ...] + [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command unregisters a cluster with the fleet by: @@ -17,19 +17,19 @@ DESCRIPTION 2. Removing the corresponding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet (a.k.a `kubectl delete memberships membership`). - 3. Uninstalling the Connect Agent from this cluster (a.k.a - `kubectl delete on the gke-connect namespace`). + 3. [Optional for GKE cluster] Uninstalling the Connect agent from this + cluster (a.k.a `kubectl delete on the gke-connect namespace`). The unregister command makes additional internal checks to ensure that all three steps can be safely done to properly clean-up in-Fleet and in-cluster resources. - To register a non-GKE cluster use --context flag (with an optional - --kubeconfig flag). - To register a GKE cluster use --gke-cluster or --gke-uri flag (no --kubeconfig flag is required). + To register a non-GKE cluster use --context flag (with an optional + --kubeconfig`s flag). + To only delete the Fleet Membership resource, consider using the command: gcloud alpha container hub memberships delete. This command is intended to delete stale Fleet Membership resources as doing so on a fully registered @@ -58,6 +58,12 @@ EXAMPLES $ gcloud alpha container hub memberships unregister my-membership \ --gke-cluster=my-cluster-region-or-zone/my-cluster + Unregister a GKE cluster and uninstall Connect agent: + + $ gcloud alpha container hub memberships unregister my-membership \ + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --uninstall-connect-agent + POSITIONAL ARGUMENTS Membership resource - The group of arguments defining a membership. The arguments in this group can be used to specify the attributes of this @@ -121,6 +127,12 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. +OPTIONAL FLAGS + --uninstall-connect-agent + If set to True for a GKE cluster, Connect agent will be uninstalled + from the cluster. No-op for Non-GKE clusters, where Connect agent will + always be uninstalled. + 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/dataplex/assets/actions/list b/gcloud/alpha/dataplex/assets/actions/list index 6f8702b06..0de9f6431 100644 --- a/gcloud/alpha/dataplex/assets/actions/list +++ b/gcloud/alpha/dataplex/assets/actions/list @@ -40,7 +40,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --asset on the command line with a fully @@ -48,7 +48,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --asset on the command line with a fully @@ -57,7 +57,7 @@ REQUIRED FLAGS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument --asset on the command line with a fully diff --git a/gcloud/alpha/dataplex/assets/delete b/gcloud/alpha/dataplex/assets/delete index fdc6eb5d0..60b622565 100644 --- a/gcloud/alpha/dataplex/assets/delete +++ b/gcloud/alpha/dataplex/assets/delete @@ -38,7 +38,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument asset on the command line with a fully @@ -46,7 +46,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument asset on the command line with a fully @@ -55,7 +55,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument asset on the command line with a fully diff --git a/gcloud/alpha/dataplex/assets/describe b/gcloud/alpha/dataplex/assets/describe index 685737b85..86f3a59aa 100644 --- a/gcloud/alpha/dataplex/assets/describe +++ b/gcloud/alpha/dataplex/assets/describe @@ -39,7 +39,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument asset on the command line with a fully @@ -47,7 +47,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument asset on the command line with a fully @@ -56,7 +56,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument asset on the command line with a fully diff --git a/gcloud/alpha/dataplex/assets/get-iam-policy b/gcloud/alpha/dataplex/assets/get-iam-policy index 757e36030..3c716aa62 100644 --- a/gcloud/alpha/dataplex/assets/get-iam-policy +++ b/gcloud/alpha/dataplex/assets/get-iam-policy @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument asset on the command line with a fully @@ -51,7 +51,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument asset on the command line with a fully @@ -60,7 +60,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument asset on the command line with a fully diff --git a/gcloud/alpha/dataplex/assets/list b/gcloud/alpha/dataplex/assets/list index ded7b692b..bdddc1c78 100644 --- a/gcloud/alpha/dataplex/assets/list +++ b/gcloud/alpha/dataplex/assets/list @@ -40,7 +40,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --zone on the command line with a fully @@ -48,7 +48,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --zone on the command line with a fully diff --git a/gcloud/alpha/dataplex/content/add-iam-policy-binding b/gcloud/alpha/dataplex/content/add-iam-policy-binding new file mode 100644 index 000000000..dc8d99bf0 --- /dev/null +++ b/gcloud/alpha/dataplex/content/add-iam-policy-binding @@ -0,0 +1,96 @@ +NAME + gcloud alpha dataplex content add-iam-policy-binding - adds IAM policy + binding to a Dataplex Content + +SYNOPSIS + gcloud alpha dataplex content add-iam-policy-binding + (CONTENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Adds IAM policy binding to a Dataplex Content. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user 'testuser@gmail.com' to content test-content within lake test-lake in + location us-central, run: + + $ gcloud alpha dataplex content add-iam-policy-binding \ + test-content --project=test-project --location=us-central1 \ + --lake=test-lake --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Content resource - The Content to add IAM policy binding 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex content add-iam-policy-binding + diff --git a/gcloud/alpha/dataplex/content/create b/gcloud/alpha/dataplex/content/create new file mode 100644 index 000000000..57f1a0c19 --- /dev/null +++ b/gcloud/alpha/dataplex/content/create @@ -0,0 +1,107 @@ +NAME + gcloud alpha dataplex content create - creating a content + +SYNOPSIS + gcloud alpha dataplex content create --data-text=DATA_TEXT --path=PATH + (--kernel-type=KERNEL_TYPE | --query-engine=QUERY_ENGINE) + (--lake=LAKE : --location=LOCATION) [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Creating a content. + +EXAMPLES + To create a Dataplex content test-content of type notebook within lake + test-lake in location us-central1. + + $ gcloud alpha dataplex content create --project=test-project \ + --location=us-central1 --lake=test-lake --kernel-type=PYTHON3 \ + --data-text='' --path='test-content' + +REQUIRED FLAGS + --data-text=DATA_TEXT + Content data in string format + + --path=PATH + The path for the Content file, represented as directory structure + + Sql script or notebook related configurations. + + Exactly one of these must be specified: + + Notebook related configurations. + + --kernel-type=KERNEL_TYPE + Kernel Type of the notebook. KERNEL_TYPE must be (currently only + one value is supported): + + PYTHON3 + python3 + + Sql script related configurations. + + --query-engine=QUERY_ENGINE + Query Engine to be used for the Sql Query. QUERY_ENGINE must be + (currently only one value is supported): + + SPARK + spark + + Lakes resource - Arguments and flags that define the Dataplex lake you + want to create a Content 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 --lake 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. + + --lake=LAKE + ID of the lakes or fully qualified identifier for the lakes. To set + the lake attribute: + ▸ provide the argument --lake 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 of the Dataplex resource. To set the location attribute: + ▸ provide the argument --lake on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +OPTIONAL FLAGS + --description=DESCRIPTION + Description of the Content + + --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. + + --validate-only + Validate the create action, 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 dataplex content create + diff --git a/gcloud/alpha/dataplex/content/delete b/gcloud/alpha/dataplex/content/delete new file mode 100644 index 000000000..a6d8a100e --- /dev/null +++ b/gcloud/alpha/dataplex/content/delete @@ -0,0 +1,76 @@ +NAME + gcloud alpha dataplex content delete - delete a Dataplex Content Resource + +SYNOPSIS + gcloud alpha dataplex content delete + (CONTENT : --lake=LAKE --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Dataplex Content resource based on project, location, + lake, and content. + +EXAMPLES + To delete a content test-content in lake test-lake under location + us-central1 inside project test-project, run : + + $ gcloud alpha dataplex content delete --project=test-project \ + --location=us-central1 --lake=test-lake test-content + +POSITIONAL ARGUMENTS + Content resource - Arguments and flags that define the Dataplex Content + 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument content 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. This variant is also available: + + $ gcloud dataplex content delete + diff --git a/gcloud/alpha/dataplex/content/describe b/gcloud/alpha/dataplex/content/describe new file mode 100644 index 000000000..5419e58d6 --- /dev/null +++ b/gcloud/alpha/dataplex/content/describe @@ -0,0 +1,89 @@ +NAME + gcloud alpha dataplex content describe - retrieve a Dataplex Content + Resource + +SYNOPSIS + gcloud alpha dataplex content describe + (CONTENT : --lake=LAKE --location=LOCATION) + [--view=VIEW; default="basic"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get a Dataplex Content resource based on project, location, lake, + and content. + +EXAMPLES + To describe a Dataplex Content test-content in project test-project under + loaction us-central1 inside project test-project, run: + + $ gcloud alpha dataplex content describe test-content \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Content resource - Arguments and flags that define the Dataplex Content + 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --view=VIEW; default="basic" + There are two possible views, 'basic' and 'full'. The default view is + 'basic'. VIEW must be one of: + + basic + Does not include the Content data in response. + + full + Includes the content data in response. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud dataplex content describe + diff --git a/gcloud/alpha/dataplex/content/get-iam-policy b/gcloud/alpha/dataplex/content/get-iam-policy new file mode 100644 index 000000000..2d246f9f2 --- /dev/null +++ b/gcloud/alpha/dataplex/content/get-iam-policy @@ -0,0 +1,105 @@ +NAME + gcloud alpha dataplex content get-iam-policy - retrieve the IAM policy for + a Dataplex Content + +SYNOPSIS + gcloud alpha dataplex content get-iam-policy + (CONTENT : --lake=LAKE --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get a Dataplex Content Iam Policy based on project_id, location, + lake_id, and contents_id. + +EXAMPLES + To get the IAM policy of a Dataplex Content test-content in project + test-project under loaction us-central1 inside lake test-lake, run: + + $ gcloud alpha dataplex content get-iam-policy test-content \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Content resource - Arguments and flags that define the Dataplex contents + IAM policy 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument content 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud dataplex content get-iam-policy + diff --git a/gcloud/alpha/dataplex/content/help b/gcloud/alpha/dataplex/content/help new file mode 100644 index 000000000..04575d9fd --- /dev/null +++ b/gcloud/alpha/dataplex/content/help @@ -0,0 +1,54 @@ +NAME + gcloud alpha dataplex content - manage Dataplex Content + +SYNOPSIS + gcloud alpha dataplex content COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Content. + +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) Adds IAM policy binding to a Dataplex Content. + + create + (ALPHA) Creating a content. + + delete + (ALPHA) Delete a Dataplex Content Resource. + + describe + (ALPHA) Retrieve a Dataplex Content Resource. + + get-iam-policy + (ALPHA) Retrieve the IAM policy for a Dataplex Content. + + list + (ALPHA) List Dataplex Content Resources. + + remove-iam-policy-binding + (ALPHA) Removes IAM policy binding from a Dataplex Content. + + set-iam-policy + (ALPHA) Set the IAM policy to a Dataplex Content as defined in a JSON + or YAML file. + + update + (ALPHA) Update a Dataplex Content Resource with the given + 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 dataplex content + diff --git a/gcloud/alpha/dataplex/content/list b/gcloud/alpha/dataplex/content/list new file mode 100644 index 000000000..ff66ce567 --- /dev/null +++ b/gcloud/alpha/dataplex/content/list @@ -0,0 +1,101 @@ +NAME + gcloud alpha dataplex content list - list Dataplex Content Resources + +SYNOPSIS + gcloud alpha dataplex content list (--lake=LAKE : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Dataplex Content resource based on project, location, and + lake. Currently list does not support project/{project_id}/.../ notation. + +EXAMPLES + To list all Dataplex Content resource in lake test-lake under location + us-central1 inside project test-project, run : + + $ gcloud alpha dataplex content list --project=test-project \ + --location=us-central1 --lake=test-lake + +REQUIRED FLAGS + Lake resource - Arguments and flags that define the Dataplex Content you + want 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 --lake 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. + + --lake=LAKE + ID of the lake or fully qualified identifier for the lake. To set the + lake attribute: + ▸ provide the argument --lake 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 --lake 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. This variant is also available: + + $ gcloud dataplex content list + diff --git a/gcloud/alpha/dataplex/content/remove-iam-policy-binding b/gcloud/alpha/dataplex/content/remove-iam-policy-binding new file mode 100644 index 000000000..245b0927e --- /dev/null +++ b/gcloud/alpha/dataplex/content/remove-iam-policy-binding @@ -0,0 +1,97 @@ +NAME + gcloud alpha dataplex content remove-iam-policy-binding - removes IAM + policy binding from a Dataplex Content + +SYNOPSIS + gcloud alpha dataplex content remove-iam-policy-binding + (CONTENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Removes IAM policy binding from a Dataplex Content. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from a content test-content within lake test-lake + in location us-central1, run: + + $ gcloud alpha dataplex content remove-iam-policy-binding \ + test-content --project=test-project --location=us-central1 \ + --lake=test-lake --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Content resource - The Content to remove IAM policy binding 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex content remove-iam-policy-binding + diff --git a/gcloud/alpha/dataplex/content/set-iam-policy b/gcloud/alpha/dataplex/content/set-iam-policy new file mode 100644 index 000000000..0d1784872 --- /dev/null +++ b/gcloud/alpha/dataplex/content/set-iam-policy @@ -0,0 +1,81 @@ +NAME + gcloud alpha dataplex content set-iam-policy - set the IAM policy to a + Dataplex Content as defined in a JSON or YAML file + +SYNOPSIS + gcloud alpha dataplex content set-iam-policy + (CONTENT : --lake=LAKE --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) See https://cloud.google.com/iam/docs/managing-policies for details + of the policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex content test-content within lake + test-lake in location us-central1 and : + + $ gcloud alpha dataplex content set-iam-policy test-content \ + --project=test-project --location=us-central1 --lake=test-lake \ + policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Content resource - The Content to set 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + 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. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex content set-iam-policy + diff --git a/gcloud/alpha/dataplex/content/update b/gcloud/alpha/dataplex/content/update new file mode 100644 index 000000000..d45dfb9ff --- /dev/null +++ b/gcloud/alpha/dataplex/content/update @@ -0,0 +1,117 @@ +NAME + gcloud alpha dataplex content update - update a Dataplex Content Resource + with the given configurations + +SYNOPSIS + gcloud alpha dataplex content update + (CONTENT : --lake=LAKE --location=LOCATION) [--data-text=DATA_TEXT] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--path=PATH] + [--validate-only] + [--kernel-type=KERNEL_TYPE | --query-engine=QUERY_ENGINE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Dataplex Content Resource with the given configurations. + +EXAMPLES + To update a Dataplex content test-content in project test-project within + lake test-lake in location us-central1 and change the description to + Updated Description, run: + + $ gcloud alpha dataplex content update test-content \ + --project=test-project --location=us-central1 --lake=test-lake \ + --description='Updated Description' + +POSITIONAL ARGUMENTS + Content resource - The Content to Update a Content 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --data-text=DATA_TEXT + Content data in string format + + --description=DESCRIPTION + Description of the Content + + --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. + + --path=PATH + The path for the Content file, represented as directory structure + + --validate-only + Validate the update action, but don't actually perform it. + + Sql script or notebook related configurations. + + At most one of these can be specified: + + Notebook related configurations. + + --kernel-type=KERNEL_TYPE + Kernel Type of the notebook. KERNEL_TYPE must be (currently only + one value is supported): + + PYTHON3 + python3 + + Sql script related configurations. + + --query-engine=QUERY_ENGINE + Query Engine to be used for the Sql Query. QUERY_ENGINE must be + (currently only one value is supported): + + SPARK + spark + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 dataplex content update + diff --git a/gcloud/alpha/dataplex/environments/add-iam-policy-binding b/gcloud/alpha/dataplex/environments/add-iam-policy-binding new file mode 100644 index 000000000..8ad680c14 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/add-iam-policy-binding @@ -0,0 +1,96 @@ +NAME + gcloud alpha dataplex environments add-iam-policy-binding - adds IAM policy + binding to a Dataplex Environment + +SYNOPSIS + gcloud alpha dataplex environments add-iam-policy-binding + (ENVIRONMENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Adds IAM policy binding to a Dataplex Environment. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user 'testuser@gmail.com' to environment test-environment within lake + test-lake in location us-central, run: + + $ gcloud alpha dataplex environments add-iam-policy-binding \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Environments resource - The Environment to add IAM policy binding 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex environments add-iam-policy-binding + diff --git a/gcloud/alpha/dataplex/environments/create b/gcloud/alpha/dataplex/environments/create new file mode 100644 index 000000000..64b1602a7 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/create @@ -0,0 +1,163 @@ +NAME + gcloud alpha dataplex environments create - create a Dataplex Environment + +SYNOPSIS + gcloud alpha dataplex environments create + (ENVIRONMENT : --lake=LAKE --location=LOCATION) + ((--os-image-version=OS_IMAGE_VERSION + : --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...]) + : --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB; default=100 + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + --compute-node-count=COMPUTE_NODE_COUNT) [--description=DESCRIPTION] + [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] + [--async | --validate-only] + [--session-enable-fast-startup + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Dataplex Environment. + +EXAMPLES + To create a Dataplex Environment test-environment within lake test-lake in + location us-central1 inside project test-project , run: + + $ gcloud alpha dataplex environments create test-environment \ + --project=test-project --location=us-central1 --lake=test-lake \ + --os-image-version=1.0 + + To know about the other required arguments to create an environment run: + + $ gcloud dataplex environment create --help + +POSITIONAL ARGUMENTS + Environments resource - The Environment to create a Environment 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + Configuration for the underlying infrastructure used to run workloads. + + This must be specified. + + Software Runtime Configuration to run Analyze. + + This must be specified. + + --os-image-version=OS_IMAGE_VERSION + Dataplex Image version. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + List of Java jars to be included in the runtime environment. Valid + input includes Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on daemon + config files. Property keys are specified in prefix:property + format. + + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + Compute resources associated with the analyze interactive workloads. + + --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB; default=100 + Size in GB of the disk. Default is 100 GB. + + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + Maximum number of configurable nodes. + + --compute-node-count=COMPUTE_NODE_COUNT + Total number of worker nodes in the cluster. + +OPTIONAL FLAGS + --description=DESCRIPTION + Description of the Environment + + --display-name=DISPLAY_NAME + Display Name of the Environment + + --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. + + Configuration for sessions created for the environment to be created. + + --session-enable-fast-startup + Enables fast startup. This causes sessions to be pre-created and + available for faster startup to enable interactive exploration + use-cases. + + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION + The idle time configuration of the session. The session will be + auto-terminated at the end of this period. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 dataplex environments create + diff --git a/gcloud/alpha/dataplex/environments/delete b/gcloud/alpha/dataplex/environments/delete new file mode 100644 index 000000000..95fa67171 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/delete @@ -0,0 +1,82 @@ +NAME + gcloud alpha dataplex environments delete - delete a Dataplex Environment + +SYNOPSIS + gcloud alpha dataplex environments delete + (ENVIRONMENT : --lake=LAKE --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Dataplex Environment based on project, location, lake, + environment. + +EXAMPLES + To delete a Dataplex Environment test-environment in project test-project + under location us-central1 within lake test-lake, run: + + $ gcloud alpha dataplex environments delete test-environment \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Environment resource - Arguments and flags that define the Dataplex + Environment 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 environment 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. + + ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument environment 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. This variant is also available: + + $ gcloud dataplex environments delete + diff --git a/gcloud/alpha/dataplex/environments/describe b/gcloud/alpha/dataplex/environments/describe new file mode 100644 index 000000000..9093b8a55 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/describe @@ -0,0 +1,77 @@ +NAME + gcloud alpha dataplex environments describe - retrieve a Dataplex + Environment + +SYNOPSIS + gcloud alpha dataplex environments describe + (ENVIRONMENT : --lake=LAKE --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get a Dataplex Environment resource based on project, location, + lake, and environment. + +EXAMPLES + To describe a Dataplex Environment test-environment in project test-project + under location us-central1 within lake test-lake, run: + + $ gcloud alpha dataplex environments describe test-environment \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Environment resource - Arguments and flags that define the Dataplex + Environment 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 environment 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. + + ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument environment 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. This variant is also available: + + $ gcloud dataplex environments describe + diff --git a/gcloud/alpha/dataplex/environments/get-iam-policy b/gcloud/alpha/dataplex/environments/get-iam-policy new file mode 100644 index 000000000..1cc4e8de7 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/get-iam-policy @@ -0,0 +1,106 @@ +NAME + gcloud alpha dataplex environments get-iam-policy - retrieve a Dataplex + Environment IAM policy + +SYNOPSIS + gcloud alpha dataplex environments get-iam-policy + (ENVIRONMENT : --lake=LAKE --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get a Dataplex Environment Iam Policy based on project_id, + location, lake_id, and environment_id. + +EXAMPLES + To get the IAM policy of a Dataplex Environment test-environment in project + test-project under location us-central1 within lake test-lake, run: + + $ gcloud alpha dataplex environments get-iam-policy \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake + +POSITIONAL ARGUMENTS + Environment resource - Arguments and flags that define the Dataplex + Environment IAM policy 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 environment 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. + + ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument environment 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud dataplex environments get-iam-policy + diff --git a/gcloud/alpha/dataplex/environments/help b/gcloud/alpha/dataplex/environments/help new file mode 100644 index 000000000..8edc2d8ae --- /dev/null +++ b/gcloud/alpha/dataplex/environments/help @@ -0,0 +1,59 @@ +NAME + gcloud alpha dataplex environments - manage Dataplex Environments + +SYNOPSIS + gcloud alpha dataplex environments GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Environments. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + sessions + (ALPHA) Manage Dataplex Sessions services. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (ALPHA) Adds IAM policy binding to a Dataplex Environment. + + create + (ALPHA) Create a Dataplex Environment. + + delete + (ALPHA) Delete a Dataplex Environment. + + describe + (ALPHA) Retrieve a Dataplex Environment. + + get-iam-policy + (ALPHA) Retrieve a Dataplex Environment IAM policy. + + list + (ALPHA) List Dataplex Environments. + + remove-iam-policy-binding + (ALPHA) Removes IAM policy binding from a Dataplex Environment. + + set-iam-policy + (ALPHA) Set an IAM policy binding for a Dataplex Environment as defined + in a JSON or YAML file. + + update + (ALPHA) Update a Dataplex Environment with the given 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 dataplex environments + diff --git a/gcloud/alpha/dataplex/environments/list b/gcloud/alpha/dataplex/environments/list new file mode 100644 index 000000000..ae07ef3c2 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/list @@ -0,0 +1,100 @@ +NAME + gcloud alpha dataplex environments list - list Dataplex Environments + +SYNOPSIS + gcloud alpha dataplex environments list (--lake=LAKE : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Dataplex Environments based on project, location and lake. + +EXAMPLES + To list all Dataplex Environments in lake test-lake under location + us-central1, run :- + + $ gcloud alpha dataplex environments list --project=test-project \ + --location=us-central1 --lake=test-lake + +REQUIRED FLAGS + Lake resource - Arguments and flags that define the Dataplex Environments + you want 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 --lake 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. + + --lake=LAKE + ID of the lake or fully qualified identifier for the lake. To set the + lake attribute: + ▸ provide the argument --lake 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 --lake 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. This variant is also available: + + $ gcloud dataplex environments list + diff --git a/gcloud/alpha/dataplex/environments/remove-iam-policy-binding b/gcloud/alpha/dataplex/environments/remove-iam-policy-binding new file mode 100644 index 000000000..4b8d67d16 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/remove-iam-policy-binding @@ -0,0 +1,97 @@ +NAME + gcloud alpha dataplex environments remove-iam-policy-binding - removes IAM + policy binding from a Dataplex Environment + +SYNOPSIS + gcloud alpha dataplex environments remove-iam-policy-binding + (ENVIRONMENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Removes IAM policy binding from a Dataplex Environment. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from an environment test-environment within lake + test-lake in location us-central1, run: + + $ gcloud alpha dataplex environments remove-iam-policy-binding \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Environments resource - The Environment to remove IAM policy binding 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex environments remove-iam-policy-binding + diff --git a/gcloud/alpha/dataplex/environments/sessions/help b/gcloud/alpha/dataplex/environments/sessions/help new file mode 100644 index 000000000..d8c376f57 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/sessions/help @@ -0,0 +1,29 @@ +NAME + gcloud alpha dataplex environments sessions - manage Dataplex Sessions + services + +SYNOPSIS + gcloud alpha dataplex environments sessions COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Dataplex Sessions services. + +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 Sessions associated with a Environment. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex environments sessions + diff --git a/gcloud/alpha/dataplex/environments/sessions/list b/gcloud/alpha/dataplex/environments/sessions/list new file mode 100644 index 000000000..f2c31b137 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/sessions/list @@ -0,0 +1,106 @@ +NAME + gcloud alpha dataplex environments sessions list - list Sessions associated + with a Environment + +SYNOPSIS + gcloud alpha dataplex environments sessions list + (--environment=ENVIRONMENT : --lake=LAKE --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List Sessions associated with a Environment based on project, + location, lake and environment. + +EXAMPLES + To list sessions associated with a Dataplex Environment test-environment in + project test-project and lake test-lake under location us-central1, run: + + $ gcloud alpha dataplex environments sessions list \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake + +REQUIRED FLAGS + Environment resource - Arguments and flags that define the Dataplex + Environment to list the Sessions associated with the Environment. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument --environment 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. + + --environment=ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument --environment on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument --environment on the command line with a + fully specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument --environment 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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. This variant is also available: + + $ gcloud dataplex environments sessions list + diff --git a/gcloud/alpha/dataplex/environments/set-iam-policy b/gcloud/alpha/dataplex/environments/set-iam-policy new file mode 100644 index 000000000..40cfdd781 --- /dev/null +++ b/gcloud/alpha/dataplex/environments/set-iam-policy @@ -0,0 +1,81 @@ +NAME + gcloud alpha dataplex environments set-iam-policy - set an IAM policy + binding for a Dataplex Environment as defined in a JSON or YAML file + +SYNOPSIS + gcloud alpha dataplex environments set-iam-policy + (ENVIRONMENT : --lake=LAKE --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) See https://cloud.google.com/iam/docs/managing-policies for details + of the policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex environment test-environment within + lake test-lake in location us-central1: + + $ gcloud alpha dataplex environments set-iam-policy \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Environments resource - The Environment to set 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + 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. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 dataplex environments set-iam-policy + diff --git a/gcloud/alpha/dataplex/environments/update b/gcloud/alpha/dataplex/environments/update new file mode 100644 index 000000000..8bb9f383c --- /dev/null +++ b/gcloud/alpha/dataplex/environments/update @@ -0,0 +1,153 @@ +NAME + gcloud alpha dataplex environments update - update a Dataplex Environment + with the given configurations + +SYNOPSIS + gcloud alpha dataplex environments update + (ENVIRONMENT : --lake=LAKE --location=LOCATION) + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--labels=[KEY=VALUE,...]] [--async | --validate-only] + [--compute-disk-size-gb=COMPUTE_DISK_SIZE_GB + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + --compute-node-count=COMPUTE_NODE_COUNT + --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] + --os-image-version=OS_IMAGE_VERSION] + [--session-enable-fast-startup + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Dataplex Environment with the given configurations. + +EXAMPLES + To update a Dataplex environment test-environment within lake test-lake in + location us-central1 and change the description to Updated Description, + run: + + $ gcloud alpha dataplex environments update test-environment \ + --project=test-project --location=us-central1 --lake=test-lake \ + --description='Updated Description' + +POSITIONAL ARGUMENTS + Environments resource - The Environment to update a Environment 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --description=DESCRIPTION + Description of the Environment + + --display-name=DISPLAY_NAME + Display Name of the Environment + + --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. + + Configuration for the underlying infrastructure used to run workloads. + + Compute resources associated with the analyze interactive workloads. + + --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB + Size in GB of the disk. Default is 100 GB. + + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + Maximum number of configurable nodes. + + --compute-node-count=COMPUTE_NODE_COUNT + Total number of worker nodes in the cluster. + + Software Runtime Configuration to run Analyze. + + --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + List of Java jars to be included in the runtime environment. Valid + input includes Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on daemon + config files. Property keys are specified in prefix:property + format. + + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + --os-image-version=OS_IMAGE_VERSION + Dataplex Image version. + + Configuration for sessions created for the environment to be updated. + + --session-enable-fast-startup + Enables fast startup. This causes sessions to be pre-created and + available for faster startup to enable interactive exploration + use-cases. + + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION + The idle time configuration of the session. The session will be + auto-terminated at the end of this period. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 dataplex environments update + diff --git a/gcloud/alpha/dataplex/help b/gcloud/alpha/dataplex/help index 40ff60d88..f04d22a8a 100644 --- a/gcloud/alpha/dataplex/help +++ b/gcloud/alpha/dataplex/help @@ -18,6 +18,12 @@ GROUPS assets (ALPHA) Manage Dataplex Asset resources. + content + (ALPHA) Manage Dataplex Content. + + environments + (ALPHA) Manage Dataplex Environments. + lakes (ALPHA) Manage Dataplex Lake resources. diff --git a/gcloud/alpha/dataplex/lakes/actions/list b/gcloud/alpha/dataplex/lakes/actions/list index 9884f2291..f4c5094cf 100644 --- a/gcloud/alpha/dataplex/lakes/actions/list +++ b/gcloud/alpha/dataplex/lakes/actions/list @@ -39,7 +39,7 @@ REQUIRED FLAGS this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --lake on the command line with a fully diff --git a/gcloud/alpha/dataplex/lakes/delete b/gcloud/alpha/dataplex/lakes/delete index b159c4b94..fed6dd947 100644 --- a/gcloud/alpha/dataplex/lakes/delete +++ b/gcloud/alpha/dataplex/lakes/delete @@ -35,7 +35,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument lake on the command line with a fully diff --git a/gcloud/alpha/dataplex/lakes/describe b/gcloud/alpha/dataplex/lakes/describe index 82170d4e0..981be0382 100644 --- a/gcloud/alpha/dataplex/lakes/describe +++ b/gcloud/alpha/dataplex/lakes/describe @@ -37,7 +37,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument lake on the command line with a fully diff --git a/gcloud/alpha/dataplex/lakes/get-iam-policy b/gcloud/alpha/dataplex/lakes/get-iam-policy index 6943eae06..e34993442 100644 --- a/gcloud/alpha/dataplex/lakes/get-iam-policy +++ b/gcloud/alpha/dataplex/lakes/get-iam-policy @@ -42,7 +42,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument lake on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/create b/gcloud/alpha/dataplex/tasks/create index 1ec419e8e..c123dbc0f 100644 --- a/gcloud/alpha/dataplex/tasks/create +++ b/gcloud/alpha/dataplex/tasks/create @@ -98,7 +98,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -106,7 +106,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/delete b/gcloud/alpha/dataplex/tasks/delete index 494265ecf..ff4215c34 100644 --- a/gcloud/alpha/dataplex/tasks/delete +++ b/gcloud/alpha/dataplex/tasks/delete @@ -37,7 +37,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -45,7 +45,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/describe b/gcloud/alpha/dataplex/tasks/describe index cdc13c9c6..4f616a6a9 100644 --- a/gcloud/alpha/dataplex/tasks/describe +++ b/gcloud/alpha/dataplex/tasks/describe @@ -39,7 +39,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -47,7 +47,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/get-iam-policy b/gcloud/alpha/dataplex/tasks/get-iam-policy index cac6cee97..7f9c0de4e 100644 --- a/gcloud/alpha/dataplex/tasks/get-iam-policy +++ b/gcloud/alpha/dataplex/tasks/get-iam-policy @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -51,7 +51,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/jobs/cancel b/gcloud/alpha/dataplex/tasks/jobs/cancel index 5af3863bf..8b77b0389 100644 --- a/gcloud/alpha/dataplex/tasks/jobs/cancel +++ b/gcloud/alpha/dataplex/tasks/jobs/cancel @@ -40,7 +40,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument job on the command line with a fully @@ -48,7 +48,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument job on the command line with a fully @@ -57,7 +57,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --task=TASK - The identifier of the Dataplex task resource. + Identifier of the Dataplex task resource. To set the task attribute: ▸ provide the argument job on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/jobs/describe b/gcloud/alpha/dataplex/tasks/jobs/describe index 957235f28..4d8b3f91e 100644 --- a/gcloud/alpha/dataplex/tasks/jobs/describe +++ b/gcloud/alpha/dataplex/tasks/jobs/describe @@ -41,7 +41,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument job on the command line with a fully @@ -49,7 +49,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument job on the command line with a fully @@ -58,7 +58,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --task=TASK - The identifier of the Dataplex task resource. + Identifier of the Dataplex task resource. To set the task attribute: ▸ provide the argument job on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/jobs/list b/gcloud/alpha/dataplex/tasks/jobs/list index 44d6919c1..b468d7fde 100644 --- a/gcloud/alpha/dataplex/tasks/jobs/list +++ b/gcloud/alpha/dataplex/tasks/jobs/list @@ -40,7 +40,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --task on the command line with a fully @@ -48,7 +48,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --task on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/list b/gcloud/alpha/dataplex/tasks/list index 7c3c10089..c6c836085 100644 --- a/gcloud/alpha/dataplex/tasks/list +++ b/gcloud/alpha/dataplex/tasks/list @@ -40,7 +40,7 @@ REQUIRED FLAGS this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --lake on the command line with a fully diff --git a/gcloud/alpha/dataplex/tasks/update b/gcloud/alpha/dataplex/tasks/update index b89f40f5d..569c3a171 100644 --- a/gcloud/alpha/dataplex/tasks/update +++ b/gcloud/alpha/dataplex/tasks/update @@ -72,7 +72,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -80,7 +80,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/alpha/dataplex/zones/actions/list b/gcloud/alpha/dataplex/zones/actions/list index 598804dcd..5491a3adb 100644 --- a/gcloud/alpha/dataplex/zones/actions/list +++ b/gcloud/alpha/dataplex/zones/actions/list @@ -39,7 +39,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --zone on the command line with a fully @@ -47,7 +47,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --zone on the command line with a fully diff --git a/gcloud/alpha/dataplex/zones/delete b/gcloud/alpha/dataplex/zones/delete index 01c11c942..e48021da6 100644 --- a/gcloud/alpha/dataplex/zones/delete +++ b/gcloud/alpha/dataplex/zones/delete @@ -37,7 +37,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument zone on the command line with a fully @@ -45,7 +45,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument zone on the command line with a fully diff --git a/gcloud/alpha/dataplex/zones/describe b/gcloud/alpha/dataplex/zones/describe index adede12b3..e139c6393 100644 --- a/gcloud/alpha/dataplex/zones/describe +++ b/gcloud/alpha/dataplex/zones/describe @@ -38,7 +38,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument zone on the command line with a fully @@ -46,7 +46,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument zone on the command line with a fully diff --git a/gcloud/alpha/dataplex/zones/get-iam-policy b/gcloud/alpha/dataplex/zones/get-iam-policy index bd702462a..a4973aa06 100644 --- a/gcloud/alpha/dataplex/zones/get-iam-policy +++ b/gcloud/alpha/dataplex/zones/get-iam-policy @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument zone on the command line with a fully @@ -51,7 +51,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument zone on the command line with a fully diff --git a/gcloud/alpha/dataplex/zones/list b/gcloud/alpha/dataplex/zones/list index 950c137a3..4aded0390 100644 --- a/gcloud/alpha/dataplex/zones/list +++ b/gcloud/alpha/dataplex/zones/list @@ -39,7 +39,7 @@ REQUIRED FLAGS this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --lake on the command line with a fully diff --git a/gcloud/alpha/dns/managed-zones/get-iam-policy b/gcloud/alpha/dns/managed-zones/get-iam-policy index 08bbf76b6..0b0dfd897 100644 --- a/gcloud/alpha/dns/managed-zones/get-iam-policy +++ b/gcloud/alpha/dns/managed-zones/get-iam-policy @@ -42,7 +42,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 dns managed-zones get-iam-policy $ gcloud beta dns managed-zones get-iam-policy diff --git a/gcloud/alpha/dns/managed-zones/set-iam-policy b/gcloud/alpha/dns/managed-zones/set-iam-policy index 26bd9ca6d..6b441f677 100644 --- a/gcloud/alpha/dns/managed-zones/set-iam-policy +++ b/gcloud/alpha/dns/managed-zones/set-iam-policy @@ -48,7 +48,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 dns managed-zones set-iam-policy $ gcloud beta dns managed-zones set-iam-policy diff --git a/gcloud/alpha/edge-cloud/networking/interconnects/attachments/dedicated/create b/gcloud/alpha/edge-cloud/networking/interconnects/attachments/dedicated/create index e5bb05cb8..c151d67a2 100644 --- a/gcloud/alpha/edge-cloud/networking/interconnects/attachments/dedicated/create +++ b/gcloud/alpha/edge-cloud/networking/interconnects/attachments/dedicated/create @@ -6,9 +6,9 @@ NAME SYNOPSIS gcloud alpha edge-cloud networking interconnects attachments dedicated create (INTERCONNECT_ATTACHMENT : --location=LOCATION --zone=ZONE) - --interconnect=INTERCONNECT --router=ROUTER [--async] - [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] - [--mtu=MTU; default=1500] [--vlan-id=VLAN_ID] [GCLOUD_WIDE_FLAG ...] + --interconnect=INTERCONNECT [--async] [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [--mtu=MTU; default=1500] + [--network=NETWORK] [--vlan-id=VLAN_ID] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a new dedicated Distributed Cloud Edge Network interconnect @@ -21,7 +21,7 @@ EXAMPLES $ gcloud alpha edge-cloud networking interconnects attachments \ dedicated create my-attachment --location=us-central1 \ --zone=us-central1-edge-den1 --interconnect=INTERCONNECT-LINK1 \ - --router=my-edge-router --vlan-id=200 --mtu=1500 + --network=my-edge-network --vlan-id=200 --mtu=1500 POSITIONAL ARGUMENTS Interconnect attachment resource - Distributed Cloud Edge Network @@ -63,9 +63,6 @@ REQUIRED FLAGS The underlying interconnect object that this attachment's traffic will traverse through. - --router=ROUTER - The router to use for dynamic routing. - OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to @@ -87,6 +84,9 @@ OPTIONAL FLAGS that can be transmitted on this attachment. Default value is 1500 bytes, and the valid values are 1500 and 9000. + --network=NETWORK + The network to use for dynamic routing. + --vlan-id=VLAN_ID The ID of the vlan to tag the subnetwork. Default value is 0. diff --git a/gcloud/alpha/edge-cloud/networking/routers/create b/gcloud/alpha/edge-cloud/networking/routers/create index 28e14eb3d..ad178e624 100644 --- a/gcloud/alpha/edge-cloud/networking/routers/create +++ b/gcloud/alpha/edge-cloud/networking/routers/create @@ -65,7 +65,7 @@ OPTIONAL FLAGS complete. --description=DESCRIPTION - An optional, textual description for the subnet. + An optional, textual description for the router. --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/alpha/firestore/databases/create b/gcloud/alpha/firestore/databases/create index 3ef644093..be1c55cd8 100644 --- a/gcloud/alpha/firestore/databases/create +++ b/gcloud/alpha/firestore/databases/create @@ -3,18 +3,43 @@ NAME Native database via Firestore API SYNOPSIS - gcloud alpha firestore databases create [--location=LOCATION] + gcloud alpha firestore databases create [DATABASE] --location=LOCATION [--type=TYPE; default="firestore-native"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Create a Google Cloud Firestore Native database via Firestore API. + (ALPHA) 'EXAMPLES': To create Cloud Firestore Native database in nam5. -FLAGS + $ gcloud alpha firestore databases create --location=nam5 + + To create Cloud Datastore Mode database in us-east1. + + $ gcloud alpha firestore databases create --location=us-east1 \ + --type=datastore-mode + + To create Cloud Datastore Mode database in us-east1 with a databaseId foo. + + $ gcloud alpha firestore databases create foo --location=us-east1 \ + --type=datastore-mode + +POSITIONAL ARGUMENTS + [DATABASE] + 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. + + This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ + with first character a letter and the last a letter or a number. Must + not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. + + Using "(default)" database ID is also allowed. + +REQUIRED FLAGS --location=LOCATION The location to create the Google Cloud Firestore Native database - within. Available databases are listed at + 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/iam/help b/gcloud/alpha/iam/help index 04a5c8537..84bf15426 100644 --- a/gcloud/alpha/iam/help +++ b/gcloud/alpha/iam/help @@ -28,7 +28,7 @@ GROUPS GROUP is one of the following: policies - (ALPHA) Manage IAM policies. + (ALPHA) Manage IAM deny policies. roles (ALPHA) Create and manipulate roles. diff --git a/gcloud/alpha/iam/policies/create b/gcloud/alpha/iam/policies/create index 5902c49a7..f44c10ff9 100644 --- a/gcloud/alpha/iam/policies/create +++ b/gcloud/alpha/iam/policies/create @@ -48,7 +48,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 iam policies create $ gcloud beta iam policies create diff --git a/gcloud/alpha/iam/policies/delete b/gcloud/alpha/iam/policies/delete index 4bc6204e2..7e60a187f 100644 --- a/gcloud/alpha/iam/policies/delete +++ b/gcloud/alpha/iam/policies/delete @@ -48,7 +48,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 iam policies delete $ gcloud beta iam policies delete diff --git a/gcloud/alpha/iam/policies/get b/gcloud/alpha/iam/policies/get index 20d99eec9..4593e39bd 100644 --- a/gcloud/alpha/iam/policies/get +++ b/gcloud/alpha/iam/policies/get @@ -42,7 +42,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 iam policies get $ gcloud beta iam policies get diff --git a/gcloud/alpha/iam/policies/help b/gcloud/alpha/iam/policies/help index 2135db8ed..4fa005eda 100644 --- a/gcloud/alpha/iam/policies/help +++ b/gcloud/alpha/iam/policies/help @@ -1,11 +1,11 @@ NAME - gcloud alpha iam policies - manage IAM policies + gcloud alpha iam policies - manage IAM deny policies SYNOPSIS gcloud alpha iam policies COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Commands for managing Google Cloud IAM policies. + (ALPHA) Commands for managing Google Cloud IAM deny policies. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -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 iam policies $ gcloud beta iam policies diff --git a/gcloud/alpha/iam/policies/list b/gcloud/alpha/iam/policies/list index 004c54c8e..bcc3185d3 100644 --- a/gcloud/alpha/iam/policies/list +++ b/gcloud/alpha/iam/policies/list @@ -70,7 +70,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 iam policies list $ gcloud beta iam policies list diff --git a/gcloud/alpha/iam/policies/update b/gcloud/alpha/iam/policies/update index f02c1186c..fbc9d44df 100644 --- a/gcloud/alpha/iam/policies/update +++ b/gcloud/alpha/iam/policies/update @@ -48,7 +48,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 iam policies update $ gcloud beta iam policies update diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index fc40ab996..cf0765a0f 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -370,7 +370,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/alpha/run/jobs/create b/gcloud/alpha/run/jobs/create index 4a2715f93..d903fa2eb 100644 --- a/gcloud/alpha/run/jobs/create +++ b/gcloud/alpha/run/jobs/create @@ -67,7 +67,8 @@ OPTIONAL FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass for - more information. + more information. Next update or deploy command will automatically + clear existing breakglass justification. --command=[COMMAND,...] Entrypoint for the container image. If not specified, the container diff --git a/gcloud/alpha/run/jobs/deploy b/gcloud/alpha/run/jobs/deploy index 7b7dca8c2..171634e7a 100644 --- a/gcloud/alpha/run/jobs/deploy +++ b/gcloud/alpha/run/jobs/deploy @@ -63,7 +63,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass for - more information. + more information. Next update or deploy command will automatically + clear existing breakglass justification. --command=[COMMAND,...] Entrypoint for the container image. If not specified, the container diff --git a/gcloud/alpha/run/jobs/update b/gcloud/alpha/run/jobs/update index 42f5513a5..3adf730eb 100644 --- a/gcloud/alpha/run/jobs/update +++ b/gcloud/alpha/run/jobs/update @@ -65,7 +65,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass for - more information. + more information. Next update or deploy command will automatically + clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/alpha/run/services/update b/gcloud/alpha/run/services/update index cf045b92d..ae98b2e73 100644 --- a/gcloud/alpha/run/services/update +++ b/gcloud/alpha/run/services/update @@ -205,7 +205,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/alpha/run/services/update-traffic b/gcloud/alpha/run/services/update-traffic index 428d80568..9347ddebd 100644 --- a/gcloud/alpha/run/services/update-traffic +++ b/gcloud/alpha/run/services/update-traffic @@ -82,7 +82,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --platform=PLATFORM; default="managed" Target platform for running commands. Alternatively, set the property diff --git a/gcloud/alpha/scc/notifications/describe b/gcloud/alpha/scc/notifications/describe index ed3daf61c..54b64f9fe 100644 --- a/gcloud/alpha/scc/notifications/describe +++ b/gcloud/alpha/scc/notifications/describe @@ -4,19 +4,33 @@ NAME SYNOPSIS gcloud alpha scc notifications describe NOTIFICATION_CONFIG_ID - [--organization=ORGANIZATION] [GCLOUD_WIDE_FLAG ...] + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Describe a Cloud Security Command Center notification config. EXAMPLES - Describe notification config 'my-config' from organization 123456 + Describe notification config 'my-config' from organization 123 - $ gcloud alpha scc notifications describe my-config \ - --organization=123456 + $ gcloud alpha scc notifications describe notifications describe \ + my-config --organization=123 + $ gcloud alpha scc notifications describe notifications describe \ + organizations/123/notificationConfigs/my-config - $ gcloud alpha scc notifications describe \ - organizations/123456/notificationConfigs/my-config + Describe notification config 'my-config' from folder 456 + + $ gcloud alpha scc notifications describe notifications describe \ + my-config --folder=456 + $ gcloud alpha scc notifications describe notifications describe \ + folders/456/notificationConfigs/my-config + + Describe notification config 'my-config' from project 789 + + $ gcloud alpha scc notifications describe notifications describe \ + my-config --project=789 + $ gcloud alpha scc notifications describe notifications describe \ + projects/789/notificationConfigs/my-config POSITIONAL ARGUMENTS NOTIFICATION_CONFIG_ID @@ -24,10 +38,19 @@ POSITIONAL ARGUMENTS "organizations/123/notificationConfigs/456" or just "456". FLAGS - --organization=ORGANIZATION - The organization where the notification config resides. Formatted as - "organizations/123" or just "123". Required if notificationConfigId - does not contain organization information. + At most one of these can be specified: + + --folder=FOLDER + Folder where the notification config resides. Formatted as + folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the notification config resides. Formatted as + organizations/123 or just 123. + + --project=PROJECT + Project (ID or number) where the notification config resides. + Formatted as projects/789 or just 789. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/transfer/agents/install b/gcloud/alpha/transfer/agents/install index 2fa80b427..2e8ed5bba 100644 --- a/gcloud/alpha/transfer/agents/install +++ b/gcloud/alpha/transfer/agents/install @@ -78,8 +78,9 @@ OPTIONAL FLAGS logs (either /tmp or what you've specified for --logs-directory) and your Google credentials file for agent authentication. - If this flag is not specified, gcloud transfer will mount your entire - filesystem to the agent container. + It is strongly recommended that you use this flag. If this flag isn't + specified, gcloud transfer will mount your entire filesystem to the + agent container and give the agent root access. --proxy=PROXY Specify the HTTP URL and port of a proxy server if you want to use a diff --git a/gcloud/assured/workloads/create b/gcloud/assured/workloads/create index cc2d49142..dbc102ff4 100644 --- a/gcloud/assured/workloads/create +++ b/gcloud/assured/workloads/create @@ -8,7 +8,7 @@ SYNOPSIS --location=LOCATION --organization=ORGANIZATION [--enable-sovereign-controls=ENABLE_SOVEREIGN_CONTROLS] [--external-identifier=EXTERNAL_IDENTIFIER] [--labels=[KEY=VALUE,...]] - [--next-rotation-time=NEXT_ROTATION_TIME] + [--next-rotation-time=NEXT_ROTATION_TIME] [--partner=PARTNER] [--provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT] [--resource-settings=[KEY=VALUE,...]] [--rotation-period=ROTATION_PERIOD] [GCLOUD_WIDE_FLAG ...] @@ -51,7 +51,7 @@ REQUIRED FLAGS The compliance regime of the new Assured Workloads environment. COMPLIANCE_REGIME must be one of: CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, IL4, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, - CA_REGIONS_AND_SUPPORT, ITAR. + CA_REGIONS_AND_SUPPORT, ITAR, ASSURED_WORKLOADS_FOR_PARTNERS. --display-name=DISPLAY_NAME The display name of the new Assured Workloads environment @@ -81,6 +81,11 @@ OPTIONAL FLAGS The next rotation time of the KMS settings of new Assured Workloads environment, for example, 2020-12-30T10:15:30.00Z + --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. + --provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT The parent of the provisioned projects, for example, folders/{FOLDER_ID} diff --git a/gcloud/beta/ai/endpoints/deploy-model b/gcloud/beta/ai/endpoints/deploy-model index bc021ac9d..0d35d1bfc 100644 --- a/gcloud/beta/ai/endpoints/deploy-model +++ b/gcloud/beta/ai/endpoints/deploy-model @@ -67,9 +67,9 @@ OPTIONAL FLAGS selected. type - The type of the accelerator. Choices are 'nvidia-tesla-a100', - 'nvidia-tesla-k80', 'nvidia-tesla-p100', 'nvidia-tesla-p4', - 'nvidia-tesla-t4', 'nvidia-tesla-v100'. + The type of the accelerator. Choices are 'nvidia-a100-80gb', + 'nvidia-tesla-a100', 'nvidia-tesla-k80', 'nvidia-tesla-p100', + 'nvidia-tesla-p4', 'nvidia-tesla-t4', 'nvidia-tesla-v100'. count The number of accelerators to attach to each machine running the diff --git a/gcloud/beta/alloydb/instances/create-secondary b/gcloud/beta/alloydb/instances/create-secondary deleted file mode 100644 index 65d74e54b..000000000 --- a/gcloud/beta/alloydb/instances/create-secondary +++ /dev/null @@ -1,48 +0,0 @@ -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/help b/gcloud/beta/alloydb/instances/help index 5de388116..d7f5ce672 100644 --- a/gcloud/beta/alloydb/instances/help +++ b/gcloud/beta/alloydb/instances/help @@ -20,9 +20,6 @@ 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. diff --git a/gcloud/beta/assured/workloads/create b/gcloud/beta/assured/workloads/create index da0a15d3e..b1a4b8935 100644 --- a/gcloud/beta/assured/workloads/create +++ b/gcloud/beta/assured/workloads/create @@ -8,7 +8,7 @@ SYNOPSIS --location=LOCATION --organization=ORGANIZATION [--enable-sovereign-controls=ENABLE_SOVEREIGN_CONTROLS] [--external-identifier=EXTERNAL_IDENTIFIER] [--labels=[KEY=VALUE,...]] - [--next-rotation-time=NEXT_ROTATION_TIME] + [--next-rotation-time=NEXT_ROTATION_TIME] [--partner=PARTNER] [--provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT] [--resource-settings=[KEY=VALUE,...]] [--rotation-period=ROTATION_PERIOD] [GCLOUD_WIDE_FLAG ...] @@ -51,7 +51,7 @@ REQUIRED FLAGS The compliance regime of the new Assured Workloads environment. COMPLIANCE_REGIME must be one of: CJIS, FEDRAMP_HIGH, FEDRAMP_MODERATE, IL4, US_REGIONAL_ACCESS, HIPAA, HITRUST, EU_REGIONS_AND_SUPPORT, - CA_REGIONS_AND_SUPPORT, ITAR. + CA_REGIONS_AND_SUPPORT, ITAR, ASSURED_WORKLOADS_FOR_PARTNERS. --display-name=DISPLAY_NAME The display name of the new Assured Workloads environment @@ -81,6 +81,11 @@ OPTIONAL FLAGS The next rotation time of the KMS settings of new Assured Workloads environment, for example, 2020-12-30T10:15:30.00Z + --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. + --provisioned-resources-parent=PROVISIONED_RESOURCES_PARENT The parent of the provisioned projects, for example, folders/{FOLDER_ID} diff --git a/gcloud/beta/bigtable/instances/tables/restore b/gcloud/beta/bigtable/instances/tables/restore index 364ce6c92..5abea434b 100644 --- a/gcloud/beta/bigtable/instances/tables/restore +++ b/gcloud/beta/bigtable/instances/tables/restore @@ -11,8 +11,7 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) This command restores a Cloud Bigtable backup to a new table in the - same instance. + (BETA) This command restores a Cloud Bigtable backup to a new table. EXAMPLES To restore table 'table2' from backup 'backup1', run: diff --git a/gcloud/beta/compute/instances/resume b/gcloud/beta/compute/instances/resume index b7eccbe5c..c212ccb61 100644 --- a/gcloud/beta/compute/instances/resume +++ b/gcloud/beta/compute/instances/resume @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud beta compute instances resume INSTANCE_NAMES [INSTANCE_NAMES ...] - [--async] [--csek-key-file=FILE] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] + [--async] [--zone=ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) gcloud beta compute instances resume is used to resume a previously @@ -25,15 +25,6 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --csek-key-file=FILE - Path to a Customer-Supplied Encryption Key (CSEK) key file that maps - Compute Engine resources to user managed keys to be used when creating, - mounting, or taking snapshots of disks. - - If you pass - as value of the flag, the CSEK is read from stdin. See - https://cloud.google.com/compute/docs/disks/customer-supplied-encryption - for more details. - --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/container/clusters/create b/gcloud/beta/container/clusters/create index c1d9f3237..0acf28e1e 100644 --- a/gcloud/beta/container/clusters/create +++ b/gcloud/beta/container/clusters/create @@ -33,7 +33,7 @@ SYNOPSIS [--enable-master-global-access] [--enable-network-policy] [--enable-pod-security-policy] [--enable-service-externalips] [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] - [--enable-vertical-pod-autoscaling] + [--enable-vertical-pod-autoscaling] [--gateway-api=GATEWAY_API] [--identity-provider=IDENTITY_PROVIDER] [--image-type=IMAGE_TYPE] [--ipv6-access-type=IPV6_ACCESS_TYPE] [--issue-client-certificate] [--istio-config=[auth=MTLS_PERMISSIVE,...]] [--labels=[KEY=VALUE,...]] @@ -532,6 +532,19 @@ FLAGS --enable-vertical-pod-autoscaling Enable vertical pod autoscaling for a cluster. + --gateway-api=GATEWAY_API + Enables GKE Gateway controller in this cluster. The value of the flag + specifies which Open Source Gateway API release channel will be used to + define Gateway resources. GATEWAY_API must be one of: + + disabled + Gateway controller will be disabled in the cluster. + + standard + Gateway controller will be enabled in the cluster. Resource + definitions from the standard OSS Gateway API release channel will + be installed. + --identity-provider=IDENTITY_PROVIDER Enable 3P identity provider on the cluster. diff --git a/gcloud/beta/container/clusters/update b/gcloud/beta/container/clusters/update index 4cdc02e2e..242f007e8 100644 --- a/gcloud/beta/container/clusters/update +++ b/gcloud/beta/container/clusters/update @@ -19,7 +19,8 @@ SYNOPSIS | --enable-network-policy | --enable-pod-security-policy | --enable-service-externalips | --enable-shielded-nodes | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling - | --generate-password | --identity-provider=IDENTITY_PROVIDER + | --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,...] @@ -310,6 +311,19 @@ REQUIRED FLAGS --enable-vertical-pod-autoscaling Enable vertical pod autoscaling for a cluster. + --gateway-api=GATEWAY_API + Enables GKE Gateway controller in this cluster. The value of the flag + specifies which Open Source Gateway API release channel will be used + to define Gateway resources. GATEWAY_API must be one of: + + disabled + Gateway controller will be disabled in the cluster. + + standard + Gateway controller will be enabled in the cluster. Resource + definitions from the standard OSS Gateway API release channel + will be installed. + --generate-password Ask the server to generate a secure password and use that as the basic auth password, keeping the existing username. diff --git a/gcloud/beta/container/fleet/memberships/register b/gcloud/beta/container/fleet/memberships/register index 6d3ce956d..ddf70f03a 100644 --- a/gcloud/beta/container/fleet/memberships/register +++ b/gcloud/beta/container/fleet/memberships/register @@ -6,11 +6,11 @@ SYNOPSIS gcloud beta container fleet memberships register MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - (--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE - | [--enable-workload-identity : --has-private-issuer - | --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip] + [--install-connect-agent] [--internal-ip] [--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY] - [GCLOUD_WIDE_FLAG ...] + [--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE + | [--enable-workload-identity : --has-private-issuer + | --public-issuer-url=PUBLIC_ISSUER_URL]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command registers a cluster with the fleet by: @@ -18,103 +18,99 @@ DESCRIPTION 1. Creating a Fleet Membership resource corresponding to the cluster. 2. Adding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet. - 3. Installing the Connect Agent into this cluster. + 3. Installing the Connect agent into this cluster (optional for GKE). A successful registration implies that the cluster is now exclusive to a - single fleet. + single Fleet. If the cluster is already registered to another Fleet, the + registration will not be successful. - For more information about Connect Agent, go to: + To register a GKE cluster, use --gke-cluster or --gke-uri flag (no + --kubeconfig flag is required). Connect agent will not be installed by + default for GKE clusters. To install it, specify --install-connect-agent. + + To register a non-GKE or GKE On-Prem cluster, use --context flag (with an + optional --kubeconfig flag). Connect agent will always be installed for + non-GKE clusters. + + If Connect agent is to be installed, its authentication needs to be + configured by --enable-workload-identity or --service-account-key-file. For + the latter case, the corresponding service account must have been granted + gkehub.connect permissions. For more information about Connect agent, go + to: https://cloud.google.com/anthos/multicluster-management/connect/overview/ - To register a non-GKE or GKE On-Prem cluster use --context flag (with an - optional --kubeconfig flag). - - To register a GKE cluster use --gke-cluster or --gke-uri flag (no - --kubeconfig flag is required). - - In all cases, the Connect Agent that is installed in the target cluster - must authenticate to Google using a --service-account-key-file that - corresponds to a service account that has been granted gkehub.connect - permissions. - - If the cluster is already registered to another fleet, the registration is - not successful. - Rerunning this command against the same cluster with the same - MEMBERSHIP_NAME and target fleet is successful and upgrades the Connect - Agent if a new agent is available. + MEMBERSHIP_NAME and target fleet is successful, and will upgrade the + Connect agent if it is supposed to be installed and a newer version is + avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect Agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json + + Register a GKE cluster referenced from a GKE URI: + + $ gcloud beta container fleet memberships register my-cluster \ + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect - Agent: + agent using service account key file: $ gcloud beta container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE Cluster location and name, and - install the Connect Agent: + Register a GKE cluster first, and install the Connect agent later. $ gcloud beta container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --service-account-key-file=/tmp/keyfile.json - - Register a GKE cluster, and install a specific version of the Connect - Agent: + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud beta container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity + + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud beta container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install - the Connect Agent: + Register a GKE cluster and output a manifest that can be used to install the + Connect agent: $ gcloud beta container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json - - $ gcloud beta container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME @@ -154,7 +150,27 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. - Exactly one of these must be specified: +OPTIONAL FLAGS + --install-connect-agent + If set to True for a GKE cluster, Connect agent will be installed in + the cluster. No-op for Non-GKE clusters, where Connect agent will + always be installed. + + --internal-ip + Whether to use the internal IP address of the cluster endpoint. + + --manifest-output-file=MANIFEST_OUTPUT_FILE + The full path of the file into which the Connect agent installation + manifest should be stored. If this option is provided, then the + manifest will be written to this file and will not be deployed into the + cluster by gcloud, and it will need to be deployed manually. + + --proxy=PROXY + The proxy address in the format of http[s]://{hostname}. The proxy must + support the HTTP CONNECT method in order for this connection to + succeed. + + At most one of these can be specified: --service-account-key-file=SERVICE_ACCOUNT_KEY_FILE The JSON file of a Google Cloud service account private key. This @@ -211,21 +227,6 @@ REQUIRED FLAGS account JWTs are served at a public endpoint different from the cluster API server. Requires --enable-workload-identity. -OPTIONAL FLAGS - --internal-ip - Whether to use the internal IP address of the cluster endpoint. - - --manifest-output-file=MANIFEST_OUTPUT_FILE - The full path of the file into which the Connect Agent installation - manifest should be stored. If this option is provided, then the - manifest will be written to this file and will not be deployed into the - cluster by gcloud, and it will need to be deployed manually. - - --proxy=PROXY - The proxy address in the format of http[s]://{hostname}. The proxy must - support the HTTP CONNECT method in order for this connection to - succeed. - 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/memberships/unregister b/gcloud/beta/container/fleet/memberships/unregister index 8b311d8fe..64998d1d1 100644 --- a/gcloud/beta/container/fleet/memberships/unregister +++ b/gcloud/beta/container/fleet/memberships/unregister @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta container fleet memberships unregister MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - [GCLOUD_WIDE_FLAG ...] + [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command unregisters a cluster with the fleet by: @@ -16,19 +16,19 @@ DESCRIPTION 2. Removing the corresponding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet (a.k.a `kubectl delete memberships membership`). - 3. Uninstalling the Connect Agent from this cluster (a.k.a - `kubectl delete on the gke-connect namespace`). + 3. [Optional for GKE cluster] Uninstalling the Connect agent from this + cluster (a.k.a `kubectl delete on the gke-connect namespace`). The unregister command makes additional internal checks to ensure that all three steps can be safely done to properly clean-up in-Fleet and in-cluster resources. - To register a non-GKE cluster use --context flag (with an optional - --kubeconfig flag). - To register a GKE cluster use --gke-cluster or --gke-uri flag (no --kubeconfig flag is required). + To register a non-GKE cluster use --context flag (with an optional + --kubeconfig`s flag). + To only delete the Fleet Membership resource, consider using the command: gcloud beta container fleet memberships delete. This command is intended to delete stale Fleet Membership resources as doing so on a fully registered @@ -57,6 +57,12 @@ EXAMPLES $ gcloud beta container fleet memberships unregister my-membership \ --gke-cluster=my-cluster-region-or-zone/my-cluster + Unregister a GKE cluster and uninstall Connect agent: + + $ gcloud beta container fleet memberships unregister my-membership \ + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --uninstall-connect-agent + POSITIONAL ARGUMENTS MEMBERSHIP_NAME The membership name that you choose to uniquely represents the cluster @@ -95,6 +101,12 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. +OPTIONAL FLAGS + --uninstall-connect-agent + If set to True for a GKE cluster, Connect agent will be uninstalled + from the cluster. No-op for Non-GKE clusters, where Connect agent will + always be uninstalled. + 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/memberships/register b/gcloud/beta/container/hub/memberships/register index d07d59a84..0e2205f0d 100644 --- a/gcloud/beta/container/hub/memberships/register +++ b/gcloud/beta/container/hub/memberships/register @@ -6,11 +6,11 @@ SYNOPSIS gcloud beta container hub memberships register MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - (--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE - | [--enable-workload-identity : --has-private-issuer - | --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip] + [--install-connect-agent] [--internal-ip] [--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY] - [GCLOUD_WIDE_FLAG ...] + [--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE + | [--enable-workload-identity : --has-private-issuer + | --public-issuer-url=PUBLIC_ISSUER_URL]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command registers a cluster with the fleet by: @@ -18,103 +18,99 @@ DESCRIPTION 1. Creating a Fleet Membership resource corresponding to the cluster. 2. Adding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet. - 3. Installing the Connect Agent into this cluster. + 3. Installing the Connect agent into this cluster (optional for GKE). A successful registration implies that the cluster is now exclusive to a - single fleet. + single Fleet. If the cluster is already registered to another Fleet, the + registration will not be successful. - For more information about Connect Agent, go to: + To register a GKE cluster, use --gke-cluster or --gke-uri flag (no + --kubeconfig flag is required). Connect agent will not be installed by + default for GKE clusters. To install it, specify --install-connect-agent. + + To register a non-GKE or GKE On-Prem cluster, use --context flag (with an + optional --kubeconfig flag). Connect agent will always be installed for + non-GKE clusters. + + If Connect agent is to be installed, its authentication needs to be + configured by --enable-workload-identity or --service-account-key-file. For + the latter case, the corresponding service account must have been granted + gkehub.connect permissions. For more information about Connect agent, go + to: https://cloud.google.com/anthos/multicluster-management/connect/overview/ - To register a non-GKE or GKE On-Prem cluster use --context flag (with an - optional --kubeconfig flag). - - To register a GKE cluster use --gke-cluster or --gke-uri flag (no - --kubeconfig flag is required). - - In all cases, the Connect Agent that is installed in the target cluster - must authenticate to Google using a --service-account-key-file that - corresponds to a service account that has been granted gkehub.connect - permissions. - - If the cluster is already registered to another fleet, the registration is - not successful. - Rerunning this command against the same cluster with the same - MEMBERSHIP_NAME and target fleet is successful and upgrades the Connect - Agent if a new agent is available. + MEMBERSHIP_NAME and target fleet is successful, and will upgrade the + Connect agent if it is supposed to be installed and a newer version is + avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect Agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json + + Register a GKE cluster referenced from a GKE URI: + + $ gcloud beta container hub memberships register my-cluster \ + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect - Agent: + agent using service account key file: $ gcloud beta container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE Cluster location and name, and - install the Connect Agent: + Register a GKE cluster first, and install the Connect agent later. $ gcloud beta container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --service-account-key-file=/tmp/keyfile.json - - Register a GKE cluster, and install a specific version of the Connect - Agent: + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud beta container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity + + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud beta container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install - the Connect Agent: + Register a GKE cluster and output a manifest that can be used to install the + Connect agent: $ gcloud beta container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json - - $ gcloud beta container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME @@ -154,7 +150,27 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. - Exactly one of these must be specified: +OPTIONAL FLAGS + --install-connect-agent + If set to True for a GKE cluster, Connect agent will be installed in + the cluster. No-op for Non-GKE clusters, where Connect agent will + always be installed. + + --internal-ip + Whether to use the internal IP address of the cluster endpoint. + + --manifest-output-file=MANIFEST_OUTPUT_FILE + The full path of the file into which the Connect agent installation + manifest should be stored. If this option is provided, then the + manifest will be written to this file and will not be deployed into the + cluster by gcloud, and it will need to be deployed manually. + + --proxy=PROXY + The proxy address in the format of http[s]://{hostname}. The proxy must + support the HTTP CONNECT method in order for this connection to + succeed. + + At most one of these can be specified: --service-account-key-file=SERVICE_ACCOUNT_KEY_FILE The JSON file of a Google Cloud service account private key. This @@ -211,21 +227,6 @@ REQUIRED FLAGS account JWTs are served at a public endpoint different from the cluster API server. Requires --enable-workload-identity. -OPTIONAL FLAGS - --internal-ip - Whether to use the internal IP address of the cluster endpoint. - - --manifest-output-file=MANIFEST_OUTPUT_FILE - The full path of the file into which the Connect Agent installation - manifest should be stored. If this option is provided, then the - manifest will be written to this file and will not be deployed into the - cluster by gcloud, and it will need to be deployed manually. - - --proxy=PROXY - The proxy address in the format of http[s]://{hostname}. The proxy must - support the HTTP CONNECT method in order for this connection to - succeed. - 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/memberships/unregister b/gcloud/beta/container/hub/memberships/unregister index 4cd938f2f..268ab9451 100644 --- a/gcloud/beta/container/hub/memberships/unregister +++ b/gcloud/beta/container/hub/memberships/unregister @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta container hub memberships unregister MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - [GCLOUD_WIDE_FLAG ...] + [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command unregisters a cluster with the fleet by: @@ -16,19 +16,19 @@ DESCRIPTION 2. Removing the corresponding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet (a.k.a `kubectl delete memberships membership`). - 3. Uninstalling the Connect Agent from this cluster (a.k.a - `kubectl delete on the gke-connect namespace`). + 3. [Optional for GKE cluster] Uninstalling the Connect agent from this + cluster (a.k.a `kubectl delete on the gke-connect namespace`). The unregister command makes additional internal checks to ensure that all three steps can be safely done to properly clean-up in-Fleet and in-cluster resources. - To register a non-GKE cluster use --context flag (with an optional - --kubeconfig flag). - To register a GKE cluster use --gke-cluster or --gke-uri flag (no --kubeconfig flag is required). + To register a non-GKE cluster use --context flag (with an optional + --kubeconfig`s flag). + To only delete the Fleet Membership resource, consider using the command: gcloud beta container hub memberships delete. This command is intended to delete stale Fleet Membership resources as doing so on a fully registered @@ -57,6 +57,12 @@ EXAMPLES $ gcloud beta container hub memberships unregister my-membership \ --gke-cluster=my-cluster-region-or-zone/my-cluster + Unregister a GKE cluster and uninstall Connect agent: + + $ gcloud beta container hub memberships unregister my-membership \ + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --uninstall-connect-agent + POSITIONAL ARGUMENTS MEMBERSHIP_NAME The membership name that you choose to uniquely represents the cluster @@ -95,6 +101,12 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. +OPTIONAL FLAGS + --uninstall-connect-agent + If set to True for a GKE cluster, Connect agent will be uninstalled + from the cluster. No-op for Non-GKE clusters, where Connect agent will + always be uninstalled. + 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/datastream/connection-profiles/create b/gcloud/beta/datastream/connection-profiles/create index da6563018..eb2964dd9 100644 --- a/gcloud/beta/datastream/connection-profiles/create +++ b/gcloud/beta/datastream/connection-profiles/create @@ -14,7 +14,13 @@ SYNOPSIS --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME (--mysql-password=MYSQL_PASSWORD | --mysql-prompt-for-password) : --ca-certificate=CA_CERTIFICATE - --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY]] + --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY] + | --postgresql-database=POSTGRESQL_DATABASE + --postgresql-hostname=POSTGRESQL_HOSTNAME + --postgresql-port=POSTGRESQL_PORT + --postgresql-username=POSTGRESQL_USERNAME + (--postgresql-password=POSTGRESQL_PASSWORD + | --postgresql-prompt-for-password)] [--private-connection-name=PRIVATE_CONNECTION_NAME : --no-connectivity | --static-ip-connectivity | [--forward-ssh-hostname=FORWARD_SSH_HOSTNAME @@ -40,7 +46,7 @@ EXAMPLES --oracle-port=1521 --database-service=ORCL \ --static-ip-connectivity - To create a connection profile for Mysql: + To create a connection profile for MySQL: $ gcloud beta datastream connection-profiles create \ CONNECTION_PROFILE --location=us-central1 --type=mysql \ @@ -88,7 +94,7 @@ REQUIRED FLAGS Friendly name for the connection profile. --type=TYPE - Type can be MYSQL, ORACLE, GOOGLE-CLOUD-STORAGE or BIGQUERY + Type can be MYSQL, ORACLE, POSTGRESQL, GOOGLE-CLOUD-STORAGE or BIGQUERY OPTIONAL FLAGS --labels=[KEY=VALUE,...] @@ -146,13 +152,13 @@ OPTIONAL FLAGS Prompt for the password used to connect to the database. --mysql-hostname=MYSQL_HOSTNAME - IP or hostname of the mysql source database. + IP or hostname of the MySQL source database. This flag argument must be specified if any of the other arguments in this group are specified. --mysql-port=MYSQL_PORT - Network port of the mysql source database. + Network port of the MySQL source database. This flag argument must be specified if any of the other arguments in this group are specified. @@ -195,6 +201,40 @@ OPTIONAL FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --postgresql-database=POSTGRESQL_DATABASE + Database service for the PostgreSQL connection. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-hostname=POSTGRESQL_HOSTNAME + IP or hostname of the PostgreSQL source database. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-port=POSTGRESQL_PORT + Network port of the PostgreSQL source database. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-username=POSTGRESQL_USERNAME + Username Datastream will use to connect to the database. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Exactly one of these must be specified: + + --postgresql-password=POSTGRESQL_PASSWORD + Password for the user that Datastream will be using to connect to + the database. This field is not returned on request, and the value + is encrypted when stored in Datastream. + + --postgresql-prompt-for-password + Prompt for the password used to connect to the database. + At most one of these can be specified: Private connection resource - Resource ID of the private connection. diff --git a/gcloud/beta/datastream/connection-profiles/discover b/gcloud/beta/datastream/connection-profiles/discover index aed5da6c2..fdfc5a7fa 100644 --- a/gcloud/beta/datastream/connection-profiles/discover +++ b/gcloud/beta/datastream/connection-profiles/discover @@ -7,7 +7,8 @@ SYNOPSIS (--connection-profile-name=CONNECTION_PROFILE_NAME : --connection-profile-object-file=CONNECTION_PROFILE_OBJECT_FILE) [--mysql-rdbms-file=MYSQL_RDBMS_FILE - | --oracle-rdbms-file=ORACLE_RDBMS_FILE] + | --oracle-rdbms-file=ORACLE_RDBMS_FILE + | --postgresql-rdbms-file=POSTGRESQL_RDBMS_FILE] [--recursive | --recursive-depth=RECURSIVE_DEPTH] [GCLOUD_WIDE_FLAG ...] @@ -81,10 +82,15 @@ OPTIONAL FLAGS the flag the file content will be read from stdin. --oracle-rdbms-file=ORACLE_RDBMS_FILE - Path to a YAML (or JSON) file containing the ORACLE RDBMS to enrich + Path to a YAML (or JSON) file containing the Oracle RDBMS to enrich with child data objects and metadata. If you pass - as the value of the flag the file content will be read from stdin. + --postgresql-rdbms-file=POSTGRESQL_RDBMS_FILE + Path to a YAML (or JSON) file containing the PostgreSQL RDBMS to + enrich with child data objects and metadata. If you pass - as the + value of the flag the file content will be read from stdin. + At most one of these can be specified: --recursive diff --git a/gcloud/beta/datastream/connection-profiles/update b/gcloud/beta/datastream/connection-profiles/update index 7da1a58ce..2f3f38db6 100644 --- a/gcloud/beta/datastream/connection-profiles/update +++ b/gcloud/beta/datastream/connection-profiles/update @@ -15,7 +15,13 @@ SYNOPSIS --ca-certificate=CA_CERTIFICATE --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY --mysql-password=MYSQL_PASSWORD - | --mysql-prompt-for-password] + | --mysql-prompt-for-password + | --postgresql-database=POSTGRESQL_DATABASE + --postgresql-hostname=POSTGRESQL_HOSTNAME + --postgresql-port=POSTGRESQL_PORT + --postgresql-username=POSTGRESQL_USERNAME + --postgresql-password=POSTGRESQL_PASSWORD + | --postgresql-prompt-for-password] [--clear-labels | --remove-labels=[KEY,...]] [--private-connection-name=PRIVATE_CONNECTION_NAME : --no-connectivity | --static-ip-connectivity @@ -42,7 +48,7 @@ EXAMPLES --oracle-port=1521 --database-service=ORCL \ --static-ip-connectivity - To update a connection profile for Mysql: + To update a connection profile for MySQL: $ gcloud beta datastream connection-profiles update \ CONNECTION_PROFILE --location=us-central1 --type=mysql \ @@ -87,7 +93,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --type=TYPE - Type can be MYSQL, ORACLE, GOOGLE-CLOUD-STORAGE or BIGQUERY + Type can be MYSQL, ORACLE, POSTGRESQL, GOOGLE-CLOUD-STORAGE or BIGQUERY OPTIONAL FLAGS --display-name=DISPLAY_NAME @@ -134,10 +140,10 @@ OPTIONAL FLAGS Prompt for the password used to connect to the database. --mysql-hostname=MYSQL_HOSTNAME - IP or hostname of the mysql source database. + IP or hostname of the MySQL source database. --mysql-port=MYSQL_PORT - Network port of the mysql source database. + Network port of the MySQL source database. --mysql-username=MYSQL_USERNAME Username Datastream will use to connect to the database. @@ -165,6 +171,28 @@ OPTIONAL FLAGS --mysql-prompt-for-password Prompt for the password used to connect to the database. + --postgresql-database=POSTGRESQL_DATABASE + Database service for the PostgreSQL connection. + + --postgresql-hostname=POSTGRESQL_HOSTNAME + IP or hostname of the PostgreSQL source database. + + --postgresql-port=POSTGRESQL_PORT + Network port of the PostgreSQL source database. + + --postgresql-username=POSTGRESQL_USERNAME + Username Datastream will use to connect to the database. + + At most one of these can be specified: + + --postgresql-password=POSTGRESQL_PASSWORD + Password for the user that Datastream will be using to connect to + the database. This field is not returned on request, and the value + is encrypted when stored in Datastream. + + --postgresql-prompt-for-password + Prompt for the password used to connect to the database. + At most one of these can be specified: --clear-labels diff --git a/gcloud/beta/datastream/streams/create b/gcloud/beta/datastream/streams/create index f7360fd8b..9b855c7ca 100644 --- a/gcloud/beta/datastream/streams/create +++ b/gcloud/beta/datastream/streams/create @@ -6,12 +6,14 @@ SYNOPSIS --display-name=DISPLAY_NAME (--backfill-none | --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS - | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS) + | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS + | --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS) (--destination-name=DESTINATION_NAME (--bigquery-destination-config=BIGQUERY_DESTINATION_CONFIG | --gcs-destination-config=GCS_DESTINATION_CONFIG)) (--source-name=SOURCE_NAME (--mysql-source-config=MYSQL_SOURCE_CONFIG - | --oracle-source-config=ORACLE_SOURCE_CONFIG)) + | --oracle-source-config=ORACLE_SOURCE_CONFIG + | --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG)) [--labels=[KEY=VALUE,...]] [--force | --validate-only] [GCLOUD_WIDE_FLAG ...] @@ -88,6 +90,9 @@ REQUIRED FLAGS --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS Oracle data source objects to avoid backfilling. + --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS + PostgreSQL data source objects to avoid backfilling. + This must be specified. Connection profile resource - Resource ID of the destination connection @@ -166,7 +171,7 @@ REQUIRED FLAGS --mysql-source-config=MYSQL_SOURCE_CONFIG Path to a YAML (or JSON) file containing the configuration for - Mysql Source Config. + MySQL Source Config. The JSON file is formatted as follows, with snake_case field naming: @@ -220,6 +225,36 @@ REQUIRED FLAGS } } + --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG + Path to a YAML (or JSON) file containing the configuration for + PostgreSQL Source Config. + + The JSON file is formatted as follows, with snake_case field + naming: + + { + "include_objects": {}, + "exclude_objects": { + "postgresql_schemas": [ + { + "schema": "SAMPLE", + "postgresql_tables": [ + { + "table": "SAMPLE_TABLE", + "postgresql_columns": [ + { + "column": "COL", + } + ] + } + ] + } + ] + }, + "replication_slot": "SAMPLE_REPLICATION_SLOT", + "publication": "SAMPLE_PUBLICATION" + } + OPTIONAL FLAGS --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/beta/datastream/streams/update b/gcloud/beta/datastream/streams/update index fff7f8621..636399752 100644 --- a/gcloud/beta/datastream/streams/update +++ b/gcloud/beta/datastream/streams/update @@ -7,14 +7,17 @@ SYNOPSIS [--update-labels=[KEY=VALUE,...]] [--update-mask=UPDATE_MASK] [--backfill-none | --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS - | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS] + | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS + | --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS] [--clear-labels | --remove-labels=[KEY,...]] [--destination-name=DESTINATION_NAME : --bigquery-destination-config=BIGQUERY_DESTINATION_CONFIG | --gcs-destination-config=GCS_DESTINATION_CONFIG] [--force | --validate-only] [--source-name=SOURCE_NAME : --mysql-source-config=MYSQL_SOURCE_CONFIG - | --oracle-source-config=ORACLE_SOURCE_CONFIG] [GCLOUD_WIDE_FLAG ...] + | --oracle-source-config=ORACLE_SOURCE_CONFIG + | --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) (DEPRECATED) Datastream beta version is deprecated. Please @@ -108,6 +111,9 @@ FLAGS --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS Oracle data source objects to avoid backfilling. + --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS + PostgreSQL data source objects to avoid backfilling. + At most one of these can be specified: --clear-labels @@ -206,7 +212,7 @@ FLAGS At most one of these can be specified: --mysql-source-config=MYSQL_SOURCE_CONFIG - Path to a YAML (or JSON) file containing the configuration for Mysql + Path to a YAML (or JSON) file containing the configuration for MySQL Source Config. The JSON file is formatted as follows, with snake_case field naming: @@ -259,6 +265,34 @@ FLAGS } } + --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG + Path to a YAML (or JSON) file containing the configuration for + PostgreSQL Source Config. + + The JSON file is formatted as follows, with snake_case field naming: + + { + "include_objects": {}, + "exclude_objects": { + "postgresql_schemas": [ + { + "schema": "SAMPLE", + "postgresql_tables": [ + { + "table": "SAMPLE_TABLE", + "postgresql_columns": [ + { + "column": "COL", + } + ] + } + ] + } + ] + }, + "publication": "SAMPLE_PUBLICATION" + } + 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/dns/managed-zones/get-iam-policy b/gcloud/beta/dns/managed-zones/get-iam-policy index 369004a7a..c3a5bc61e 100644 --- a/gcloud/beta/dns/managed-zones/get-iam-policy +++ b/gcloud/beta/dns/managed-zones/get-iam-policy @@ -39,8 +39,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 dns managed-zones get-iam-policy $ gcloud alpha dns managed-zones get-iam-policy diff --git a/gcloud/beta/dns/managed-zones/set-iam-policy b/gcloud/beta/dns/managed-zones/set-iam-policy index a33bd73dd..dc78ea4f6 100644 --- a/gcloud/beta/dns/managed-zones/set-iam-policy +++ b/gcloud/beta/dns/managed-zones/set-iam-policy @@ -45,8 +45,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 dns managed-zones set-iam-policy $ gcloud alpha dns managed-zones set-iam-policy diff --git a/gcloud/beta/filestore/backups/create b/gcloud/beta/filestore/backups/create index 5966f0023..74e743aae 100644 --- a/gcloud/beta/filestore/backups/create +++ b/gcloud/beta/filestore/backups/create @@ -3,9 +3,10 @@ NAME SYNOPSIS gcloud beta filestore backups create BACKUP --file-share=FILE_SHARE - --instance=INSTANCE --instance-zone=INSTANCE_ZONE --region=REGION - [--async] [--description=DESCRIPTION] [--labels=KEY=VALUE] - [GCLOUD_WIDE_FLAG ...] + --instance=INSTANCE --region=REGION + (--instance-location=INSTANCE_LOCATION | --instance-zone=INSTANCE_ZONE) + [--async] [--description=DESCRIPTION] [--kms-key=KMS_KEY] + [--labels=KEY=VALUE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create a Filestore backup of an instance file share. @@ -37,12 +38,17 @@ REQUIRED FLAGS --instance=INSTANCE Share name of the Filestore instance you want to backup. - --instance-zone=INSTANCE_ZONE - Zone of the Filestore instance. - --region=REGION Region (e.g. us-central1) for the backup. + Exactly one of these must be specified: + + --instance-location=INSTANCE_LOCATION + Region of the Filestore instance. + + --instance-zone=INSTANCE_ZONE + Zone of the Filestore instance. + OPTIONAL FLAGS --async Return immediately, without waiting for the operation in progress to @@ -51,6 +57,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description for the backup. Limit: 2048 characters. + --kms-key=KMS_KEY + CMEK for backup in the form of + projects/{}/locations/{}/keyRings/{}/cryptoKeys/{} + --labels=KEY=VALUE List of label KEY=VALUE pairs to add. diff --git a/gcloud/beta/filestore/instances/restore b/gcloud/beta/filestore/instances/restore index ff474a21b..6db675fa7 100644 --- a/gcloud/beta/filestore/instances/restore +++ b/gcloud/beta/filestore/instances/restore @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta filestore instances restore (INSTANCE : --zone=ZONE) --file-share=FILE_SHARE --source-backup=SOURCE_BACKUP --source-backup-region=SOURCE_BACKUP_REGION [--async] - [GCLOUD_WIDE_FLAG ...] + [--location=LOCATION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Restore an existing Filestore instance from an existing backup. @@ -66,6 +66,9 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --location=LOCATION + Location of the Filestore instance to restore this backup to. + 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/iam/help b/gcloud/beta/iam/help index 1e68fc415..c496bea05 100644 --- a/gcloud/beta/iam/help +++ b/gcloud/beta/iam/help @@ -28,7 +28,7 @@ GROUPS GROUP is one of the following: policies - (BETA) Manage IAM policies. + (BETA) Manage IAM deny policies. roles (BETA) Create and manipulate roles. diff --git a/gcloud/beta/iam/policies/create b/gcloud/beta/iam/policies/create index 6886c4448..97b5e85c2 100644 --- a/gcloud/beta/iam/policies/create +++ b/gcloud/beta/iam/policies/create @@ -45,8 +45,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 iam policies create $ gcloud alpha iam policies create diff --git a/gcloud/beta/iam/policies/delete b/gcloud/beta/iam/policies/delete index ea374dbc2..01dd71984 100644 --- a/gcloud/beta/iam/policies/delete +++ b/gcloud/beta/iam/policies/delete @@ -45,8 +45,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 iam policies delete $ gcloud alpha iam policies delete diff --git a/gcloud/beta/iam/policies/get b/gcloud/beta/iam/policies/get index 5d388694e..f6983f629 100644 --- a/gcloud/beta/iam/policies/get +++ b/gcloud/beta/iam/policies/get @@ -39,8 +39,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 iam policies get $ gcloud alpha iam policies get diff --git a/gcloud/beta/iam/policies/help b/gcloud/beta/iam/policies/help index e0f3fddd8..0f8f785a3 100644 --- a/gcloud/beta/iam/policies/help +++ b/gcloud/beta/iam/policies/help @@ -1,11 +1,11 @@ NAME - gcloud beta iam policies - manage IAM policies + gcloud beta iam policies - manage IAM deny policies SYNOPSIS gcloud beta iam policies COMMAND [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) Commands for managing Google Cloud IAM policies. + (BETA) Commands for managing Google Cloud IAM deny policies. GCLOUD WIDE FLAGS These flags are available to all commands: --help. @@ -34,8 +34,10 @@ COMMANDS name. 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 iam policies $ gcloud alpha iam policies diff --git a/gcloud/beta/iam/policies/list b/gcloud/beta/iam/policies/list index db703cbfc..0f7aec127 100644 --- a/gcloud/beta/iam/policies/list +++ b/gcloud/beta/iam/policies/list @@ -67,8 +67,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 iam policies list $ gcloud alpha iam policies list diff --git a/gcloud/beta/iam/policies/update b/gcloud/beta/iam/policies/update index dba0024ae..72a9322f8 100644 --- a/gcloud/beta/iam/policies/update +++ b/gcloud/beta/iam/policies/update @@ -44,8 +44,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 iam policies update $ gcloud alpha iam policies update diff --git a/gcloud/beta/network-management/connectivity-tests/create b/gcloud/beta/network-management/connectivity-tests/create index 7ce7d8dcd..cdf3d2b73 100644 --- a/gcloud/beta/network-management/connectivity-tests/create +++ b/gcloud/beta/network-management/connectivity-tests/create @@ -9,6 +9,7 @@ SYNOPSIS --destination-instance=DESTINATION_INSTANCE --destination-ip-address=DESTINATION_IP_ADDRESS) (--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 @@ -75,6 +76,9 @@ REQUIRED FLAGS --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/beta/network-management/connectivity-tests/update b/gcloud/beta/network-management/connectivity-tests/update index bb73b8899..8e0c0f7d6 100644 --- a/gcloud/beta/network-management/connectivity-tests/update +++ b/gcloud/beta/network-management/connectivity-tests/update @@ -22,6 +22,8 @@ SYNOPSIS | --destination-ip-address=DESTINATION_IP_ADDRESS] [--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 @@ -145,6 +147,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/beta/run/deploy b/gcloud/beta/run/deploy index 21f3ac5f5..765f77b7d 100644 --- a/gcloud/beta/run/deploy +++ b/gcloud/beta/run/deploy @@ -370,7 +370,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/beta/run/jobs/create b/gcloud/beta/run/jobs/create index 2d63e0069..2ad0cdf6d 100644 --- a/gcloud/beta/run/jobs/create +++ b/gcloud/beta/run/jobs/create @@ -66,7 +66,8 @@ OPTIONAL FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass for - more information. + more information. Next update or deploy command will automatically + clear existing breakglass justification. --command=[COMMAND,...] Entrypoint for the container image. If not specified, the container diff --git a/gcloud/beta/run/jobs/update b/gcloud/beta/run/jobs/update index ac916e5fe..d262db6c2 100644 --- a/gcloud/beta/run/jobs/update +++ b/gcloud/beta/run/jobs/update @@ -65,7 +65,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass for - more information. + more information. Next update or deploy command will automatically + clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/beta/run/services/update b/gcloud/beta/run/services/update index e0fec3130..b8ad740ef 100644 --- a/gcloud/beta/run/services/update +++ b/gcloud/beta/run/services/update @@ -205,7 +205,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/beta/scc/notifications/describe b/gcloud/beta/scc/notifications/describe index 611f39cc3..0fc3a1a0e 100644 --- a/gcloud/beta/scc/notifications/describe +++ b/gcloud/beta/scc/notifications/describe @@ -4,19 +4,33 @@ NAME SYNOPSIS gcloud beta scc notifications describe NOTIFICATION_CONFIG_ID - [--organization=ORGANIZATION] [GCLOUD_WIDE_FLAG ...] + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Describe a Cloud Security Command Center notification config. EXAMPLES - Describe notification config 'my-config' from organization 123456 + Describe notification config 'my-config' from organization 123 - $ gcloud beta scc notifications describe my-config \ - --organization=123456 + $ gcloud beta scc notifications describe notifications describe \ + my-config --organization=123 + $ gcloud beta scc notifications describe notifications describe \ + organizations/123/notificationConfigs/my-config - $ gcloud beta scc notifications describe \ - organizations/123456/notificationConfigs/my-config + Describe notification config 'my-config' from folder 456 + + $ gcloud beta scc notifications describe notifications describe \ + my-config --folder=456 + $ gcloud beta scc notifications describe notifications describe \ + folders/456/notificationConfigs/my-config + + Describe notification config 'my-config' from project 789 + + $ gcloud beta scc notifications describe notifications describe \ + my-config --project=789 + $ gcloud beta scc notifications describe notifications describe \ + projects/789/notificationConfigs/my-config POSITIONAL ARGUMENTS NOTIFICATION_CONFIG_ID @@ -24,10 +38,19 @@ POSITIONAL ARGUMENTS "organizations/123/notificationConfigs/456" or just "456". FLAGS - --organization=ORGANIZATION - The organization where the notification config resides. Formatted as - "organizations/123" or just "123". Required if notificationConfigId - does not contain organization information. + At most one of these can be specified: + + --folder=FOLDER + Folder where the notification config resides. Formatted as + folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the notification config resides. Formatted as + organizations/123 or just 123. + + --project=PROJECT + Project (ID or number) where the notification config resides. + Formatted as projects/789 or just 789. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/sql/instances/create b/gcloud/beta/sql/instances/create index 7e5636e35..208447b7a 100644 --- a/gcloud/beta/sql/instances/create +++ b/gcloud/beta/sql/instances/create @@ -13,7 +13,8 @@ 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] @@ -166,6 +167,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 diff --git a/gcloud/beta/sql/instances/patch b/gcloud/beta/sql/instances/patch index 5c5db4229..0ce33a1a0 100644 --- a/gcloud/beta/sql/instances/patch +++ b/gcloud/beta/sql/instances/patch @@ -11,8 +11,8 @@ 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] @@ -116,6 +116,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 diff --git a/gcloud/bigtable/instances/tables/restore b/gcloud/bigtable/instances/tables/restore index 3fa3a73eb..78ddf9998 100644 --- a/gcloud/bigtable/instances/tables/restore +++ b/gcloud/bigtable/instances/tables/restore @@ -11,8 +11,7 @@ SYNOPSIS [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - This command restores a Cloud Bigtable backup to a new table in the same - instance. + This command restores a Cloud Bigtable backup to a new table. EXAMPLES To restore table 'table2' from backup 'backup1', run: diff --git a/gcloud/compute/forwarding-rules/create b/gcloud/compute/forwarding-rules/create index 0a06eff06..db7bfbbef 100644 --- a/gcloud/compute/forwarding-rules/create +++ b/gcloud/compute/forwarding-rules/create @@ -33,6 +33,8 @@ SYNOPSIS | --target-http-proxy-region=TARGET_HTTP_PROXY_REGION] [--global-target-https-proxy | --target-https-proxy-region=TARGET_HTTPS_PROXY_REGION] + [--global-target-tcp-proxy + | --target-tcp-proxy-region=TARGET_TCP_PROXY_REGION] [--port-range=[PORT | START_PORT-END_PORT] | --ports=ALL | [PORT | START_PORT-END_PORT],[...]] [GCLOUD_WIDE_FLAG ...] @@ -213,7 +215,7 @@ OPTIONAL FLAGS Internal load balancing or forwarding, used with --backend-service. INTERNAL_MANAGED Internal load balancing, used with --target-http-proxy, - --target-https-proxy. + --target-https-proxy, --target-tcp-proxy. INTERNAL_SELF_MANAGED Traffic Director load balancing or forwarding, used with --target-http-proxy, --target-https-proxy, --target-grpc-proxy, @@ -434,6 +436,31 @@ OPTIONAL FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + At most one of these can be specified: + + --global-target-tcp-proxy + If set, the tcp proxy is global. + + --target-tcp-proxy-region=TARGET_TCP_PROXY_REGION + Region of the tcp proxy to operate on. 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. + At most one of these can be specified: --port-range=[PORT | START_PORT-END_PORT] diff --git a/gcloud/compute/forwarding-rules/set-target b/gcloud/compute/forwarding-rules/set-target index b874074ab..117d1ed9f 100644 --- a/gcloud/compute/forwarding-rules/set-target +++ b/gcloud/compute/forwarding-rules/set-target @@ -23,6 +23,8 @@ SYNOPSIS | --target-http-proxy-region=TARGET_HTTP_PROXY_REGION] [--global-target-https-proxy | --target-https-proxy-region=TARGET_HTTPS_PROXY_REGION] + [--global-target-tcp-proxy + | --target-tcp-proxy-region=TARGET_TCP_PROXY_REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -147,7 +149,7 @@ OPTIONAL FLAGS Internal load balancing or forwarding, used with --backend-service. INTERNAL_MANAGED Internal load balancing, used with --target-http-proxy, - --target-https-proxy. + --target-https-proxy, --target-tcp-proxy. INTERNAL_SELF_MANAGED Traffic Director load balancing or forwarding, used with --target-http-proxy, --target-https-proxy, --target-grpc-proxy, @@ -284,6 +286,31 @@ OPTIONAL FLAGS Alternatively, the region can be stored in the environment variable CLOUDSDK_COMPUTE_REGION. + At most one of these can be specified: + + --global-target-tcp-proxy + If set, the tcp proxy is global. + + --target-tcp-proxy-region=TARGET_TCP_PROXY_REGION + Region of the tcp proxy to operate on. 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. + 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/compute/instances/create b/gcloud/compute/instances/create index 5f6058919..7ea03b839 100644 --- a/gcloud/compute/instances/create +++ b/gcloud/compute/instances/create @@ -15,7 +15,8 @@ SYNOPSIS [--disk=[auto-delete=AUTO-DELETE],[boot=BOOT], [device-name=DEVICE-NAME],[mode=MODE],[name=NAME],[scope=SCOPE]] [--enable-display-device] [--[no-]enable-nested-virtualization] - [--[no-]enable-uefi-networking] [--hostname=HOSTNAME] + [--[no-]enable-uefi-networking] [--erase-windows-vss-signature] + [--hostname=HOSTNAME] [--instance-termination-action=INSTANCE_TERMINATION_ACTION] [--ipv6-network-tier=IPV6_NETWORK_TIER] [--ipv6-public-ptr-domain=IPV6_PUBLIC_PTR_DOMAIN] @@ -37,7 +38,9 @@ SYNOPSIS [--resource-policies=[RESOURCE_POLICY,...]] [--no-restart-on-failure] [--shielded-integrity-monitoring] [--shielded-secure-boot] [--shielded-vtpm] [--source-instance-template=SOURCE_INSTANCE_TEMPLATE] - [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] + [--source-machine-image=SOURCE_MACHINE_IMAGE] + [--source-machine-image-csek-key-file=FILE] [--stack-type=STACK_TYPE] + [--subnet=SUBNET] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] [--visible-core-count=VISIBLE_CORE_COUNT] [--zone=ZONE] [--address=ADDRESS | --no-address] @@ -391,6 +394,11 @@ FLAGS --enable-uefi-networking to enable and --no-enable-uefi-networking to disable. + --erase-windows-vss-signature + Specifies whether the disk restored from source snapshots or source + machine image should erase Windows specific VSS signature. See + https://cloud.google.com/sdk/gcloud/reference/compute/disks/snapshot#--guest-flush + --hostname=HOSTNAME Specify the hostname of the instance to be created. The specified hostname must be RFC1035 compliant. If hostname is not specified, the @@ -717,6 +725,16 @@ FLAGS Users can also override machine type and labels. Values of other flags will be ignored and --source-instance-template will be used instead. + --source-machine-image=SOURCE_MACHINE_IMAGE + The name of the machine image that the instance will be created from. + + --source-machine-image-csek-key-file=FILE + Path to a Customer-Supplied Encryption Key (CSEK) key file, mapping + resources to user managed keys which were used to encrypt the source + machine-image. See + https://cloud.google.com/compute/docs/disks/customer-supplied-encryption + for more details. + --stack-type=STACK_TYPE Specifies whether IPv6 is enabled on the default network interface. If not specified, IPV4_ONLY will be used. STACK_TYPE must be one of: diff --git a/gcloud/compute/target-tcp-proxies/create b/gcloud/compute/target-tcp-proxies/create index 83d4ea0e2..a98096971 100644 --- a/gcloud/compute/target-tcp-proxies/create +++ b/gcloud/compute/target-tcp-proxies/create @@ -5,6 +5,8 @@ SYNOPSIS gcloud compute target-tcp-proxies create NAME --backend-service=BACKEND_SERVICE [--description=DESCRIPTION] [--[no-]proxy-bind] [--proxy-header=PROXY_HEADER; default="NONE"] + [--backend-service-region=BACKEND_SERVICE_REGION + | --global-backend-service] [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -50,6 +52,41 @@ OPTIONAL FLAGS Enables PROXY protocol (version 1) for passing client connection information. + At most one of these can be specified: + + --backend-service-region=BACKEND_SERVICE_REGION + Region of the backend service to operate on. If not specified it will + be set to the region of the TCP Proxy. Overrides the default + compute/region property value for this command invocation. + + --global-backend-service + If set, the backend service is global. + + At most one of these can be specified: + + --global + If set, the target TCP proxy is global. + + --region=REGION + Region of the target TCP proxy to create. 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. + 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/compute/target-tcp-proxies/delete b/gcloud/compute/target-tcp-proxies/delete index e9eea8c31..3d4df9267 100644 --- a/gcloud/compute/target-tcp-proxies/delete +++ b/gcloud/compute/target-tcp-proxies/delete @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud compute target-tcp-proxies delete NAME [NAME ...] - [GCLOUD_WIDE_FLAG ...] + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute target-tcp-proxies delete deletes one or more target TCP @@ -13,6 +13,32 @@ POSITIONAL ARGUMENTS NAME [NAME ...] Names of the target TCP proxies to delete. +FLAGS + At most one of these can be specified: + + --global + If set, the target TCP proxies are global. + + --region=REGION + Region of the target TCP proxies to delete. 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. + 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/compute/target-tcp-proxies/describe b/gcloud/compute/target-tcp-proxies/describe index 08f512a3f..27ce411d8 100644 --- a/gcloud/compute/target-tcp-proxies/describe +++ b/gcloud/compute/target-tcp-proxies/describe @@ -3,7 +3,8 @@ NAME about a target TCP proxy SYNOPSIS - gcloud compute target-tcp-proxies describe NAME [GCLOUD_WIDE_FLAG ...] + gcloud compute target-tcp-proxies describe NAME + [--global | --region=REGION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute target-tcp-proxies describe displays all data associated @@ -13,6 +14,32 @@ POSITIONAL ARGUMENTS NAME Name of the target TCP proxy to describe. +FLAGS + At most one of these can be specified: + + --global + If set, the target TCP proxy is global. + + --region=REGION + Region of the target TCP proxy to describe. 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. + 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/compute/target-tcp-proxies/list b/gcloud/compute/target-tcp-proxies/list index 21340b136..36eeec08e 100644 --- a/gcloud/compute/target-tcp-proxies/list +++ b/gcloud/compute/target-tcp-proxies/list @@ -3,9 +3,10 @@ NAME TCP proxies SYNOPSIS - gcloud compute target-tcp-proxies list [--filter=EXPRESSION] - [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + gcloud compute target-tcp-proxies list [NAME ...] + [--regexp=REGEXP, -r REGEXP] [--global | --regions=[REGION,...]] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute target-tcp-proxies list displays all Google Compute Engine @@ -20,6 +21,31 @@ EXAMPLES $ gcloud compute target-tcp-proxies list --uri +POSITIONAL ARGUMENTS + [NAME ...] + (DEPRECATED) If provided, show details for the specified names and/or + URIs of resources. + + Argument NAME is deprecated. Use --filter="name=( 'NAME' ... )" + instead. + +FLAGS + --regexp=REGEXP, -r REGEXP + (DEPRECATED) Regular expression to filter the names of the results on. + Any names that do not match the entire regular expression will be + filtered out. + + Flag --regexp is deprecated. Use --filter="name~'REGEXP'" instead. + + At most one of these can be specified: + + --global + If provided, only global resources are shown. + + --regions=[REGION,...] + If provided, only regional resources are shown. If arguments are + provided, only resources from the given regions are shown. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/container/clusters/create b/gcloud/container/clusters/create index 0764a93ba..4b56be5a3 100644 --- a/gcloud/container/clusters/create +++ b/gcloud/container/clusters/create @@ -29,10 +29,10 @@ SYNOPSIS [--enable-legacy-authorization] [--enable-master-global-access] [--enable-network-policy] [--enable-service-externalips] [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] - [--enable-vertical-pod-autoscaling] [--image-type=IMAGE_TYPE] - [--issue-client-certificate] [--labels=[KEY=VALUE,...]] - [--local-ssd-count=LOCAL_SSD_COUNT] [--logging=[COMPONENT,...]] - [--logging-variant=LOGGING_VARIANT] + [--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] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-nodes-per-pool=MAX_NODES_PER_POOL] [--max-pods-per-node=MAX_PODS_PER_NODE] @@ -492,6 +492,19 @@ FLAGS --enable-vertical-pod-autoscaling Enable vertical pod autoscaling for a cluster. + --gateway-api=GATEWAY_API + Enables GKE Gateway controller in this cluster. The value of the flag + specifies which Open Source Gateway API release channel will be used to + define Gateway resources. GATEWAY_API must be one of: + + disabled + Gateway controller will be disabled in the cluster. + + standard + Gateway controller will be enabled in the cluster. Resource + definitions from the standard OSS Gateway API release channel will + be installed. + --image-type=IMAGE_TYPE The image type to use for the cluster. Defaults to server-specified. diff --git a/gcloud/container/clusters/update b/gcloud/container/clusters/update index 3a9826f0d..ed54dfe5e 100644 --- a/gcloud/container/clusters/update +++ b/gcloud/container/clusters/update @@ -16,9 +16,9 @@ SYNOPSIS | --enable-master-authorized-networks | --enable-master-global-access | --enable-network-policy | --enable-service-externalips | --enable-shielded-nodes | --enable-stackdriver-kubernetes - | --enable-vertical-pod-autoscaling | --generate-password - | --logging-variant=LOGGING_VARIANT | --maintenance-window=START_TIME - | --node-locations=ZONE,[ZONE,...] + | --enable-vertical-pod-autoscaling | --gateway-api=GATEWAY_API + | --generate-password | --logging-variant=LOGGING_VARIANT + | --maintenance-window=START_TIME | --node-locations=ZONE,[ZONE,...] | --notification-config=[pubsub=ENABLED|DISABLED, pubsub-topic=TOPIC,...] | --private-ipv6-google-access-type=PRIVATE_IPV6_GOOGLE_ACCESS_TYPE @@ -272,6 +272,19 @@ REQUIRED FLAGS --enable-vertical-pod-autoscaling Enable vertical pod autoscaling for a cluster. + --gateway-api=GATEWAY_API + Enables GKE Gateway controller in this cluster. The value of the flag + specifies which Open Source Gateway API release channel will be used + to define Gateway resources. GATEWAY_API must be one of: + + disabled + Gateway controller will be disabled in the cluster. + + standard + Gateway controller will be enabled in the cluster. Resource + definitions from the standard OSS Gateway API release channel + will be installed. + --generate-password Ask the server to generate a secure password and use that as the basic auth password, keeping the existing username. diff --git a/gcloud/container/fleet/memberships/register b/gcloud/container/fleet/memberships/register index e5fe7391a..cf9ae5ae6 100644 --- a/gcloud/container/fleet/memberships/register +++ b/gcloud/container/fleet/memberships/register @@ -6,11 +6,11 @@ SYNOPSIS gcloud container fleet memberships register MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - (--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE - | [--enable-workload-identity : --has-private-issuer - | --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip] + [--install-connect-agent] [--internal-ip] [--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY] - [GCLOUD_WIDE_FLAG ...] + [--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE + | [--enable-workload-identity : --has-private-issuer + | --public-issuer-url=PUBLIC_ISSUER_URL]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command registers a cluster with the fleet by: @@ -18,103 +18,99 @@ DESCRIPTION 1. Creating a Fleet Membership resource corresponding to the cluster. 2. Adding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet. - 3. Installing the Connect Agent into this cluster. + 3. Installing the Connect agent into this cluster (optional for GKE). A successful registration implies that the cluster is now exclusive to a - single fleet. + single Fleet. If the cluster is already registered to another Fleet, the + registration will not be successful. - For more information about Connect Agent, go to: + To register a GKE cluster, use --gke-cluster or --gke-uri flag (no + --kubeconfig flag is required). Connect agent will not be installed by + default for GKE clusters. To install it, specify --install-connect-agent. + + To register a non-GKE or GKE On-Prem cluster, use --context flag (with an + optional --kubeconfig flag). Connect agent will always be installed for + non-GKE clusters. + + If Connect agent is to be installed, its authentication needs to be + configured by --enable-workload-identity or --service-account-key-file. For + the latter case, the corresponding service account must have been granted + gkehub.connect permissions. For more information about Connect agent, go + to: https://cloud.google.com/anthos/multicluster-management/connect/overview/ - To register a non-GKE or GKE On-Prem cluster use --context flag (with an - optional --kubeconfig flag). - - To register a GKE cluster use --gke-cluster or --gke-uri flag (no - --kubeconfig flag is required). - - In all cases, the Connect Agent that is installed in the target cluster - must authenticate to Google using a --service-account-key-file that - corresponds to a service account that has been granted gkehub.connect - permissions. - - If the cluster is already registered to another fleet, the registration is - not successful. - Rerunning this command against the same cluster with the same - MEMBERSHIP_NAME and target fleet is successful and upgrades the Connect - Agent if a new agent is available. + MEMBERSHIP_NAME and target fleet is successful, and will upgrade the + Connect agent if it is supposed to be installed and a newer version is + avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect Agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud container fleet memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json + + Register a GKE cluster referenced from a GKE URI: + + $ gcloud container fleet memberships register my-cluster \ + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect - Agent: + agent using service account key file: $ gcloud container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE Cluster location and name, and - install the Connect Agent: + Register a GKE cluster first, and install the Connect agent later. $ gcloud container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --service-account-key-file=/tmp/keyfile.json - - Register a GKE cluster, and install a specific version of the Connect - Agent: + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity + + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install - the Connect Agent: + Register a GKE cluster and output a manifest that can be used to install the + Connect agent: $ gcloud container fleet memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json - - $ gcloud container fleet memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME @@ -154,7 +150,27 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. - Exactly one of these must be specified: +OPTIONAL FLAGS + --install-connect-agent + If set to True for a GKE cluster, Connect agent will be installed in + the cluster. No-op for Non-GKE clusters, where Connect agent will + always be installed. + + --internal-ip + Whether to use the internal IP address of the cluster endpoint. + + --manifest-output-file=MANIFEST_OUTPUT_FILE + The full path of the file into which the Connect agent installation + manifest should be stored. If this option is provided, then the + manifest will be written to this file and will not be deployed into the + cluster by gcloud, and it will need to be deployed manually. + + --proxy=PROXY + The proxy address in the format of http[s]://{hostname}. The proxy must + support the HTTP CONNECT method in order for this connection to + succeed. + + At most one of these can be specified: --service-account-key-file=SERVICE_ACCOUNT_KEY_FILE The JSON file of a Google Cloud service account private key. This @@ -211,21 +227,6 @@ REQUIRED FLAGS account JWTs are served at a public endpoint different from the cluster API server. Requires --enable-workload-identity. -OPTIONAL FLAGS - --internal-ip - Whether to use the internal IP address of the cluster endpoint. - - --manifest-output-file=MANIFEST_OUTPUT_FILE - The full path of the file into which the Connect Agent installation - manifest should be stored. If this option is provided, then the - manifest will be written to this file and will not be deployed into the - cluster by gcloud, and it will need to be deployed manually. - - --proxy=PROXY - The proxy address in the format of http[s]://{hostname}. The proxy must - support the HTTP CONNECT method in order for this connection to - succeed. - 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/fleet/memberships/unregister b/gcloud/container/fleet/memberships/unregister index 76549b0fe..8dc22e54f 100644 --- a/gcloud/container/fleet/memberships/unregister +++ b/gcloud/container/fleet/memberships/unregister @@ -6,7 +6,7 @@ SYNOPSIS gcloud container fleet memberships unregister MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - [GCLOUD_WIDE_FLAG ...] + [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command unregisters a cluster with the fleet by: @@ -16,19 +16,19 @@ DESCRIPTION 2. Removing the corresponding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet (a.k.a `kubectl delete memberships membership`). - 3. Uninstalling the Connect Agent from this cluster (a.k.a - `kubectl delete on the gke-connect namespace`). + 3. [Optional for GKE cluster] Uninstalling the Connect agent from this + cluster (a.k.a `kubectl delete on the gke-connect namespace`). The unregister command makes additional internal checks to ensure that all three steps can be safely done to properly clean-up in-Fleet and in-cluster resources. - To register a non-GKE cluster use --context flag (with an optional - --kubeconfig flag). - To register a GKE cluster use --gke-cluster or --gke-uri flag (no --kubeconfig flag is required). + To register a non-GKE cluster use --context flag (with an optional + --kubeconfig`s flag). + To only delete the Fleet Membership resource, consider using the command: gcloud container fleet memberships delete. This command is intended to delete stale Fleet Membership resources as doing so on a fully registered @@ -57,6 +57,12 @@ EXAMPLES $ gcloud container fleet memberships unregister my-membership \ --gke-cluster=my-cluster-region-or-zone/my-cluster + Unregister a GKE cluster and uninstall Connect agent: + + $ gcloud container fleet memberships unregister my-membership \ + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --uninstall-connect-agent + POSITIONAL ARGUMENTS MEMBERSHIP_NAME The membership name that you choose to uniquely represents the cluster @@ -95,6 +101,12 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. +OPTIONAL FLAGS + --uninstall-connect-agent + If set to True for a GKE cluster, Connect agent will be uninstalled + from the cluster. No-op for Non-GKE clusters, where Connect agent will + always be uninstalled. + 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/hub/memberships/register b/gcloud/container/hub/memberships/register index a9d4ec97e..4a86da69f 100644 --- a/gcloud/container/hub/memberships/register +++ b/gcloud/container/hub/memberships/register @@ -5,11 +5,11 @@ SYNOPSIS gcloud container hub memberships register MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - (--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE - | [--enable-workload-identity : --has-private-issuer - | --public-issuer-url=PUBLIC_ISSUER_URL]) [--internal-ip] + [--install-connect-agent] [--internal-ip] [--manifest-output-file=MANIFEST_OUTPUT_FILE] [--proxy=PROXY] - [GCLOUD_WIDE_FLAG ...] + [--service-account-key-file=SERVICE_ACCOUNT_KEY_FILE + | [--enable-workload-identity : --has-private-issuer + | --public-issuer-url=PUBLIC_ISSUER_URL]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command registers a cluster with the fleet by: @@ -17,103 +17,99 @@ DESCRIPTION 1. Creating a Fleet Membership resource corresponding to the cluster. 2. Adding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet. - 3. Installing the Connect Agent into this cluster. + 3. Installing the Connect agent into this cluster (optional for GKE). A successful registration implies that the cluster is now exclusive to a - single fleet. + single Fleet. If the cluster is already registered to another Fleet, the + registration will not be successful. - For more information about Connect Agent, go to: + To register a GKE cluster, use --gke-cluster or --gke-uri flag (no + --kubeconfig flag is required). Connect agent will not be installed by + default for GKE clusters. To install it, specify --install-connect-agent. + + To register a non-GKE or GKE On-Prem cluster, use --context flag (with an + optional --kubeconfig flag). Connect agent will always be installed for + non-GKE clusters. + + If Connect agent is to be installed, its authentication needs to be + configured by --enable-workload-identity or --service-account-key-file. For + the latter case, the corresponding service account must have been granted + gkehub.connect permissions. For more information about Connect agent, go + to: https://cloud.google.com/anthos/multicluster-management/connect/overview/ - To register a non-GKE or GKE On-Prem cluster use --context flag (with an - optional --kubeconfig flag). - - To register a GKE cluster use --gke-cluster or --gke-uri flag (no - --kubeconfig flag is required). - - In all cases, the Connect Agent that is installed in the target cluster - must authenticate to Google using a --service-account-key-file that - corresponds to a service account that has been granted gkehub.connect - permissions. - - If the cluster is already registered to another fleet, the registration is - not successful. - Rerunning this command against the same cluster with the same - MEMBERSHIP_NAME and target fleet is successful and upgrades the Connect - Agent if a new agent is available. + MEMBERSHIP_NAME and target fleet is successful, and will upgrade the + Connect agent if it is supposed to be installed and a newer version is + avaible. EXAMPLES - Register a non-GKE or GKE On-Prem cluster referenced from a specific - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from a specific kubeconfig file, and install the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --kubeconfig=/home/user/custom_kubeconfig \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --kubeconfig=/home/user/custom_kubeconfig \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster referenced from the default - kubeconfig file, and install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster referenced from the default + kubeconfig file, and install the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster, and install a specific version - of the Connect Agent: + Register a non-GKE or GKE On-Prem cluster, and install a specific version + of the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a non-GKE or GKE On-Prem cluster and output a manifest that can be - used to install the Connect Agent: + Register a non-GKE or GKE On-Prem cluster and output a manifest that can be + used to install the Connect agent: $ gcloud container hub memberships register my-cluster \ - --context=my-cluster-context \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --context=my-cluster-context \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json + + Register a GKE cluster referenced from a GKE URI: + + $ gcloud container hub memberships register my-cluster \ + --gke-uri=my-cluster-gke-uri Register a GKE cluster referenced from a GKE URI, and install the Connect - Agent: + agent using service account key file: $ gcloud container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster referenced from a GKE Cluster location and name, and - install the Connect Agent: + Register a GKE cluster first, and install the Connect agent later. $ gcloud container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --service-account-key-file=/tmp/keyfile.json - - Register a GKE cluster, and install a specific version of the Connect - Agent: + --gke-cluster=my-cluster-region-or-zone/my-cluster $ gcloud container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --enable-workload-identity + + Register a GKE cluster, and install a specific version of the Connect + agent: $ gcloud container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --version=gkeconnect_20190802_02_00 \ - --service-account-key-file=/tmp/keyfile.json + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --install-connect-agent --version=gkeconnect_20190802_02_00 \ + --service-account-key-file=/tmp/keyfile.json - Register a GKE cluster and output a manifest that can be used to install - the Connect Agent: + Register a GKE cluster and output a manifest that can be used to install the + Connect agent: $ gcloud container hub memberships register my-cluster \ - --gke-uri=my-cluster-gke-uri \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json - - $ gcloud container hub memberships register my-cluster \ - --gke-cluster=my-cluster-region-or-zone/my-cluster \ - --manifest-output-file=/tmp/manifest.yaml \ - --service-account-key-file=/tmp/keyfile.json + --gke-uri=my-cluster-gke-uri --install-connect-agent \ + --manifest-output-file=/tmp/manifest.yaml \ + --service-account-key-file=/tmp/keyfile.json POSITIONAL ARGUMENTS MEMBERSHIP_NAME @@ -153,7 +149,27 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. - Exactly one of these must be specified: +OPTIONAL FLAGS + --install-connect-agent + If set to True for a GKE cluster, Connect agent will be installed in + the cluster. No-op for Non-GKE clusters, where Connect agent will + always be installed. + + --internal-ip + Whether to use the internal IP address of the cluster endpoint. + + --manifest-output-file=MANIFEST_OUTPUT_FILE + The full path of the file into which the Connect agent installation + manifest should be stored. If this option is provided, then the + manifest will be written to this file and will not be deployed into the + cluster by gcloud, and it will need to be deployed manually. + + --proxy=PROXY + The proxy address in the format of http[s]://{hostname}. The proxy must + support the HTTP CONNECT method in order for this connection to + succeed. + + At most one of these can be specified: --service-account-key-file=SERVICE_ACCOUNT_KEY_FILE The JSON file of a Google Cloud service account private key. This @@ -210,21 +226,6 @@ REQUIRED FLAGS account JWTs are served at a public endpoint different from the cluster API server. Requires --enable-workload-identity. -OPTIONAL FLAGS - --internal-ip - Whether to use the internal IP address of the cluster endpoint. - - --manifest-output-file=MANIFEST_OUTPUT_FILE - The full path of the file into which the Connect Agent installation - manifest should be stored. If this option is provided, then the - manifest will be written to this file and will not be deployed into the - cluster by gcloud, and it will need to be deployed manually. - - --proxy=PROXY - The proxy address in the format of http[s]://{hostname}. The proxy must - support the HTTP CONNECT method in order for this connection to - succeed. - 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/hub/memberships/unregister b/gcloud/container/hub/memberships/unregister index d9b25e693..3f9c58c78 100644 --- a/gcloud/container/hub/memberships/unregister +++ b/gcloud/container/hub/memberships/unregister @@ -6,7 +6,7 @@ SYNOPSIS gcloud container hub memberships unregister MEMBERSHIP_NAME (--gke-cluster=LOCATION/CLUSTER_NAME | --gke-uri=GKE_URI | [--context=CONTEXT : --kubeconfig=KUBECONFIG]) - [GCLOUD_WIDE_FLAG ...] + [--uninstall-connect-agent] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command unregisters a cluster with the fleet by: @@ -16,19 +16,19 @@ DESCRIPTION 2. Removing the corresponding in-cluster Kubernetes Resources that make the cluster exclusive to one fleet (a.k.a `kubectl delete memberships membership`). - 3. Uninstalling the Connect Agent from this cluster (a.k.a - `kubectl delete on the gke-connect namespace`). + 3. [Optional for GKE cluster] Uninstalling the Connect agent from this + cluster (a.k.a `kubectl delete on the gke-connect namespace`). The unregister command makes additional internal checks to ensure that all three steps can be safely done to properly clean-up in-Fleet and in-cluster resources. - To register a non-GKE cluster use --context flag (with an optional - --kubeconfig flag). - To register a GKE cluster use --gke-cluster or --gke-uri flag (no --kubeconfig flag is required). + To register a non-GKE cluster use --context flag (with an optional + --kubeconfig`s flag). + To only delete the Fleet Membership resource, consider using the command: gcloud container hub memberships delete. This command is intended to delete stale Fleet Membership resources as doing so on a fully registered cluster @@ -57,6 +57,12 @@ EXAMPLES $ gcloud container hub memberships unregister my-membership \ --gke-cluster=my-cluster-region-or-zone/my-cluster + Unregister a GKE cluster and uninstall Connect agent: + + $ gcloud container hub memberships unregister my-membership \ + --gke-cluster=my-cluster-region-or-zone/my-cluster \ + --uninstall-connect-agent + POSITIONAL ARGUMENTS MEMBERSHIP_NAME The membership name that you choose to uniquely represents the cluster @@ -95,6 +101,12 @@ REQUIRED FLAGS to $KUBECONFIG if it is set in the environment, otherwise defaults to $HOME/.kube/config. +OPTIONAL FLAGS + --uninstall-connect-agent + If set to True for a GKE cluster, Connect agent will be uninstalled + from the cluster. No-op for Non-GKE clusters, where Connect agent will + always be uninstalled. + 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/dataplex/assets/actions/list b/gcloud/dataplex/assets/actions/list index f9eed6523..576a5bb4f 100644 --- a/gcloud/dataplex/assets/actions/list +++ b/gcloud/dataplex/assets/actions/list @@ -40,7 +40,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --asset on the command line with a fully @@ -48,7 +48,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --asset on the command line with a fully @@ -57,7 +57,7 @@ REQUIRED FLAGS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument --asset on the command line with a fully diff --git a/gcloud/dataplex/assets/delete b/gcloud/dataplex/assets/delete index 97ad1ff8a..06adcd9dd 100644 --- a/gcloud/dataplex/assets/delete +++ b/gcloud/dataplex/assets/delete @@ -38,7 +38,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument asset on the command line with a fully @@ -46,7 +46,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument asset on the command line with a fully @@ -55,7 +55,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument asset on the command line with a fully diff --git a/gcloud/dataplex/assets/describe b/gcloud/dataplex/assets/describe index 214b092fd..14a70e943 100644 --- a/gcloud/dataplex/assets/describe +++ b/gcloud/dataplex/assets/describe @@ -38,7 +38,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument asset on the command line with a fully @@ -46,7 +46,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument asset on the command line with a fully @@ -55,7 +55,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument asset on the command line with a fully diff --git a/gcloud/dataplex/assets/get-iam-policy b/gcloud/dataplex/assets/get-iam-policy index 7b3ed2d21..481e29a0e 100644 --- a/gcloud/dataplex/assets/get-iam-policy +++ b/gcloud/dataplex/assets/get-iam-policy @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument asset on the command line with a fully @@ -51,7 +51,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument asset on the command line with a fully @@ -60,7 +60,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --zone=ZONE - The identifier of the Dataplex zone resource. + Identifier of the Dataplex zone resource. To set the zone attribute: ▸ provide the argument asset on the command line with a fully diff --git a/gcloud/dataplex/assets/list b/gcloud/dataplex/assets/list index 5fd814868..b3fa39881 100644 --- a/gcloud/dataplex/assets/list +++ b/gcloud/dataplex/assets/list @@ -39,7 +39,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --zone on the command line with a fully @@ -47,7 +47,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --zone on the command line with a fully diff --git a/gcloud/dataplex/content/add-iam-policy-binding b/gcloud/dataplex/content/add-iam-policy-binding new file mode 100644 index 000000000..3f8a52b91 --- /dev/null +++ b/gcloud/dataplex/content/add-iam-policy-binding @@ -0,0 +1,92 @@ +NAME + gcloud dataplex content add-iam-policy-binding - adds IAM policy binding to + a Dataplex Content + +SYNOPSIS + gcloud dataplex content add-iam-policy-binding + (CONTENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Adds IAM policy binding to a Dataplex Content. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user 'testuser@gmail.com' to content test-content within lake test-lake in + location us-central, run: + + $ gcloud dataplex content add-iam-policy-binding test-content \ + --project=test-project --location=us-central1 --lake=test-lake \ + --role=roles/dataplex.viewer --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Content resource - The Content to add IAM policy binding 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex content add-iam-policy-binding + diff --git a/gcloud/dataplex/content/create b/gcloud/dataplex/content/create new file mode 100644 index 000000000..d5820eaad --- /dev/null +++ b/gcloud/dataplex/content/create @@ -0,0 +1,104 @@ +NAME + gcloud dataplex content create - creating a content + +SYNOPSIS + gcloud dataplex content create --data-text=DATA_TEXT --path=PATH + (--kernel-type=KERNEL_TYPE | --query-engine=QUERY_ENGINE) + (--lake=LAKE : --location=LOCATION) [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [--validate-only] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Creating a content. + +EXAMPLES + To create a Dataplex content test-content of type notebook within lake + test-lake in location us-central1. + + $ gcloud dataplex content create --project=test-project \ + --location=us-central1 --lake=test-lake --kernel-type=PYTHON3 \ + --data-text='' --path='test-content' + +REQUIRED FLAGS + --data-text=DATA_TEXT + Content data in string format + + --path=PATH + The path for the Content file, represented as directory structure + + Sql script or notebook related configurations. + + Exactly one of these must be specified: + + Notebook related configurations. + + --kernel-type=KERNEL_TYPE + Kernel Type of the notebook. KERNEL_TYPE must be (currently only + one value is supported): + + PYTHON3 + python3 + + Sql script related configurations. + + --query-engine=QUERY_ENGINE + Query Engine to be used for the Sql Query. QUERY_ENGINE must be + (currently only one value is supported): + + SPARK + spark + + Lakes resource - Arguments and flags that define the Dataplex lake you + want to create a Content 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 --lake 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. + + --lake=LAKE + ID of the lakes or fully qualified identifier for the lakes. To set + the lake attribute: + ▸ provide the argument --lake 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 of the Dataplex resource. To set the location attribute: + ▸ provide the argument --lake on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +OPTIONAL FLAGS + --description=DESCRIPTION + Description of the Content + + --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. + + --validate-only + Validate the create action, 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 dataplex content create + diff --git a/gcloud/dataplex/content/delete b/gcloud/dataplex/content/delete new file mode 100644 index 000000000..3289f7e0f --- /dev/null +++ b/gcloud/dataplex/content/delete @@ -0,0 +1,73 @@ +NAME + gcloud dataplex content delete - delete a Dataplex Content Resource + +SYNOPSIS + gcloud dataplex content delete (CONTENT : --lake=LAKE --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Dataplex Content resource based on project, location, lake, and + content. + +EXAMPLES + To delete a content test-content in lake test-lake under location + us-central1 inside project test-project, run : + + $ gcloud dataplex content delete --project=test-project \ + --location=us-central1 --lake=test-lake test-content + +POSITIONAL ARGUMENTS + Content resource - Arguments and flags that define the Dataplex Content + 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument content 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 variant is also available: + + $ gcloud alpha dataplex content delete + diff --git a/gcloud/dataplex/content/describe b/gcloud/dataplex/content/describe new file mode 100644 index 000000000..e4fb23dc2 --- /dev/null +++ b/gcloud/dataplex/content/describe @@ -0,0 +1,85 @@ +NAME + gcloud dataplex content describe - retrieve a Dataplex Content Resource + +SYNOPSIS + gcloud dataplex content describe + (CONTENT : --lake=LAKE --location=LOCATION) + [--view=VIEW; default="basic"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get a Dataplex Content resource based on project, location, lake, and + content. + +EXAMPLES + To describe a Dataplex Content test-content in project test-project under + loaction us-central1 inside project test-project, run: + + $ gcloud dataplex content describe test-content \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Content resource - Arguments and flags that define the Dataplex Content + 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --view=VIEW; default="basic" + There are two possible views, 'basic' and 'full'. The default view is + 'basic'. VIEW must be one of: + + basic + Does not include the Content data in response. + + full + Includes the content data in response. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 variant is also available: + + $ gcloud alpha dataplex content describe + diff --git a/gcloud/dataplex/content/get-iam-policy b/gcloud/dataplex/content/get-iam-policy new file mode 100644 index 000000000..ecf12221e --- /dev/null +++ b/gcloud/dataplex/content/get-iam-policy @@ -0,0 +1,102 @@ +NAME + gcloud dataplex content get-iam-policy - retrieve the IAM policy for a + Dataplex Content + +SYNOPSIS + gcloud dataplex content get-iam-policy + (CONTENT : --lake=LAKE --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get a Dataplex Content Iam Policy based on project_id, location, lake_id, + and contents_id. + +EXAMPLES + To get the IAM policy of a Dataplex Content test-content in project + test-project under loaction us-central1 inside lake test-lake, run: + + $ gcloud dataplex content get-iam-policy test-content \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Content resource - Arguments and flags that define the Dataplex contents + IAM policy 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument content 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 variant is also available: + + $ gcloud alpha dataplex content get-iam-policy + diff --git a/gcloud/dataplex/content/help b/gcloud/dataplex/content/help new file mode 100644 index 000000000..8f49f0904 --- /dev/null +++ b/gcloud/dataplex/content/help @@ -0,0 +1,50 @@ +NAME + gcloud dataplex content - manage Dataplex Content + +SYNOPSIS + gcloud dataplex content COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Dataplex Content. + +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 + Adds IAM policy binding to a Dataplex Content. + + create + Creating a content. + + delete + Delete a Dataplex Content Resource. + + describe + Retrieve a Dataplex Content Resource. + + get-iam-policy + Retrieve the IAM policy for a Dataplex Content. + + list + List Dataplex Content Resources. + + remove-iam-policy-binding + Removes IAM policy binding from a Dataplex Content. + + set-iam-policy + Set the IAM policy to a Dataplex Content as defined in a JSON or YAML + file. + + update + Update a Dataplex Content Resource with the given configurations. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex content + diff --git a/gcloud/dataplex/content/list b/gcloud/dataplex/content/list new file mode 100644 index 000000000..7f9e4aacf --- /dev/null +++ b/gcloud/dataplex/content/list @@ -0,0 +1,98 @@ +NAME + gcloud dataplex content list - list Dataplex Content Resources + +SYNOPSIS + gcloud dataplex content list (--lake=LAKE : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Dataplex Content resource based on project, location, and lake. + Currently list does not support project/{project_id}/.../ notation. + +EXAMPLES + To list all Dataplex Content resource in lake test-lake under location + us-central1 inside project test-project, run : + + $ gcloud dataplex content list --project=test-project \ + --location=us-central1 --lake=test-lake + +REQUIRED FLAGS + Lake resource - Arguments and flags that define the Dataplex Content you + want 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 --lake 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. + + --lake=LAKE + ID of the lake or fully qualified identifier for the lake. To set the + lake attribute: + ▸ provide the argument --lake 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 --lake 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 variant is also available: + + $ gcloud alpha dataplex content list + diff --git a/gcloud/dataplex/content/remove-iam-policy-binding b/gcloud/dataplex/content/remove-iam-policy-binding new file mode 100644 index 000000000..d132f7698 --- /dev/null +++ b/gcloud/dataplex/content/remove-iam-policy-binding @@ -0,0 +1,93 @@ +NAME + gcloud dataplex content remove-iam-policy-binding - removes IAM policy + binding from a Dataplex Content + +SYNOPSIS + gcloud dataplex content remove-iam-policy-binding + (CONTENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Removes IAM policy binding from a Dataplex Content. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from a content test-content within lake test-lake + in location us-central1, run: + + $ gcloud dataplex content remove-iam-policy-binding test-content \ + --project=test-project --location=us-central1 --lake=test-lake \ + --role=roles/dataplex.viewer --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Content resource - The Content to remove IAM policy binding 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex content remove-iam-policy-binding + diff --git a/gcloud/dataplex/content/set-iam-policy b/gcloud/dataplex/content/set-iam-policy new file mode 100644 index 000000000..ab8291395 --- /dev/null +++ b/gcloud/dataplex/content/set-iam-policy @@ -0,0 +1,78 @@ +NAME + gcloud dataplex content set-iam-policy - set the IAM policy to a Dataplex + Content as defined in a JSON or YAML file + +SYNOPSIS + gcloud dataplex content set-iam-policy + (CONTENT : --lake=LAKE --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex content test-content within lake + test-lake in location us-central1 and : + + $ gcloud dataplex content set-iam-policy test-content \ + --project=test-project --location=us-central1 --lake=test-lake \ + policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Content resource - The Content to set 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + 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. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex content set-iam-policy + diff --git a/gcloud/dataplex/content/update b/gcloud/dataplex/content/update new file mode 100644 index 000000000..cd993bf08 --- /dev/null +++ b/gcloud/dataplex/content/update @@ -0,0 +1,113 @@ +NAME + gcloud dataplex content update - update a Dataplex Content Resource with + the given configurations + +SYNOPSIS + gcloud dataplex content update (CONTENT : --lake=LAKE --location=LOCATION) + [--data-text=DATA_TEXT] [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [--path=PATH] [--validate-only] + [--kernel-type=KERNEL_TYPE | --query-engine=QUERY_ENGINE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Dataplex Content Resource with the given configurations. + +EXAMPLES + To update a Dataplex content test-content in project test-project within + lake test-lake in location us-central1 and change the description to + Updated Description, run: + + $ gcloud dataplex content update test-content \ + --project=test-project --location=us-central1 --lake=test-lake \ + --description='Updated Description' + +POSITIONAL ARGUMENTS + Content resource - The Content to Update a Content 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 content 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. + + CONTENT + ID of the content or fully qualified identifier for the content. To + set the content attribute: + ▸ provide the argument content on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument content on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --data-text=DATA_TEXT + Content data in string format + + --description=DESCRIPTION + Description of the Content + + --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. + + --path=PATH + The path for the Content file, represented as directory structure + + --validate-only + Validate the update action, but don't actually perform it. + + Sql script or notebook related configurations. + + At most one of these can be specified: + + Notebook related configurations. + + --kernel-type=KERNEL_TYPE + Kernel Type of the notebook. KERNEL_TYPE must be (currently only + one value is supported): + + PYTHON3 + python3 + + Sql script related configurations. + + --query-engine=QUERY_ENGINE + Query Engine to be used for the Sql Query. QUERY_ENGINE must be + (currently only one value is supported): + + SPARK + spark + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 dataplex content update + diff --git a/gcloud/dataplex/environments/add-iam-policy-binding b/gcloud/dataplex/environments/add-iam-policy-binding new file mode 100644 index 000000000..e30b4d9cd --- /dev/null +++ b/gcloud/dataplex/environments/add-iam-policy-binding @@ -0,0 +1,93 @@ +NAME + gcloud dataplex environments add-iam-policy-binding - adds IAM policy + binding to a Dataplex Environment + +SYNOPSIS + gcloud dataplex environments add-iam-policy-binding + (ENVIRONMENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Adds IAM policy binding to a Dataplex Environment. + +EXAMPLES + To add an IAM policy binding for the role of roles/dataplex.viewer for the + user 'testuser@gmail.com' to environment test-environment within lake + test-lake in location us-central, run: + + $ gcloud dataplex environments add-iam-policy-binding \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Environments resource - The Environment to add IAM policy binding 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex environments add-iam-policy-binding + diff --git a/gcloud/dataplex/environments/create b/gcloud/dataplex/environments/create new file mode 100644 index 000000000..57fa97bf0 --- /dev/null +++ b/gcloud/dataplex/environments/create @@ -0,0 +1,160 @@ +NAME + gcloud dataplex environments create - create a Dataplex Environment + +SYNOPSIS + gcloud dataplex environments create + (ENVIRONMENT : --lake=LAKE --location=LOCATION) + ((--os-image-version=OS_IMAGE_VERSION + : --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...]) + : --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB; default=100 + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + --compute-node-count=COMPUTE_NODE_COUNT) [--description=DESCRIPTION] + [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]] + [--async | --validate-only] + [--session-enable-fast-startup + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Dataplex Environment. + +EXAMPLES + To create a Dataplex Environment test-environment within lake test-lake in + location us-central1 inside project test-project , run: + + $ gcloud dataplex environments create test-environment \ + --project=test-project --location=us-central1 --lake=test-lake \ + --os-image-version=1.0 + + To know about the other required arguments to create an environment run: + + $ gcloud dataplex environment create --help + +POSITIONAL ARGUMENTS + Environments resource - The Environment to create a Environment 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +REQUIRED FLAGS + Configuration for the underlying infrastructure used to run workloads. + + This must be specified. + + Software Runtime Configuration to run Analyze. + + This must be specified. + + --os-image-version=OS_IMAGE_VERSION + Dataplex Image version. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + List of Java jars to be included in the runtime environment. Valid + input includes Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on daemon + config files. Property keys are specified in prefix:property + format. + + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + Compute resources associated with the analyze interactive workloads. + + --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB; default=100 + Size in GB of the disk. Default is 100 GB. + + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + Maximum number of configurable nodes. + + --compute-node-count=COMPUTE_NODE_COUNT + Total number of worker nodes in the cluster. + +OPTIONAL FLAGS + --description=DESCRIPTION + Description of the Environment + + --display-name=DISPLAY_NAME + Display Name of the Environment + + --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. + + Configuration for sessions created for the environment to be created. + + --session-enable-fast-startup + Enables fast startup. This causes sessions to be pre-created and + available for faster startup to enable interactive exploration + use-cases. + + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION + The idle time configuration of the session. The session will be + auto-terminated at the end of this period. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 dataplex environments create + diff --git a/gcloud/dataplex/environments/delete b/gcloud/dataplex/environments/delete new file mode 100644 index 000000000..a53db17a4 --- /dev/null +++ b/gcloud/dataplex/environments/delete @@ -0,0 +1,79 @@ +NAME + gcloud dataplex environments delete - delete a Dataplex Environment + +SYNOPSIS + gcloud dataplex environments delete + (ENVIRONMENT : --lake=LAKE --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Dataplex Environment based on project, location, lake, + environment. + +EXAMPLES + To delete a Dataplex Environment test-environment in project test-project + under location us-central1 within lake test-lake, run: + + $ gcloud dataplex environments delete test-environment \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Environment resource - Arguments and flags that define the Dataplex + Environment 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 environment 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. + + ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument environment 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 variant is also available: + + $ gcloud alpha dataplex environments delete + diff --git a/gcloud/dataplex/environments/describe b/gcloud/dataplex/environments/describe new file mode 100644 index 000000000..72c4c71f7 --- /dev/null +++ b/gcloud/dataplex/environments/describe @@ -0,0 +1,73 @@ +NAME + gcloud dataplex environments describe - retrieve a Dataplex Environment + +SYNOPSIS + gcloud dataplex environments describe + (ENVIRONMENT : --lake=LAKE --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get a Dataplex Environment resource based on project, location, lake, and + environment. + +EXAMPLES + To describe a Dataplex Environment test-environment in project test-project + under location us-central1 within lake test-lake, run: + + $ gcloud dataplex environments describe test-environment \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Environment resource - Arguments and flags that define the Dataplex + Environment 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 environment 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. + + ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument environment 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 variant is also available: + + $ gcloud alpha dataplex environments describe + diff --git a/gcloud/dataplex/environments/get-iam-policy b/gcloud/dataplex/environments/get-iam-policy new file mode 100644 index 000000000..d7b5472b9 --- /dev/null +++ b/gcloud/dataplex/environments/get-iam-policy @@ -0,0 +1,102 @@ +NAME + gcloud dataplex environments get-iam-policy - retrieve a Dataplex + Environment IAM policy + +SYNOPSIS + gcloud dataplex environments get-iam-policy + (ENVIRONMENT : --lake=LAKE --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get a Dataplex Environment Iam Policy based on project_id, location, + lake_id, and environment_id. + +EXAMPLES + To get the IAM policy of a Dataplex Environment test-environment in project + test-project under location us-central1 within lake test-lake, run: + + $ gcloud dataplex environments get-iam-policy test-environment \ + --project=test-project --location=us-central1 --lake=test-lake + +POSITIONAL ARGUMENTS + Environment resource - Arguments and flags that define the Dataplex + Environment IAM policy 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 environment 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. + + ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument environment 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 variant is also available: + + $ gcloud alpha dataplex environments get-iam-policy + diff --git a/gcloud/dataplex/environments/help b/gcloud/dataplex/environments/help new file mode 100644 index 000000000..72c69929c --- /dev/null +++ b/gcloud/dataplex/environments/help @@ -0,0 +1,56 @@ +NAME + gcloud dataplex environments - manage Dataplex Environments + +SYNOPSIS + gcloud dataplex environments GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Dataplex Environments. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + sessions + Manage Dataplex Sessions services. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + Adds IAM policy binding to a Dataplex Environment. + + create + Create a Dataplex Environment. + + delete + Delete a Dataplex Environment. + + describe + Retrieve a Dataplex Environment. + + get-iam-policy + Retrieve a Dataplex Environment IAM policy. + + list + List Dataplex Environments. + + remove-iam-policy-binding + Removes IAM policy binding from a Dataplex Environment. + + set-iam-policy + Set an IAM policy binding for a Dataplex Environment as defined in a + JSON or YAML file. + + update + Update a Dataplex Environment with the given configurations. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex environments + diff --git a/gcloud/dataplex/environments/list b/gcloud/dataplex/environments/list new file mode 100644 index 000000000..781b9047b --- /dev/null +++ b/gcloud/dataplex/environments/list @@ -0,0 +1,97 @@ +NAME + gcloud dataplex environments list - list Dataplex Environments + +SYNOPSIS + gcloud dataplex environments list (--lake=LAKE : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Dataplex Environments based on project, location and lake. + +EXAMPLES + To list all Dataplex Environments in lake test-lake under location + us-central1, run :- + + $ gcloud dataplex environments list --project=test-project \ + --location=us-central1 --lake=test-lake + +REQUIRED FLAGS + Lake resource - Arguments and flags that define the Dataplex Environments + you want 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 --lake 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. + + --lake=LAKE + ID of the lake or fully qualified identifier for the lake. To set the + lake attribute: + ▸ provide the argument --lake 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 --lake 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 variant is also available: + + $ gcloud alpha dataplex environments list + diff --git a/gcloud/dataplex/environments/remove-iam-policy-binding b/gcloud/dataplex/environments/remove-iam-policy-binding new file mode 100644 index 000000000..c5244807b --- /dev/null +++ b/gcloud/dataplex/environments/remove-iam-policy-binding @@ -0,0 +1,94 @@ +NAME + gcloud dataplex environments remove-iam-policy-binding - removes IAM policy + binding from a Dataplex Environment + +SYNOPSIS + gcloud dataplex environments remove-iam-policy-binding + (ENVIRONMENT : --lake=LAKE --location=LOCATION) --member=PRINCIPAL + --role=ROLE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Removes IAM policy binding from a Dataplex Environment. + +EXAMPLES + To remove an IAM policy binding for the role roles/dataplex.viewer for the + user testuser@gmail.com from an environment test-environment within lake + test-lake in location us-central1, run: + + $ gcloud dataplex environments remove-iam-policy-binding \ + test-environment --project=test-project --location=us-central1 \ + --lake=test-lake --role=roles/dataplex.viewer \ + --member=user:testuser@gmail.com + + See https://cloud.google.com/dataplex/docs/iam-roles for details of policy + role and member types. + +POSITIONAL ARGUMENTS + Environments resource - The Environment to remove IAM policy binding 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +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. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex environments remove-iam-policy-binding + diff --git a/gcloud/dataplex/environments/sessions/help b/gcloud/dataplex/environments/sessions/help new file mode 100644 index 000000000..474682859 --- /dev/null +++ b/gcloud/dataplex/environments/sessions/help @@ -0,0 +1,25 @@ +NAME + gcloud dataplex environments sessions - manage Dataplex Sessions services + +SYNOPSIS + gcloud dataplex environments sessions COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Dataplex Sessions services. + +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 Sessions associated with a Environment. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex environments sessions + diff --git a/gcloud/dataplex/environments/sessions/list b/gcloud/dataplex/environments/sessions/list new file mode 100644 index 000000000..636ce1bb7 --- /dev/null +++ b/gcloud/dataplex/environments/sessions/list @@ -0,0 +1,102 @@ +NAME + gcloud dataplex environments sessions list - list Sessions associated with + a Environment + +SYNOPSIS + gcloud dataplex environments sessions list + (--environment=ENVIRONMENT : --lake=LAKE --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Sessions associated with a Environment based on project, location, + lake and environment. + +EXAMPLES + To list sessions associated with a Dataplex Environment test-environment in + project test-project and lake test-lake under location us-central1, run: + + $ gcloud dataplex environments sessions list test-environment \ + --project=test-project --location=us-central1 --lake=test-lake + +REQUIRED FLAGS + Environment resource - Arguments and flags that define the Dataplex + Environment to list the Sessions associated with the Environment. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument --environment 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. + + --environment=ENVIRONMENT + ID of the environment or fully qualified identifier for the + environment. To set the environment attribute: + ▸ provide the argument --environment on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --lake=LAKE + Identifier of the Dataplex lake resource. + + To set the lake attribute: + ▸ provide the argument --environment on the command line with a + fully specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + Location of the Dataplex resource. + + To set the location attribute: + ▸ provide the argument --environment 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. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 variant is also available: + + $ gcloud alpha dataplex environments sessions list + diff --git a/gcloud/dataplex/environments/set-iam-policy b/gcloud/dataplex/environments/set-iam-policy new file mode 100644 index 000000000..79db9bd7c --- /dev/null +++ b/gcloud/dataplex/environments/set-iam-policy @@ -0,0 +1,78 @@ +NAME + gcloud dataplex environments set-iam-policy - set an IAM policy binding for + a Dataplex Environment as defined in a JSON or YAML file + +SYNOPSIS + gcloud dataplex environments set-iam-policy + (ENVIRONMENT : --lake=LAKE --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + See https://cloud.google.com/iam/docs/managing-policies for details of the + policy file format and contents. + +EXAMPLES + The following command will read an IAM policy defined in a JSON file + policy.json and set it for the Dataplex environment test-environment within + lake test-lake in location us-central1: + + $ gcloud dataplex environments set-iam-policy test-environment \ + --project=test-project --location=us-central1 --lake=test-lake \ + policy.json + + where policy.json is the relative path to the json file. + +POSITIONAL ARGUMENTS + Environments resource - The Environment to set 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + + 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. + +NOTES + This variant is also available: + + $ gcloud alpha dataplex environments set-iam-policy + diff --git a/gcloud/dataplex/environments/update b/gcloud/dataplex/environments/update new file mode 100644 index 000000000..10fc21b8a --- /dev/null +++ b/gcloud/dataplex/environments/update @@ -0,0 +1,150 @@ +NAME + gcloud dataplex environments update - update a Dataplex Environment with + the given configurations + +SYNOPSIS + gcloud dataplex environments update + (ENVIRONMENT : --lake=LAKE --location=LOCATION) + [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] + [--labels=[KEY=VALUE,...]] [--async | --validate-only] + [--compute-disk-size-gb=COMPUTE_DISK_SIZE_GB + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + --compute-node-count=COMPUTE_NODE_COUNT + --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] + --os-image-version=OS_IMAGE_VERSION] + [--session-enable-fast-startup + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Dataplex Environment with the given configurations. + +EXAMPLES + To update a Dataplex environment test-environment within lake test-lake in + location us-central1 and change the description to Updated Description, + run: + + $ gcloud dataplex environments update test-environment \ + --project=test-project --location=us-central1 --lake=test-lake \ + --description='Updated Description' + +POSITIONAL ARGUMENTS + Environments resource - The Environment to update a Environment 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 environment 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. + + ENVIRONMENT + ID of the environments or fully qualified identifier for the + environments. To set the environment attribute: + ▸ provide the argument environment on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --lake=LAKE + The identifier of the Dataplex lake resource. To set the lake + attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --lake on the command line. + + --location=LOCATION + The location of the Dataplex resource. To set the location attribute: + ▸ provide the argument environment on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property dataplex/location. + +FLAGS + --description=DESCRIPTION + Description of the Environment + + --display-name=DISPLAY_NAME + Display Name of the Environment + + --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. + + Configuration for the underlying infrastructure used to run workloads. + + Compute resources associated with the analyze interactive workloads. + + --compute-disk-size-gb=COMPUTE_DISK_SIZE_GB + Size in GB of the disk. Default is 100 GB. + + --compute-max-node-count=COMPUTE_MAX_NODE_COUNT + Maximum number of configurable nodes. + + --compute-node-count=COMPUTE_NODE_COUNT + Total number of worker nodes in the cluster. + + Software Runtime Configuration to run Analyze. + + --os-image-java-libraries=[OS_IMAGE_JAVA_LIBRARIES,...] + List of Java jars to be included in the runtime environment. Valid + input includes Cloud Storage URIs to Jar binaries. For example, + gs://bucket-name/my/path/to/file.jar + + --os-image-properties=[OS_IMAGE_PROPERTIES,...] + Override to common configuration of open source components + installed on the Dataproc cluster. The properties to set on daemon + config files. Property keys are specified in prefix:property + format. + + --os-image-python-packages=[OS_IMAGE_PYTHON_PACKAGES,...] + A list of python packages to be installed. Valid formats include + Cloud Storage URI to a PIP installable library. For example, + gs://bucket-name/my/path/to/lib.tar.gz + + --os-image-version=OS_IMAGE_VERSION + Dataplex Image version. + + Configuration for sessions created for the environment to be updated. + + --session-enable-fast-startup + Enables fast startup. This causes sessions to be pre-created and + available for faster startup to enable interactive exploration + use-cases. + + --session-max-idle-duration=SESSION_MAX_IDLE_DURATION + The idle time configuration of the session. The session will be + auto-terminated at the end of this period. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 dataplex environments update + diff --git a/gcloud/dataplex/help b/gcloud/dataplex/help index 540377c3d..7597c04ea 100644 --- a/gcloud/dataplex/help +++ b/gcloud/dataplex/help @@ -18,6 +18,12 @@ GROUPS assets Manage Dataplex Asset resources. + content + Manage Dataplex Content. + + environments + Manage Dataplex Environments. + lakes Manage Dataplex Lake resources. diff --git a/gcloud/dataplex/lakes/actions/list b/gcloud/dataplex/lakes/actions/list index 337f0323f..582725cfd 100644 --- a/gcloud/dataplex/lakes/actions/list +++ b/gcloud/dataplex/lakes/actions/list @@ -38,7 +38,7 @@ REQUIRED FLAGS this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --lake on the command line with a fully diff --git a/gcloud/dataplex/lakes/delete b/gcloud/dataplex/lakes/delete index 357b7a7e8..864ed9333 100644 --- a/gcloud/dataplex/lakes/delete +++ b/gcloud/dataplex/lakes/delete @@ -35,7 +35,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument lake on the command line with a fully diff --git a/gcloud/dataplex/lakes/describe b/gcloud/dataplex/lakes/describe index 2b76bf684..2419d1d0b 100644 --- a/gcloud/dataplex/lakes/describe +++ b/gcloud/dataplex/lakes/describe @@ -35,7 +35,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument lake on the command line with a fully diff --git a/gcloud/dataplex/lakes/get-iam-policy b/gcloud/dataplex/lakes/get-iam-policy index 1c157ba49..996e1062f 100644 --- a/gcloud/dataplex/lakes/get-iam-policy +++ b/gcloud/dataplex/lakes/get-iam-policy @@ -42,7 +42,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument lake on the command line with a fully diff --git a/gcloud/dataplex/tasks/create b/gcloud/dataplex/tasks/create index b3b9aad81..f9f75cc3b 100644 --- a/gcloud/dataplex/tasks/create +++ b/gcloud/dataplex/tasks/create @@ -98,7 +98,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -106,7 +106,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/dataplex/tasks/delete b/gcloud/dataplex/tasks/delete index 06cda8426..a341c2f55 100644 --- a/gcloud/dataplex/tasks/delete +++ b/gcloud/dataplex/tasks/delete @@ -37,7 +37,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -45,7 +45,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/dataplex/tasks/describe b/gcloud/dataplex/tasks/describe index 4132fbde4..9669e3099 100644 --- a/gcloud/dataplex/tasks/describe +++ b/gcloud/dataplex/tasks/describe @@ -39,7 +39,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -47,7 +47,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/dataplex/tasks/get-iam-policy b/gcloud/dataplex/tasks/get-iam-policy index e70cf2651..cb49b20b2 100644 --- a/gcloud/dataplex/tasks/get-iam-policy +++ b/gcloud/dataplex/tasks/get-iam-policy @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -51,7 +51,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/dataplex/tasks/jobs/cancel b/gcloud/dataplex/tasks/jobs/cancel index 75b068fe5..576cee6bf 100644 --- a/gcloud/dataplex/tasks/jobs/cancel +++ b/gcloud/dataplex/tasks/jobs/cancel @@ -40,7 +40,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument job on the command line with a fully @@ -48,7 +48,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument job on the command line with a fully @@ -57,7 +57,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --task=TASK - The identifier of the Dataplex task resource. + Identifier of the Dataplex task resource. To set the task attribute: ▸ provide the argument job on the command line with a fully diff --git a/gcloud/dataplex/tasks/jobs/describe b/gcloud/dataplex/tasks/jobs/describe index a4c41430c..d370e85b0 100644 --- a/gcloud/dataplex/tasks/jobs/describe +++ b/gcloud/dataplex/tasks/jobs/describe @@ -41,7 +41,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument job on the command line with a fully @@ -49,7 +49,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument job on the command line with a fully @@ -58,7 +58,7 @@ POSITIONAL ARGUMENTS ▸ set the property dataplex/location. --task=TASK - The identifier of the Dataplex task resource. + Identifier of the Dataplex task resource. To set the task attribute: ▸ provide the argument job on the command line with a fully diff --git a/gcloud/dataplex/tasks/jobs/list b/gcloud/dataplex/tasks/jobs/list index b1dbc01a8..56f855b67 100644 --- a/gcloud/dataplex/tasks/jobs/list +++ b/gcloud/dataplex/tasks/jobs/list @@ -38,7 +38,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --task on the command line with a fully @@ -46,7 +46,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --task on the command line with a fully diff --git a/gcloud/dataplex/tasks/list b/gcloud/dataplex/tasks/list index 295745702..16bcc1e95 100644 --- a/gcloud/dataplex/tasks/list +++ b/gcloud/dataplex/tasks/list @@ -38,7 +38,7 @@ REQUIRED FLAGS this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --lake on the command line with a fully diff --git a/gcloud/dataplex/tasks/update b/gcloud/dataplex/tasks/update index 697ac1417..b73666aba 100644 --- a/gcloud/dataplex/tasks/update +++ b/gcloud/dataplex/tasks/update @@ -72,7 +72,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument task on the command line with a fully @@ -80,7 +80,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument task on the command line with a fully diff --git a/gcloud/dataplex/zones/actions/list b/gcloud/dataplex/zones/actions/list index 9fb74dada..e60d71f70 100644 --- a/gcloud/dataplex/zones/actions/list +++ b/gcloud/dataplex/zones/actions/list @@ -39,7 +39,7 @@ REQUIRED FLAGS this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument --zone on the command line with a fully @@ -47,7 +47,7 @@ REQUIRED FLAGS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --zone on the command line with a fully diff --git a/gcloud/dataplex/zones/delete b/gcloud/dataplex/zones/delete index b4d81d5b0..f918b7832 100644 --- a/gcloud/dataplex/zones/delete +++ b/gcloud/dataplex/zones/delete @@ -37,7 +37,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument zone on the command line with a fully @@ -45,7 +45,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument zone on the command line with a fully diff --git a/gcloud/dataplex/zones/describe b/gcloud/dataplex/zones/describe index 1f31a7691..86fda0f43 100644 --- a/gcloud/dataplex/zones/describe +++ b/gcloud/dataplex/zones/describe @@ -37,7 +37,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument zone on the command line with a fully @@ -45,7 +45,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument zone on the command line with a fully diff --git a/gcloud/dataplex/zones/get-iam-policy b/gcloud/dataplex/zones/get-iam-policy index 9030f84d4..75875858a 100644 --- a/gcloud/dataplex/zones/get-iam-policy +++ b/gcloud/dataplex/zones/get-iam-policy @@ -43,7 +43,7 @@ POSITIONAL ARGUMENTS arguments in this group are specified. --lake=LAKE - The identifier of the Dataplex lake resource. + Identifier of the Dataplex lake resource. To set the lake attribute: ▸ provide the argument zone on the command line with a fully @@ -51,7 +51,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument --lake on the command line. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument zone on the command line with a fully diff --git a/gcloud/dataplex/zones/list b/gcloud/dataplex/zones/list index 93c859302..e2ac56884 100644 --- a/gcloud/dataplex/zones/list +++ b/gcloud/dataplex/zones/list @@ -36,7 +36,7 @@ REQUIRED FLAGS this group are specified. --location=LOCATION - The location of the Dataplex resource. + Location of the Dataplex resource. To set the location attribute: ▸ provide the argument --lake on the command line with a fully diff --git a/gcloud/datastream/connection-profiles/create b/gcloud/datastream/connection-profiles/create index 4d66c2ded..67914036d 100644 --- a/gcloud/datastream/connection-profiles/create +++ b/gcloud/datastream/connection-profiles/create @@ -14,7 +14,13 @@ SYNOPSIS --mysql-port=MYSQL_PORT --mysql-username=MYSQL_USERNAME (--mysql-password=MYSQL_PASSWORD | --mysql-prompt-for-password) : --ca-certificate=CA_CERTIFICATE - --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY]] + --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY] + | --postgresql-database=POSTGRESQL_DATABASE + --postgresql-hostname=POSTGRESQL_HOSTNAME + --postgresql-port=POSTGRESQL_PORT + --postgresql-username=POSTGRESQL_USERNAME + (--postgresql-password=POSTGRESQL_PASSWORD + | --postgresql-prompt-for-password)] [--private-connection=PRIVATE_CONNECTION : --static-ip-connectivity | [--forward-ssh-hostname=FORWARD_SSH_HOSTNAME --forward-ssh-username=FORWARD_SSH_USERNAME @@ -36,7 +42,7 @@ EXAMPLES --oracle-port=1521 --database-service=ORCL \ --static-ip-connectivity - To create a connection profile for Mysql: + To create a connection profile for MySQL: $ gcloud datastream connection-profiles create CONNECTION_PROFILE \ --location=us-central1 --type=mysql \ @@ -44,6 +50,15 @@ EXAMPLES --display-name=my-profile --mysql-hostname=35.188.150.50 \ --mysql-port=3306 --static-ip-connectivity + To create a connection profile for PostgreSQL: + + $ gcloud datastream connection-profiles create CONNECTION_PROFILE \ + --location=us-central1 --type=postgresql \ + --postgresql-password=fakepassword \ + --postgresql-username=fakeuser --display-name=my-profile \ + --postgresql-hostname=35.188.150.50 --postgresql-port=5432 \ + --postgresql-database=db --static-ip-connectivity + To create a connection profile for Google Cloud Storage: $ gcloud datastream connection-profiles create CONNECTION_PROFILE \ @@ -88,7 +103,7 @@ REQUIRED FLAGS Friendly name for the connection profile. --type=TYPE - Type can be MYSQL, ORACLE, GOOGLE-CLOUD-STORAGE or BIGQUERY + Type can be MYSQL, ORACLE, POSTGRESQL, GOOGLE-CLOUD-STORAGE or BIGQUERY OPTIONAL FLAGS --force @@ -149,13 +164,13 @@ OPTIONAL FLAGS Prompt for the password used to connect to the database. --mysql-hostname=MYSQL_HOSTNAME - IP or hostname of the mysql source database. + IP or hostname of the MySQL source database. This flag argument must be specified if any of the other arguments in this group are specified. --mysql-port=MYSQL_PORT - Network port of the mysql source database. + Network port of the MySQL source database. This flag argument must be specified if any of the other arguments in this group are specified. @@ -198,6 +213,40 @@ OPTIONAL FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --postgresql-database=POSTGRESQL_DATABASE + Database service for the PostgreSQL connection. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-hostname=POSTGRESQL_HOSTNAME + IP or hostname of the PostgreSQL source database. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-port=POSTGRESQL_PORT + Network port of the PostgreSQL source database. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-username=POSTGRESQL_USERNAME + Username Datastream will use to connect to the database. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + Exactly one of these must be specified: + + --postgresql-password=POSTGRESQL_PASSWORD + Password for the user that Datastream will be using to connect to + the database. This field is not returned on request, and the value + is encrypted when stored in Datastream. + + --postgresql-prompt-for-password + Prompt for the password used to connect to the database. + At most one of these can be specified: Private connection resource - Resource ID of the private connection. diff --git a/gcloud/datastream/connection-profiles/discover b/gcloud/datastream/connection-profiles/discover index cad56066a..d48083069 100644 --- a/gcloud/datastream/connection-profiles/discover +++ b/gcloud/datastream/connection-profiles/discover @@ -7,7 +7,8 @@ SYNOPSIS (--connection-profile-name=CONNECTION_PROFILE_NAME : --connection-profile-object-file=CONNECTION_PROFILE_OBJECT_FILE) [--mysql-rdbms-file=MYSQL_RDBMS_FILE - | --oracle-rdbms-file=ORACLE_RDBMS_FILE] + | --oracle-rdbms-file=ORACLE_RDBMS_FILE + | --postgresql-rdbms-file=POSTGRESQL_RDBMS_FILE] [--recursive | --recursive-depth=RECURSIVE_DEPTH] [GCLOUD_WIDE_FLAG ...] @@ -78,10 +79,15 @@ OPTIONAL FLAGS the flag the file content will be read from stdin. --oracle-rdbms-file=ORACLE_RDBMS_FILE - Path to a YAML (or JSON) file containing the ORACLE RDBMS to enrich + Path to a YAML (or JSON) file containing the Oracle RDBMS to enrich with child data objects and metadata. If you pass - as the value of the flag the file content will be read from stdin. + --postgresql-rdbms-file=POSTGRESQL_RDBMS_FILE + Path to a YAML (or JSON) file containing the PostgreSQL RDBMS to + enrich with child data objects and metadata. If you pass - as the + value of the flag the file content will be read from stdin. + At most one of these can be specified: --recursive diff --git a/gcloud/datastream/connection-profiles/update b/gcloud/datastream/connection-profiles/update index cd9edad96..f90a9e1df 100644 --- a/gcloud/datastream/connection-profiles/update +++ b/gcloud/datastream/connection-profiles/update @@ -16,7 +16,13 @@ SYNOPSIS --ca-certificate=CA_CERTIFICATE --client-certificate=CLIENT_CERTIFICATE --client-key=CLIENT_KEY --mysql-password=MYSQL_PASSWORD - | --mysql-prompt-for-password] + | --mysql-prompt-for-password + | --postgresql-database=POSTGRESQL_DATABASE + --postgresql-hostname=POSTGRESQL_HOSTNAME + --postgresql-port=POSTGRESQL_PORT + --postgresql-username=POSTGRESQL_USERNAME + --postgresql-password=POSTGRESQL_PASSWORD + | --postgresql-prompt-for-password] [--clear-labels | --remove-labels=[KEY,...]] [--private-connection=PRIVATE_CONNECTION : --static-ip-connectivity | --forward-ssh-hostname=FORWARD_SSH_HOSTNAME @@ -39,7 +45,7 @@ EXAMPLES --oracle-port=1521 --database-service=ORCL \ --static-ip-connectivity - To update a connection profile for Mysql: + To update a connection profile for MySQL: $ gcloud datastream connection-profiles update CONNECTION_PROFILE \ --location=us-central1 --type=mysql \ @@ -47,6 +53,15 @@ EXAMPLES --display-name=my-profile --mysql-hostname=35.188.150.50 \ --mysql-port=3306 --static-ip-connectivity + To update a connection profile for PostgreSQL: + + $ gcloud datastream connection-profiles update CONNECTION_PROFILE \ + --location=us-central1 --type=postgresql \ + --postgresql-password=fakepassword \ + --postgresql-username=fakeuser --display-name=my-profile \ + --postgresql-hostname=35.188.150.50 --postgresql-port=5432 \ + --postgresql-database=db --static-ip-connectivity + To update a connection profile for Google Cloud Storage: $ gcloud datastream connection-profiles update CONNECTION_PROFILE \ @@ -88,7 +103,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --type=TYPE - Type can be MYSQL, ORACLE, GOOGLE-CLOUD-STORAGE or BIGQUERY + Type can be MYSQL, ORACLE, POSTGRESQL, GOOGLE-CLOUD-STORAGE or BIGQUERY OPTIONAL FLAGS --display-name=DISPLAY_NAME @@ -138,10 +153,10 @@ OPTIONAL FLAGS Prompt for the password used to connect to the database. --mysql-hostname=MYSQL_HOSTNAME - IP or hostname of the mysql source database. + IP or hostname of the MySQL source database. --mysql-port=MYSQL_PORT - Network port of the mysql source database. + Network port of the MySQL source database. --mysql-username=MYSQL_USERNAME Username Datastream will use to connect to the database. @@ -169,6 +184,28 @@ OPTIONAL FLAGS --mysql-prompt-for-password Prompt for the password used to connect to the database. + --postgresql-database=POSTGRESQL_DATABASE + Database service for the PostgreSQL connection. + + --postgresql-hostname=POSTGRESQL_HOSTNAME + IP or hostname of the PostgreSQL source database. + + --postgresql-port=POSTGRESQL_PORT + Network port of the PostgreSQL source database. + + --postgresql-username=POSTGRESQL_USERNAME + Username Datastream will use to connect to the database. + + At most one of these can be specified: + + --postgresql-password=POSTGRESQL_PASSWORD + Password for the user that Datastream will be using to connect to + the database. This field is not returned on request, and the value + is encrypted when stored in Datastream. + + --postgresql-prompt-for-password + Prompt for the password used to connect to the database. + At most one of these can be specified: --clear-labels diff --git a/gcloud/datastream/objects/lookup b/gcloud/datastream/objects/lookup index 6bd62a769..0a10a3bf2 100644 --- a/gcloud/datastream/objects/lookup +++ b/gcloud/datastream/objects/lookup @@ -4,7 +4,9 @@ NAME SYNOPSIS gcloud datastream objects lookup (--mysql-database=MYSQL_DATABASE --mysql-table=MYSQL_TABLE - | --oracle-schema=ORACLE_SCHEMA --oracle-table=ORACLE_TABLE) + | --oracle-schema=ORACLE_SCHEMA --oracle-table=ORACLE_TABLE + | --postgresql-schema=POSTGRESQL_SCHEMA + --postgresql-table=POSTGRESQL_TABLE) (--stream=STREAM : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -23,6 +25,12 @@ EXAMPLES --location=us-central1 --oracle-schema=my-schema \ --oracle-table=my-table + To lookup an existing PostgreSQL stream object: + + $ gcloud datastream objects lookup --stream=my-stream \ + --location=us-central1 --postgresql-schema=my-schema \ + --postgresql-table=my-table + REQUIRED FLAGS Exactly one of these must be specified: @@ -50,6 +58,18 @@ REQUIRED FLAGS This flag argument must be specified if any of the other arguments in this group are specified. + --postgresql-schema=POSTGRESQL_SCHEMA + PostgreSQL schema for the object. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --postgresql-table=POSTGRESQL_TABLE + PostgreSQL table for the object. + + This flag argument must be specified if any of the other arguments in + this group are specified. + Stream resource - The stream to list objects 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 diff --git a/gcloud/datastream/streams/create b/gcloud/datastream/streams/create index 5e02f9ff3..05cc1487c 100644 --- a/gcloud/datastream/streams/create +++ b/gcloud/datastream/streams/create @@ -6,12 +6,14 @@ SYNOPSIS --display-name=DISPLAY_NAME (--backfill-none | --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS - | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS) + | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS + | --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS) (--destination=DESTINATION (--bigquery-destination-config=BIGQUERY_DESTINATION_CONFIG | --gcs-destination-config=GCS_DESTINATION_CONFIG)) (--source=SOURCE (--mysql-source-config=MYSQL_SOURCE_CONFIG - | --oracle-source-config=ORACLE_SOURCE_CONFIG)) + | --oracle-source-config=ORACLE_SOURCE_CONFIG + | --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG)) [--labels=[KEY=VALUE,...]] [--force | --validate-only] [GCLOUD_WIDE_FLAG ...] @@ -47,6 +49,15 @@ EXAMPLES --bigquery-destination-config=destination_config.json \ --backfill-none + To create a stream with a PostgreSQL source and a BigQuery destination: + + $ gcloud datastream streams create STREAM --location=us-central1 \ + --display-name=my-stream --source=source \ + --postgresql-source-config=source_config.json \ + --destination=destination \ + --bigquery-destination-config=destination_config.json \ + --backfill-none + POSITIONAL ARGUMENTS Stream resource - The stream to create. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes @@ -94,6 +105,9 @@ REQUIRED FLAGS --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS Oracle data source objects to avoid backfilling. + --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS + PostgreSQL data source objects to avoid backfilling. + This must be specified. Connection profile resource - Resource ID of the destination connection @@ -172,7 +186,7 @@ REQUIRED FLAGS --mysql-source-config=MYSQL_SOURCE_CONFIG Path to a YAML (or JSON) file containing the configuration for - Mysql Source Config. + MySQL Source Config. The JSON file is formatted as follows, with snake_case field naming: @@ -226,6 +240,36 @@ REQUIRED FLAGS } } + --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG + Path to a YAML (or JSON) file containing the configuration for + PostgreSQL Source Config. + + The JSON file is formatted as follows, with snake_case field + naming: + + { + "include_objects": {}, + "exclude_objects": { + "postgresql_schemas": [ + { + "schema": "SAMPLE", + "postgresql_tables": [ + { + "table": "SAMPLE_TABLE", + "postgresql_columns": [ + { + "column": "COL", + } + ] + } + ] + } + ] + }, + "replication_slot": "SAMPLE_REPLICATION_SLOT", + "publication": "SAMPLE_PUBLICATION" + } + OPTIONAL FLAGS --labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to add. diff --git a/gcloud/datastream/streams/update b/gcloud/datastream/streams/update index 6dfcaa3b6..a8cc84e8d 100644 --- a/gcloud/datastream/streams/update +++ b/gcloud/datastream/streams/update @@ -7,14 +7,17 @@ SYNOPSIS [--update-labels=[KEY=VALUE,...]] [--update-mask=UPDATE_MASK] [--backfill-none | --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS - | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS] + | --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS + | --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS] [--clear-labels | --remove-labels=[KEY,...]] [--destination=DESTINATION : --bigquery-destination-config=BIGQUERY_DESTINATION_CONFIG | --gcs-destination-config=GCS_DESTINATION_CONFIG] [--force | --validate-only] [--source=SOURCE : --mysql-source-config=MYSQL_SOURCE_CONFIG - | --oracle-source-config=ORACLE_SOURCE_CONFIG] [GCLOUD_WIDE_FLAG ...] + | --oracle-source-config=ORACLE_SOURCE_CONFIG + | --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Create a Datastream stream @@ -104,6 +107,9 @@ FLAGS --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS Oracle data source objects to avoid backfilling. + --postgresql-excluded-objects=POSTGRESQL_EXCLUDED_OBJECTS + PostgreSQL data source objects to avoid backfilling. + At most one of these can be specified: --clear-labels @@ -202,7 +208,7 @@ FLAGS At most one of these can be specified: --mysql-source-config=MYSQL_SOURCE_CONFIG - Path to a YAML (or JSON) file containing the configuration for Mysql + Path to a YAML (or JSON) file containing the configuration for MySQL Source Config. The JSON file is formatted as follows, with snake_case field naming: @@ -255,6 +261,34 @@ FLAGS } } + --postgresql-source-config=POSTGRESQL_SOURCE_CONFIG + Path to a YAML (or JSON) file containing the configuration for + PostgreSQL Source Config. + + The JSON file is formatted as follows, with snake_case field naming: + + { + "include_objects": {}, + "exclude_objects": { + "postgresql_schemas": [ + { + "schema": "SAMPLE", + "postgresql_tables": [ + { + "table": "SAMPLE_TABLE", + "postgresql_columns": [ + { + "column": "COL", + } + ] + } + ] + } + ] + }, + "publication": "SAMPLE_PUBLICATION" + } + 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/dns/managed-zones/get-iam-policy b/gcloud/dns/managed-zones/get-iam-policy new file mode 100644 index 000000000..ad7103bd7 --- /dev/null +++ b/gcloud/dns/managed-zones/get-iam-policy @@ -0,0 +1,47 @@ +NAME + gcloud dns managed-zones get-iam-policy - get the IAM policy for a Cloud + DNS managed-zone + +SYNOPSIS + gcloud dns managed-zones get-iam-policy ZONE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + This command displays the IAM policy of the specified managed-zone. + +EXAMPLES + To view the details of your managed-zone IAM policy , run: + + $ gcloud dns managed-zones get-iam-policy my-zone + +POSITIONAL ARGUMENTS + Zone resource - The name of the managed-zone to get 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 zone 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. + + ZONE + ID of the zone or fully qualified identifier for the zone. To set the + zone attribute: + ▸ provide the argument zone 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 dns managed-zones get-iam-policy + + $ gcloud beta dns managed-zones get-iam-policy + diff --git a/gcloud/dns/managed-zones/help b/gcloud/dns/managed-zones/help index 238b5eb62..9f7fb7383 100644 --- a/gcloud/dns/managed-zones/help +++ b/gcloud/dns/managed-zones/help @@ -43,9 +43,15 @@ COMMANDS describe View the details of a Cloud DNS managed-zone. + get-iam-policy + Get the IAM policy for a Cloud DNS managed-zone. + list View the list of all your managed-zones. + set-iam-policy + Set the IAM policy for a Cloud DNS managed-zone. + update Update an existing Cloud DNS managed-zone. diff --git a/gcloud/dns/managed-zones/set-iam-policy b/gcloud/dns/managed-zones/set-iam-policy new file mode 100644 index 000000000..4b09e78f7 --- /dev/null +++ b/gcloud/dns/managed-zones/set-iam-policy @@ -0,0 +1,53 @@ +NAME + gcloud dns managed-zones set-iam-policy - set the IAM policy for a Cloud + DNS managed-zone + +SYNOPSIS + gcloud dns managed-zones set-iam-policy ZONE --policy-file=POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + This command sets the IAM policy of the specified managed-zone. + +EXAMPLES + To set the IAM policy of your managed-zone , run: + + $ gcloud dns managed-zones set-iam-policy my-zone \ + --policy-file=policy.json + +POSITIONAL ARGUMENTS + Zone resource - The name of the managed-zone 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 zone 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. + + ZONE + ID of the zone or fully qualified identifier for the zone. To set the + zone attribute: + ▸ provide the argument zone on the command line. + +REQUIRED FLAGS + --policy-file=POLICY_FILE + JSON or YAML file with 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 + These variants are also available: + + $ gcloud alpha dns managed-zones set-iam-policy + + $ gcloud beta dns managed-zones set-iam-policy + diff --git a/gcloud/iam/help b/gcloud/iam/help index 60b039823..9d77a1607 100644 --- a/gcloud/iam/help +++ b/gcloud/iam/help @@ -27,6 +27,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + policies + Manage IAM deny policies. + roles Create and manipulate roles. diff --git a/gcloud/iam/policies/create b/gcloud/iam/policies/create new file mode 100644 index 000000000..e02397f14 --- /dev/null +++ b/gcloud/iam/policies/create @@ -0,0 +1,52 @@ +NAME + gcloud iam policies create - create a policy on the given attachment point + with the given name + +SYNOPSIS + gcloud iam policies create POLICY_ID --attachment-point=ATTACHMENT_POINT + --kind=KIND --policy-file=POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a policy on the given attachment point with the given name. + +EXAMPLES + The following command creates the IAM policy defined at the resource + project 123 of kind denypolicies and id my-deny-policy from the file + policy.json: + + $ gcloud iam policies create my-deny-policy \ + --attachment-point=cloudresourcemanager.googleapis.com/\ + projects/123 --kind=denypolicies --policy-file=policy.json + +POSITIONAL ARGUMENTS + POLICY_ID + Policy ID that is unique for the resource to which the policy is + attached. + +REQUIRED FLAGS + --attachment-point=ATTACHMENT_POINT + Resource to which the policy is attached. For valid formats, see + https://cloud.google.com/iam/help/deny/attachment-point. + + --kind=KIND + Policy type. Use denypolicies for deny policies. + + --policy-file=POLICY_FILE + Path to the file that contains the policy, in JSON or YAML format. For + valid syntax, see https://cloud.google.com/iam/help/deny/policy-syntax. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 iam policies create + + $ gcloud beta iam policies create + diff --git a/gcloud/iam/policies/delete b/gcloud/iam/policies/delete new file mode 100644 index 000000000..973a767ec --- /dev/null +++ b/gcloud/iam/policies/delete @@ -0,0 +1,52 @@ +NAME + gcloud iam policies delete - delete a policy on the given attachment point + with the given name + +SYNOPSIS + gcloud iam policies delete POLICY_ID --attachment-point=ATTACHMENT_POINT + --kind=KIND [--etag=ETAG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a policy on the given attachment point with the given name. + +EXAMPLES + The following command deletes the IAM policy defined at the resource + project 123 of kind denypolicies and id my-deny-policy, with etag abc: + + $ gcloud iam policies delete my-deny-policy \ + --attachment-point=cloudresourcemanager.googleapis.com/\ + projects/123 --kind=denypolicies --etag=abc + +POSITIONAL ARGUMENTS + POLICY_ID + Policy ID that is unique for the resource to which the policy is + attached. + +REQUIRED FLAGS + --attachment-point=ATTACHMENT_POINT + Resource to which the policy is attached. For valid formats, see + https://cloud.google.com/iam/help/deny/attachment-point. + + --kind=KIND + Policy type. Use denypolicies for deny policies. + +OPTIONAL FLAGS + --etag=ETAG + Etag that identifies the version of the existing policy. If omitted, + the policy is deleted regardless of its current etag. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 iam policies delete + + $ gcloud beta iam policies delete + diff --git a/gcloud/iam/policies/get b/gcloud/iam/policies/get new file mode 100644 index 000000000..d29e619f0 --- /dev/null +++ b/gcloud/iam/policies/get @@ -0,0 +1,47 @@ +NAME + gcloud iam policies get - get a policy on the given attachment point with + the given name + +SYNOPSIS + gcloud iam policies get POLICY_ID --attachment-point=ATTACHMENT_POINT + --kind=KIND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get a policy on the given attachment point with the given name. + +EXAMPLES + The following command gets the IAM policy defined at the resource project + 123 of kind denypolicies and id my-deny-policy: + + $ gcloud iam policies get my-deny-policy \ + --attachment-point=cloudresourcemanager.googleapis.com/\ + projects/123 --kind=denypolicies + +POSITIONAL ARGUMENTS + POLICY_ID + Policy ID that is unique for the resource to which the policy is + attached. + +REQUIRED FLAGS + --attachment-point=ATTACHMENT_POINT + Resource to which the policy is attached. For valid formats, see + https://cloud.google.com/iam/help/deny/attachment-point. + + --kind=KIND + Policy type. Use denypolicies for deny policies. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 iam policies get + + $ gcloud beta iam policies get + diff --git a/gcloud/iam/policies/help b/gcloud/iam/policies/help new file mode 100644 index 000000000..99a34f039 --- /dev/null +++ b/gcloud/iam/policies/help @@ -0,0 +1,39 @@ +NAME + gcloud iam policies - manage IAM deny policies + +SYNOPSIS + gcloud iam policies COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Commands for managing Google Cloud IAM deny policies. + +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 policy on the given attachment point with the given name. + + delete + Delete a policy on the given attachment point with the given name. + + get + Get a policy on the given attachment point with the given name. + + list + List the policies on the given attachment point. + + update + Update the policy on the given attachment point with the given name. + +NOTES + These variants are also available: + + $ gcloud alpha iam policies + + $ gcloud beta iam policies + diff --git a/gcloud/iam/policies/list b/gcloud/iam/policies/list new file mode 100644 index 000000000..fd2c28bf4 --- /dev/null +++ b/gcloud/iam/policies/list @@ -0,0 +1,73 @@ +NAME + gcloud iam policies list - list the policies on the given attachment point + +SYNOPSIS + gcloud iam policies list --attachment-point=ATTACHMENT_POINT --kind=KIND + [--page_token=PAGE_TOKEN] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the policies on the given attachment point. + +EXAMPLES + The following command lists the IAM policy defined at the resource project + 123 of kind denypolicies: + + $ gcloud iam policies list \ + --attachment-point=cloudresourcemanager.googleapis.com/\ + projects/123 --kind=denypolicies + +REQUIRED FLAGS + --attachment-point=ATTACHMENT_POINT + Resource to which the policy is attached. For valid formats, see + https://cloud.google.com/iam/help/deny/attachment-point. + + --kind=KIND + Policy type. Use denypolicies for deny policies. + +FLAGS + --page_token=PAGE_TOKEN + Page token received from a previous call. Provide this token to + retrieve the next page. + +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 + These variants are also available: + + $ gcloud alpha iam policies list + + $ gcloud beta iam policies list + diff --git a/gcloud/iam/policies/update b/gcloud/iam/policies/update new file mode 100644 index 000000000..2f002d5be --- /dev/null +++ b/gcloud/iam/policies/update @@ -0,0 +1,51 @@ +NAME + gcloud iam policies update - update the policy on the given attachment + point with the given name + +SYNOPSIS + gcloud iam policies update POLICY_ID --attachment-point=ATTACHMENT_POINT + --kind=KIND --policy-file=POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update the policy on the given attachment point with the given name. + +EXAMPLES + The following command updates the IAM policy defined at the resource + project 123 of kind denypolicies and id my-deny-policy: + + $ gcloud iam policies update my-deny-policy \ + --attachment-point=cloudresourcemanager.googleapis.com/\ + projects/123 --kind=denypolicies --policy-file=policy.json + +POSITIONAL ARGUMENTS + POLICY_ID + Policy ID that is unique for the resource to which the policy is + attached. + +REQUIRED FLAGS + --attachment-point=ATTACHMENT_POINT + Resource to which the policy is attached. For valid formats, see + https://cloud.google.com/iam/help/deny/attachment-point. + + --kind=KIND + Policy type. Use denypolicies for deny policies. + + --policy-file=POLICY_FILE + Path to the file that contains the policy, in JSON or YAML format. For + valid syntax, see https://cloud.google.com/iam/help/deny/policy-syntax. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 iam policies update + + $ gcloud beta iam policies update + diff --git a/gcloud/run/deploy b/gcloud/run/deploy index 592fd52c7..9b54835f9 100644 --- a/gcloud/run/deploy +++ b/gcloud/run/deploy @@ -366,7 +366,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/run/services/update b/gcloud/run/services/update index 3cfacdaa6..a8aedd813 100644 --- a/gcloud/run/services/update +++ b/gcloud/run/services/update @@ -202,7 +202,8 @@ FLAGS Justification to bypass Binary Authorization policy constraints and allow the operation. See https://cloud.google.com/binary-authorization/docs/using-breakglass - for more information. + for more information. Next update or deploy command will + automatically clear existing breakglass justification. --clear-vpc-connector Remove the VPC connector for this resource. diff --git a/gcloud/scc/notifications/describe b/gcloud/scc/notifications/describe index d1c89ce18..fa6f52831 100644 --- a/gcloud/scc/notifications/describe +++ b/gcloud/scc/notifications/describe @@ -4,18 +4,33 @@ NAME SYNOPSIS gcloud scc notifications describe NOTIFICATION_CONFIG_ID - [--organization=ORGANIZATION] [GCLOUD_WIDE_FLAG ...] + [--folder=FOLDER | --organization=ORGANIZATION | --project=PROJECT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Describe a Cloud Security Command Center notification config. EXAMPLES - Describe notification config 'my-config' from organization 123456 + Describe notification config 'my-config' from organization 123 - $ gcloud scc notifications describe my-config --organization=123456 + $ gcloud scc notifications describe notifications describe \ + my-config --organization=123 + $ gcloud scc notifications describe notifications describe \ + organizations/123/notificationConfigs/my-config - $ gcloud scc notifications describe \ - organizations/123456/notificationConfigs/my-config + Describe notification config 'my-config' from folder 456 + + $ gcloud scc notifications describe notifications describe \ + my-config --folder=456 + $ gcloud scc notifications describe notifications describe \ + folders/456/notificationConfigs/my-config + + Describe notification config 'my-config' from project 789 + + $ gcloud scc notifications describe notifications describe \ + my-config --project=789 + $ gcloud scc notifications describe notifications describe \ + projects/789/notificationConfigs/my-config POSITIONAL ARGUMENTS NOTIFICATION_CONFIG_ID @@ -23,10 +38,19 @@ POSITIONAL ARGUMENTS "organizations/123/notificationConfigs/456" or just "456". FLAGS - --organization=ORGANIZATION - The organization where the notification config resides. Formatted as - "organizations/123" or just "123". Required if notificationConfigId - does not contain organization information. + At most one of these can be specified: + + --folder=FOLDER + Folder where the notification config resides. Formatted as + folders/456 or just 456. + + --organization=ORGANIZATION + Organization where the notification config resides. Formatted as + organizations/123 or just 123. + + --project=PROJECT + Project (ID or number) where the notification config resides. + Formatted as projects/789 or just 789. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/transfer/agents/install b/gcloud/transfer/agents/install index 02ef8ed0a..a4b43d531 100644 --- a/gcloud/transfer/agents/install +++ b/gcloud/transfer/agents/install @@ -77,8 +77,9 @@ OPTIONAL FLAGS logs (either /tmp or what you've specified for --logs-directory) and your Google credentials file for agent authentication. - If this flag is not specified, gcloud transfer will mount your entire - filesystem to the agent container. + It is strongly recommended that you use this flag. If this flag isn't + specified, gcloud transfer will mount your entire filesystem to the + agent container and give the agent root access. --proxy=PROXY Specify the HTTP URL and port of a proxy server if you want to use a