diff --git a/gcloud/_version b/gcloud/_version index 25dfb0fe4..1daf73684 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 466.0.0 -alpha 2024.02.26 -beta 2024.02.26 +Google Cloud SDK 467.0.0 +alpha 2024.02.29 +beta 2024.02.29 bq 2.0.101 -bundled-python3-unix 3.11.7 -core 2024.02.26 +bundled-python3-unix 3.11.8 +core 2024.02.29 gcloud-crc32c 1.0.0 gsutil 5.27 diff --git a/gcloud/alpha/bigtable/help b/gcloud/alpha/bigtable/help index c18d6657f..f7b044f15 100644 --- a/gcloud/alpha/bigtable/help +++ b/gcloud/alpha/bigtable/help @@ -33,6 +33,9 @@ GROUPS operations (ALPHA) Manage Cloud Bigtable operations. + tables + (ALPHA) Query Cloud Bigtable tables. + NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/bigtable/instances/tables/create b/gcloud/alpha/bigtable/instances/tables/create index f79a6e7d6..505d4c037 100644 --- a/gcloud/alpha/bigtable/instances/tables/create +++ b/gcloud/alpha/bigtable/instances/tables/create @@ -6,7 +6,8 @@ SYNOPSIS gcloud alpha bigtable instances tables create (TABLE : --instance=INSTANCE) --column-families=[COLUMN_FAMILIES,...] [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD] - [--deletion-protection] [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + [--deletion-protection] [--enable-automated-backup] + [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a new Cloud Bigtable table. @@ -59,6 +60,14 @@ EXAMPLES --instance=my-instance --column-families="my-family" \ --no-deletion-protection + To create a table my-table with automated backup policy + (retention_period=72h, frequency=24h) enabled in instance my-instance with + a column family my-family, run: + + $ gcloud alpha bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --enable-automated-backup + POSITIONAL ARGUMENTS Table resource - Cloud Bigtable table to create. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some @@ -107,6 +116,10 @@ OPTIONAL FLAGS --deletion-protection Once specified, the table is deletion protected. + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + --splits=[SPLITS,...] Row keys where the table should initially be split. For example: car,key diff --git a/gcloud/alpha/bigtable/instances/tables/update b/gcloud/alpha/bigtable/instances/tables/update index 6a63ffd0d..42277eec2 100644 --- a/gcloud/alpha/bigtable/instances/tables/update +++ b/gcloud/alpha/bigtable/instances/tables/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha bigtable instances tables update (TABLE : --instance=INSTANCE) - [--async] [--deletion-protection] + [--async] [--deletion-protection] [--disable-automated-backup] + [--enable-automated-backup] [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...] @@ -34,6 +35,17 @@ EXAMPLES $ gcloud alpha bigtable instances tables update my-table \ --instance=my-instance --clear-change-stream-retention-period + To enable default automated backup policy (retention_period=72h, + frequency=24h), run: + + $ gcloud alpha bigtable instances tables update my-table \ + --instance=my-instance --enable-automated-backup + + To disable automated backup: run: + + $ gcloud alpha bigtable instances tables update my-table \ + --instance=my-instance --disable-automated-backup + POSITIONAL ARGUMENTS Table resource - Cloud Bigtable table to update. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some @@ -73,6 +85,13 @@ FLAGS --deletion-protection Once specified, the table is deletion protected. + --disable-automated-backup + Once set, disables automated backup policy for the table. + + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + At most one of these can be specified: --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD diff --git a/gcloud/alpha/bigtable/tables/add-iam-policy-binding b/gcloud/alpha/bigtable/tables/add-iam-policy-binding new file mode 100644 index 000000000..5474ac1c8 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/add-iam-policy-binding @@ -0,0 +1,148 @@ +NAME + gcloud alpha bigtable tables add-iam-policy-binding - add an IAM policy + binding to a Cloud Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables add-iam-policy-binding + (TABLE : --instance=INSTANCE) --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Add an IAM policy binding to a Cloud Bigtable table. One binding + consists of a member, a role, and an optional condition. + +EXAMPLES + To add an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run: + + $ gcloud alpha bigtable tables add-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To add an IAM policy binding which expires at the end of the year 2019 for + the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' with + table 'my-table' in instance 'my-instance', run: + + $ gcloud alpha bigtable tables add-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/bigtable.admin' \ + --condition='expression=request.time < + timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\ + tion=Expires at midnight on 2019-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to add the 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 table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables add-iam-policy-binding + + $ gcloud beta bigtable tables add-iam-policy-binding + diff --git a/gcloud/alpha/bigtable/tables/config/export b/gcloud/alpha/bigtable/tables/config/export new file mode 100644 index 000000000..4d99b3ef8 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/config/export @@ -0,0 +1,103 @@ +NAME + gcloud alpha bigtable tables config export - export the configuration for a + Cloud Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables config export + ([TABLE : --instance=INSTANCE] --all) [--path=PATH; default="-"] + [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) gcloud alpha bigtable tables config export exports the + configuration for a Cloud Bigtable table. + + Table configurations can be exported in Kubernetes Resource Model (krm) or + Terraform HCL formats. The default format is krm. + + Specifying --all allows you to export the configurations for all tables + within the project. + + Specifying --path allows you to export the configuration(s) to a local + directory. + +EXAMPLES + To export the configuration for a table, run: + + $ gcloud alpha bigtable tables config export my-table + + To export the configuration for a table to a file, run: + + $ gcloud alpha bigtable tables config export my-table \ + --path=/path/to/dir/ + + To export the configuration for a table in Terraform HCL format, run: + + $ gcloud alpha bigtable tables config export my-table \ + --resource-format=terraform + + To export the configurations for all tables within a project, run: + + $ gcloud alpha bigtable tables config export --all + +POSITIONAL ARGUMENTS + Exactly one of these must be specified: + + Table resource - Table to export the configuration for. The arguments in + this group can be used to specify the attributes of this resource. + (NOTE) Some attributes are not given arguments in this group but can be + set in other ways. + + To set the project attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --project on the command line; + ▸ set the property core/project. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▫ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▫ provide the argument table on the command line with a fully + specified name; + ▫ provide the argument --instance on the command line. + + --all + Retrieve all resources within the project. If --path is specified and + is a valid directory, resources will be output as individual files + based on resource name and scope. If --path is not specified, + resources will be streamed to stdout. + +FLAGS + --path=PATH; default="-" + Path of the directory or file to output configuration(s). To output + configurations to stdout, specify "--path=-". + + --resource-format=RESOURCE_FORMAT + Format of the configuration to export. Available configuration formats + are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). + Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, + terraform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/bigtable/tables/config/help b/gcloud/alpha/bigtable/tables/config/help new file mode 100644 index 000000000..522c17c45 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/config/help @@ -0,0 +1,27 @@ +NAME + gcloud alpha bigtable tables config - manage Cloud Bigtable table + configurations + +SYNOPSIS + gcloud alpha bigtable tables config COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Cloud Bigtable table configurations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + export + (ALPHA) Export the configuration for a Cloud Bigtable table. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/bigtable/tables/create b/gcloud/alpha/bigtable/tables/create new file mode 100644 index 000000000..2819c554d --- /dev/null +++ b/gcloud/alpha/bigtable/tables/create @@ -0,0 +1,147 @@ +NAME + gcloud alpha bigtable tables create - create a new Cloud Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables create (TABLE : --instance=INSTANCE) + --column-families=[COLUMN_FAMILIES,...] + [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD] + [--deletion-protection] [--enable-automated-backup] + [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a new Cloud Bigtable table. + +EXAMPLES + To create a table my-table in instance my-instance with a column family + my-family, run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" + + To create a table that has a column family named my-instance, a garbage + collection policy that lets data expire after 864,000 seconds, and initial + table splits on row keys car and key, run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance \ + --column-families="my-family:maxage=864000s" --splits=car,key + + To create a table my-table in instance my-instance that lets data in column + family my-family1 expire after 10 days and keeps a maximum of 5 cells per + column in column family my-family-2 if the data is less than 5 days old, + run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance \ + --column-families="my-family-1:maxage=10d,my-family-2:maxversion\ + s=5||maxage=5d" + + To create a table my-table that has one column family my-family that lets + data expire after 10 days, and to enable a change stream for the table to + be kept for 7 days, run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance \ + --column-families="my-family:maxage=10d" \ + --change-stream-retention-period=7d + + To create a deletion-protected table my-table in instance my-instance with + a column family my-family, run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --deletion-protection + + To create a table my-table without deletion protection in instance + my-instance with a column family my-family, run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --no-deletion-protection + + To create a table my-table with automated backup policy + (retention_period=72h, frequency=24h) enabled in instance my-instance with + a column family my-family, run: + + $ gcloud alpha bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --enable-automated-backup + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to create. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --column-families=[COLUMN_FAMILIES,...] + A double-quote (") wrapped list of family name and corresponding + garbage collection rules concatenated by :, where the rules are + optional. For example: \ + "family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5" + +OPTIONAL FLAGS + --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + The length of time to retain change stream data for the table, in the + range of [1 day, 7 days]. Acceptable units are days (d), hours (h), + minutes (m), and seconds (s). Passing in a value for this option + enables a change stream for the table. Examples: 5d or 48h. + + --deletion-protection + Once specified, the table is deletion protected. + + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + + --splits=[SPLITS,...] + Row keys where the table should initially be split. For example: + car,key + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables create + + $ gcloud beta bigtable tables create + diff --git a/gcloud/alpha/bigtable/tables/delete b/gcloud/alpha/bigtable/tables/delete new file mode 100644 index 000000000..9445cd5da --- /dev/null +++ b/gcloud/alpha/bigtable/tables/delete @@ -0,0 +1,68 @@ +NAME + gcloud alpha bigtable tables delete - delete a Cloud Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables delete (TABLE : --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Cloud Bigtable table. + +EXAMPLES + To delete the table my-table in instance my-instance, run: + + $ gcloud alpha bigtable tables delete my-table --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to delete. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables delete + + $ gcloud beta bigtable tables delete + diff --git a/gcloud/alpha/bigtable/tables/describe b/gcloud/alpha/bigtable/tables/describe new file mode 100644 index 000000000..ebfd95eeb --- /dev/null +++ b/gcloud/alpha/bigtable/tables/describe @@ -0,0 +1,89 @@ +NAME + gcloud alpha bigtable tables describe - retrieve information about a table + +SYNOPSIS + gcloud alpha bigtable tables describe (TABLE : --instance=INSTANCE) + [--view=VIEW; default="schema"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Retrieve information about a table. + +EXAMPLES + To describe a table, run: + + $ gcloud alpha bigtable tables describe TABLE_NAME \ + --instance=INSTANCE_NAME + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to describe. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --view=VIEW; default="schema" + The view to be applied to the returned table's fields. VIEW must be one + of: + + encryption + Only populates name and fields related to the table's encryption + status. + full + Populates all fields. + name + Only populates name. + replication + Only populates name and fields related to the table's replication. + schema + Only populates name and fields related to the table's schema. + stats + Only populates name and fields related to the table's statistics + (e.g. TableStats and ColumnFamilyStats). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables describe + + $ gcloud beta bigtable tables describe + diff --git a/gcloud/alpha/bigtable/tables/get-iam-policy b/gcloud/alpha/bigtable/tables/get-iam-policy new file mode 100644 index 000000000..0db601a52 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/get-iam-policy @@ -0,0 +1,101 @@ +NAME + gcloud alpha bigtable tables get-iam-policy - get an IAM policy on a Cloud + Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables get-iam-policy (TABLE : --instance=INSTANCE) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get an IAM policy on a Cloud Bigtable table. + +EXAMPLES + To get the IAM policy on the table 'my-table' in instance 'my-instance', + run: + + $ gcloud alpha bigtable tables get-iam-policy my-table \ + --instance='my-instance' + + See https://cloud.google.com/iam/docs/managing-policies for more + information. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to get the IAM policy for. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables get-iam-policy + + $ gcloud beta bigtable tables get-iam-policy + diff --git a/gcloud/alpha/bigtable/tables/help b/gcloud/alpha/bigtable/tables/help new file mode 100644 index 000000000..55ab65233 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/help @@ -0,0 +1,66 @@ +NAME + gcloud alpha bigtable tables - query Cloud Bigtable tables + +SYNOPSIS + gcloud alpha bigtable tables GROUP | COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Query Cloud Bigtable tables. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + config + (ALPHA) Manage Cloud Bigtable table configurations. + +COMMANDS + COMMAND is one of the following: + + add-iam-policy-binding + (ALPHA) Add an IAM policy binding to a Cloud Bigtable table. + + create + (ALPHA) Create a new Cloud Bigtable table. + + delete + (ALPHA) Delete a Cloud Bigtable table. + + describe + (ALPHA) Retrieve information about a table. + + get-iam-policy + (ALPHA) Get an IAM policy on a Cloud Bigtable table. + + list + (ALPHA) List existing Bigtable instance tables. + + remove-iam-policy-binding + (ALPHA) Remove an IAM policy binding from a Cloud Bigtable table. + + restore + (ALPHA) Restore a Cloud Bigtable backup to a new table. + + set-iam-policy + (ALPHA) Set an IAM policy on a Cloud Bigtable table. + + undelete + (ALPHA) Undelete a previously deleted Cloud Bigtable table. + + update + (ALPHA) Update an existing Cloud Bigtable table. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables + + $ gcloud beta bigtable tables + diff --git a/gcloud/alpha/bigtable/tables/list b/gcloud/alpha/bigtable/tables/list new file mode 100644 index 000000000..3626465a9 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/list @@ -0,0 +1,70 @@ +NAME + gcloud alpha bigtable tables list - list existing Bigtable instance tables + +SYNOPSIS + gcloud alpha bigtable tables list --instances=[INSTANCE,...] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To list all tables in an instance, run: + + $ gcloud alpha bigtable tables list --instances=INSTANCE_NAME + + To list all tables in several instances, run: $ gcloud alpha bigtable tables list \ + --instances=INSTANCE_NAME1,INSTANCE_NAME2 + +REQUIRED FLAGS + --instances=[INSTANCE,...] + ID of the instances. + +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. These variants are also available: + + $ gcloud bigtable tables list + + $ gcloud beta bigtable tables list + diff --git a/gcloud/alpha/bigtable/tables/remove-iam-policy-binding b/gcloud/alpha/bigtable/tables/remove-iam-policy-binding new file mode 100644 index 000000000..4239f881b --- /dev/null +++ b/gcloud/alpha/bigtable/tables/remove-iam-policy-binding @@ -0,0 +1,153 @@ +NAME + gcloud alpha bigtable tables remove-iam-policy-binding - remove an IAM + policy binding from a Cloud Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables remove-iam-policy-binding + (TABLE : --instance=INSTANCE) --member=PRINCIPAL --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Remove an IAM policy binding from a Cloud Bigtable table. One + binding consists of a member, a role, and an optional condition. + +EXAMPLES + To remove an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run: + + $ gcloud alpha bigtable tables remove-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To remove an IAM policy binding which expires at the end of the year 2019 + for the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' + with table 'my-table' in instance 'my-instance', run: + + $ gcloud alpha bigtable tables remove-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/bigtable.admin' \ + --condition='expression=request.time < + timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\ + tion=Expires at midnight on 2019-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to remove the 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 table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables remove-iam-policy-binding + + $ gcloud beta bigtable tables remove-iam-policy-binding + diff --git a/gcloud/alpha/bigtable/tables/restore b/gcloud/alpha/bigtable/tables/restore new file mode 100644 index 000000000..025312b95 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/restore @@ -0,0 +1,125 @@ +NAME + gcloud alpha bigtable tables restore - restore a Cloud Bigtable backup to a + new table + +SYNOPSIS + gcloud alpha bigtable tables restore + (--destination=DESTINATION + : --destination-instance=DESTINATION_INSTANCE) + (--source=SOURCE + : --source-cluster=SOURCE_CLUSTER --source-instance=SOURCE_INSTANCE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) This command restores a Cloud Bigtable backup to a new table. + +EXAMPLES + To restore table 'table2' from backup 'backup1', run: + + $ gcloud alpha bigtable tables restore --source-instance=instance1 \ + --source-cluster=cluster1 --source=backup1 \ + --destination-instance=instance1 --destination=table2 + + To restore table 'table2' from backup 'backup1' in a different project, + run: + + $ gcloud alpha bigtable tables restore \ + --source=projects/project1/instances/instance1/clusters/\ + cluster1/backups/backup1 \ + --destination=projects/project2/instances/instance2/tables/\ + table2 + +REQUIRED FLAGS + Table resource - The destination to restore 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. + + This must be specified. + + --destination=DESTINATION + ID of the table or fully qualified identifier for the table. + + To set the destination attribute: + ▸ provide the argument --destination on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --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; + ▸ provide the argument --destination-instance on the command line; + ▸ provide the argument --source-instance on the command line. + + Backup resource - The source to restore 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. + + This must be specified. + + --source=SOURCE + ID of the backup or fully qualified identifier for the backup. + + To set the source attribute: + ▸ provide the argument --source 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; + ▸ 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; + ▸ provide the argument --source-instance on the command line; + ▸ provide the argument --destination-instance on the command line. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables restore + + $ gcloud beta bigtable tables restore + diff --git a/gcloud/alpha/bigtable/tables/set-iam-policy b/gcloud/alpha/bigtable/tables/set-iam-policy new file mode 100644 index 000000000..f543392bb --- /dev/null +++ b/gcloud/alpha/bigtable/tables/set-iam-policy @@ -0,0 +1,81 @@ +NAME + gcloud alpha bigtable tables set-iam-policy - set an IAM policy on a Cloud + Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables set-iam-policy (TABLE : --instance=INSTANCE) + POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Set an IAM policy on a Cloud Bigtable table. + +EXAMPLES + To set the IAM policy from file 'my-policy' on the table 'my-table' in + instance 'my-instance', run: + + $ gcloud alpha bigtable tables set-iam-policy my-table \ + --instance='my-instance' my-policy + + See https://cloud.google.com/iam/docs/managing-policies for more + information. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to set the IAM policy on. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables set-iam-policy + + $ gcloud beta bigtable tables set-iam-policy + diff --git a/gcloud/alpha/bigtable/tables/undelete b/gcloud/alpha/bigtable/tables/undelete new file mode 100644 index 000000000..926025784 --- /dev/null +++ b/gcloud/alpha/bigtable/tables/undelete @@ -0,0 +1,75 @@ +NAME + gcloud alpha bigtable tables undelete - undelete a previously deleted Cloud + Bigtable table + +SYNOPSIS + gcloud alpha bigtable tables undelete (TABLE : --instance=INSTANCE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Undelete a previously deleted Cloud Bigtable table. + +EXAMPLES + To undelete the table my-table in instance my-instance, run: + + $ gcloud alpha bigtable tables undelete my-table \ + --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to undelete. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables undelete + + $ gcloud beta bigtable tables undelete + diff --git a/gcloud/alpha/bigtable/tables/update b/gcloud/alpha/bigtable/tables/update new file mode 100644 index 000000000..6653ab4aa --- /dev/null +++ b/gcloud/alpha/bigtable/tables/update @@ -0,0 +1,128 @@ +NAME + gcloud alpha bigtable tables update - update an existing Cloud Bigtable + table + +SYNOPSIS + gcloud alpha bigtable tables update (TABLE : --instance=INSTANCE) [--async] + [--deletion-protection] [--disable-automated-backup] + [--enable-automated-backup] + [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update an existing new Cloud Bigtable table with the specified + configuration. + +EXAMPLES + To enable deletion protection, run: + + $ gcloud alpha bigtable tables update my-table \ + --instance=my-instance --deletion-protection + + To disable deletion protection, run: + + $ gcloud alpha bigtable tables update my-table \ + --instance=my-instance --no-deletion-protection + + To enable a change stream with a retention period of 1 day, or to update + your table's change stream retention period to 1 day, run: + + $ gcloud alpha bigtable tables update my-table \ + --instance=my-instance --change-stream-retention-period=1d + + To disable a change stream, run: + + $ gcloud alpha bigtable tables update my-table \ + --instance=my-instance --clear-change-stream-retention-period + + To enable default automated backup policy (retention_period=72h, + frequency=24h), run: + + $ gcloud alpha bigtable tables update my-table \ + --instance=my-instance --enable-automated-backup + + To disable automated backup: run: + + $ gcloud alpha bigtable tables update my-table \ + --instance=my-instance --disable-automated-backup + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to update. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deletion-protection + Once specified, the table is deletion protected. + + --disable-automated-backup + Once set, disables automated backup policy for the table. + + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + + At most one of these can be specified: + + --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + The length of time to retain change stream data for the table, in the + range of [1 day, 7 days]. Acceptable units are days (d), hours (h), + minutes (m), and seconds (s). If not already specified, enables a + change stream for the table. Examples: 5d or 48h. + + --clear-change-stream-retention-period + This disables the change stream and eventually removes the change + stream data. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud bigtable tables update + + $ gcloud beta bigtable tables update + diff --git a/gcloud/alpha/composer/environments/update b/gcloud/alpha/composer/environments/update index b1fbd7a42..004a4c530 100644 --- a/gcloud/alpha/composer/environments/update +++ b/gcloud/alpha/composer/environments/update @@ -11,6 +11,9 @@ SYNOPSIS | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE | --airflow-version=AIRFLOW_VERSION | --image-version=IMAGE_VERSION + | --maintenance-window-end=MAINTENANCE_WINDOW_END + --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE + --maintenance-window-start=MAINTENANCE_WINDOW_START | --disable-cloud-data-lineage-integration | --enable-cloud-data-lineage-integration | --disable-master-authorized-networks @@ -21,9 +24,6 @@ SYNOPSIS --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE --snapshot-location=SNAPSHOT_LOCATION --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE - | --maintenance-window-end=MAINTENANCE_WINDOW_END - --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE - --maintenance-window-start=MAINTENANCE_WINDOW_START | --max-workers=MAX_WORKERS --min-workers=MIN_WORKERS --scheduler-count=SCHEDULER_COUNT --scheduler-cpu=SCHEDULER_CPU --scheduler-memory=SCHEDULER_MEMORY @@ -164,6 +164,43 @@ REQUIRED FLAGS Composer version. The resolved versions are stored in the upgraded environment. + Group of arguments for setting the maintenance window value during + update. + + At most one of these can be specified: + + Group of arguments for setting the maintenance window value. + + --maintenance-window-end=MAINTENANCE_WINDOW_END + End time of the mantenance window in the form of the full date. + Only the time of the day is used as a reference for an ending + time of the window with a provided recurrence. Specified date + must take place after the one specified as a start date, the + difference between will be used as a length of a single + maintenance window. See $ gcloud topic datetimes for information + on time formats. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE + An RFC 5545 RRULE, specifying how the maintenance window will + recur. The minimum requirement for the length of the maintenance + window is 12 hours a week. Only FREQ=DAILY and FREQ=WEEKLY rules + are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --maintenance-window-start=MAINTENANCE_WINDOW_START + Start time of the mantenance window in the form of the full date. + Only the time of the day is used as a reference for a starting + time of the window with a provided recurrence. See $ gcloud topic + datetimes for information on time formats. + + This flag argument must be specified if any of the other + arguments in this group are specified. + Group of arguments for setting Cloud Data Lineage integration configuration in Composer 2. @@ -239,37 +276,6 @@ REQUIRED FLAGS This flag argument must be specified if any of the other arguments in this group are specified. - Group of arguments for setting the maintenance window value. - - --maintenance-window-end=MAINTENANCE_WINDOW_END - End time of the mantenance window in the form of the full date. - Only the time of the day is used as a reference for an ending time - of the window with a provided recurrence. Specified date must take - place after the one specified as a start date, the difference - between will be used as a length of a single maintenance window. - See $ gcloud topic datetimes for information on time formats. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE - An RFC 5545 RRULE, specifying how the maintenance window will - recur. The minimum requirement for the length of the maintenance - window is 12 hours a week. Only FREQ=DAILY and FREQ=WEEKLY rules - are supported. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --maintenance-window-start=MAINTENANCE_WINDOW_START - Start time of the mantenance window in the form of the full date. - Only the time of the day is used as a reference for a starting time - of the window with a provided recurrence. See $ gcloud topic - datetimes for information on time formats. - - This flag argument must be specified if any of the other arguments - in this group are specified. - Group of arguments for setting workloads configuration in Composer 2.X or greater (--scheduler-count flag is available for Composer 1.X as well). diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index 9af9b8f83..6363488e4 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -103,8 +103,9 @@ OPTIONAL FLAGS accelerator-optimized-a3, compute-optimized, compute-optimized-c2d, compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, general-purpose-e2, general-purpose-n2, - general-purpose-n2d, general-purpose-t2d, graphics-optimized, - memory-optimized, memory-optimized-m3, storage-optimized-z3. + general-purpose-n2d, general-purpose-n4, general-purpose-t2d, + graphics-optimized, memory-optimized, memory-optimized-m3, + storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/alpha/compute/future-reservations/create b/gcloud/alpha/compute/future-reservations/create index 1cff3c732..ac529b3d2 100644 --- a/gcloud/alpha/compute/future-reservations/create +++ b/gcloud/alpha/compute/future-reservations/create @@ -14,7 +14,8 @@ SYNOPSIS --min-cpu-platform=MIN_CPU_PLATFORM]) (--start-time=START_TIME (--duration=DURATION | --end-time=END_TIME)) [--description=DESCRIPTION] [--name-prefix=NAME_PREFIX] - [--planning-status=PLANNING_STATUS] [--zone=ZONE] + [--planning-status=PLANNING_STATUS] + [--[no-]require-specific-reservation] [--zone=ZONE] [--auto-created-reservations-delete-time=AUTO_CREATED_RESERVATIONS_DELETE_TIME | --auto-created-reservations-duration=AUTO_CREATED_RESERVATIONS_DURATION] [--share-setting=SHARE_SETTING --share-with=PROJECT,[PROJECT,...]] [GCLOUD_WIDE_FLAG ...] @@ -184,6 +185,15 @@ OPTIONAL FLAGS SUBMITTED Planning status value to immediately submit the future reservation. + --[no-]require-specific-reservation + Indicate whether the auto-created reservations can be consumed by VMs + with "any reservation" defined. If enabled, then only VMs that target + the auto-created reservation by name using + --reservation-affinity=specific can consume from this reservation. + Auto-created reservations delivered with this flag enabled will inherit + the name of the future reservation. Use --require-specific-reservation + to enable and --no-require-specific-reservation to disable. + --zone=ZONE Zone of the future reservation to create. If not specified and the compute/zone property isn't set, you might be prompted to select a zone diff --git a/gcloud/alpha/compute/future-reservations/update b/gcloud/alpha/compute/future-reservations/update index dd4db935e..5ccf36197 100644 --- a/gcloud/alpha/compute/future-reservations/update +++ b/gcloud/alpha/compute/future-reservations/update @@ -6,7 +6,8 @@ SYNOPSIS gcloud alpha compute future-reservations update FUTURE_RESERVATION [--[no-]auto-delete-auto-created-reservations] [--description=DESCRIPTION] [--planning-status=PLANNING_STATUS] - [--total-count=TOTAL_COUNT] [--zone=ZONE] + [--[no-]require-specific-reservation] [--total-count=TOTAL_COUNT] + [--zone=ZONE] [--auto-created-reservations-delete-time=AUTO_CREATED_RESERVATIONS_DELETE_TIME | --auto-created-reservations-duration=AUTO_CREATED_RESERVATIONS_DURATION] [--clear-name-prefix | --name-prefix=NAME_PREFIX] [--clear-share-settings @@ -60,6 +61,15 @@ FLAGS SUBMITTED Planning status value to immediately submit the future reservation. + --[no-]require-specific-reservation + Indicate whether the auto-created reservations can be consumed by VMs + with "any reservation" defined. If enabled, then only VMs that target + the auto-created reservation by name using + --reservation-affinity=specific can consume from this reservation. + Auto-created reservations delivered with this flag enabled will inherit + the name of the future reservation. Use --require-specific-reservation + to enable and --no-require-specific-reservation to disable. + --total-count=TOTAL_COUNT The total number of instances for which capacity assurance is requested at a future time period. diff --git a/gcloud/alpha/compute/public-delegated-prefixes/update b/gcloud/alpha/compute/public-delegated-prefixes/update index e7827e8b0..200b625a9 100644 --- a/gcloud/alpha/compute/public-delegated-prefixes/update +++ b/gcloud/alpha/compute/public-delegated-prefixes/update @@ -48,5 +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. + access allowlist. These variants are also available: + + $ gcloud compute public-delegated-prefixes update + + $ gcloud beta compute public-delegated-prefixes update diff --git a/gcloud/alpha/compute/tpus/queued-resources/create b/gcloud/alpha/compute/tpus/queued-resources/create index 15183ae27..338e2297a 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/create +++ b/gcloud/alpha/compute/tpus/queued-resources/create @@ -301,5 +301,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources create diff --git a/gcloud/alpha/compute/tpus/queued-resources/delete b/gcloud/alpha/compute/tpus/queued-resources/delete index 697dbfd4e..494def5aa 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/delete +++ b/gcloud/alpha/compute/tpus/queued-resources/delete @@ -82,5 +82,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources delete diff --git a/gcloud/alpha/compute/tpus/queued-resources/describe b/gcloud/alpha/compute/tpus/queued-resources/describe index 8a8c1c68a..098282e2c 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/describe +++ b/gcloud/alpha/compute/tpus/queued-resources/describe @@ -71,5 +71,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources describe diff --git a/gcloud/alpha/compute/tpus/queued-resources/help b/gcloud/alpha/compute/tpus/queued-resources/help index 6ccbc071d..9938912c4 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/help +++ b/gcloud/alpha/compute/tpus/queued-resources/help @@ -41,5 +41,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources diff --git a/gcloud/alpha/compute/tpus/queued-resources/list b/gcloud/alpha/compute/tpus/queued-resources/list index 348167dd0..da66cde94 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/list +++ b/gcloud/alpha/compute/tpus/queued-resources/list @@ -88,5 +88,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources list diff --git a/gcloud/alpha/compute/tpus/queued-resources/reset b/gcloud/alpha/compute/tpus/queued-resources/reset index 130e2e749..cc6f7cef7 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/reset +++ b/gcloud/alpha/compute/tpus/queued-resources/reset @@ -75,5 +75,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources reset diff --git a/gcloud/alpha/compute/tpus/queued-resources/scp b/gcloud/alpha/compute/tpus/queued-resources/scp index d73e84378..b70782baa 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/scp +++ b/gcloud/alpha/compute/tpus/queued-resources/scp @@ -203,5 +203,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources scp diff --git a/gcloud/alpha/compute/tpus/queued-resources/ssh b/gcloud/alpha/compute/tpus/queued-resources/ssh index 3b88e908d..5ae90b611 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/ssh +++ b/gcloud/alpha/compute/tpus/queued-resources/ssh @@ -234,5 +234,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud compute tpus queued-resources ssh diff --git a/gcloud/alpha/container/binauthz/attestors/create b/gcloud/alpha/container/binauthz/attestors/create index 6ade9d1a3..d3df610cd 100644 --- a/gcloud/alpha/container/binauthz/attestors/create +++ b/gcloud/alpha/container/binauthz/attestors/create @@ -7,12 +7,15 @@ SYNOPSIS : --attestation-authority-note-project=ATTESTATION_AUTHORITY_NOTE_PROJECT) [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] +DESCRIPTION + (ALPHA) Create an Attestor. + EXAMPLES To create an Attestor with an existing Note projects/my_proj/notes/my_note: $ gcloud alpha container binauthz attestors create my_new_attestor \ --attestation-authority-note=my_note \ - --attestation-authority-note-project=my_proj \ + --attestation-authority-note-project=my_proj POSITIONAL ARGUMENTS Attestor resource - The attestor to be created. This represents a Cloud diff --git a/gcloud/alpha/container/clusters/update b/gcloud/alpha/container/clusters/update index d06401028..e92aa1410 100644 --- a/gcloud/alpha/container/clusters/update +++ b/gcloud/alpha/container/clusters/update @@ -20,10 +20,11 @@ SYNOPSIS | --enable-l4-ilb-subsetting | --enable-legacy-authorization | --enable-logging-monitoring-system-only | --enable-master-authorized-networks | --enable-master-global-access - | --enable-network-policy | --enable-pod-security-policy - | --enable-private-endpoint | --enable-secret-manager - | --enable-service-externalips | --enable-shielded-nodes - | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling + | --enable-multi-networking | --enable-network-policy + | --enable-pod-security-policy | --enable-private-endpoint + | --enable-secret-manager | --enable-service-externalips + | --enable-shielded-nodes | --enable-stackdriver-kubernetes + | --enable-vertical-pod-autoscaling | --fleet-project=PROJECT_ID_OR_NUMBER | --gateway-api=GATEWAY_API | --generate-password | --identity-provider=IDENTITY_PROVIDER | --in-transit-encryption=IN_TRANSIT_ENCRYPTION @@ -359,6 +360,10 @@ REQUIRED FLAGS endpoint from any Google Cloud region or on-premises environment regardless of the private cluster's region. + --enable-multi-networking + Enables multi-networking on the cluster. Multi-networking is disabled + by default. + --enable-network-policy Enable network policy enforcement for this cluster. If you are enabling network policy on an existing cluster the network policy diff --git a/gcloud/alpha/filestore/instances/create b/gcloud/alpha/filestore/instances/create index a3f022c57..7fc68dc5a 100644 --- a/gcloud/alpha/filestore/instances/create +++ b/gcloud/alpha/filestore/instances/create @@ -104,7 +104,9 @@ REQUIRED FLAGS ▫ 1TB-9.75TB in 256GB increments or its multiples. ▫ 10TB-100TB in 2.5TB increments or its multiples. ▸ ENTERPRISE: 1TB-10TB in 256GB increments or its multiples. - ▸ REGIONAL: 1TB-9.75TB in 256GB increments or its multiples. + ▸ REGIONAL: 1TB-100TB: + ▫ 1TB-9.75TB in 256GB increments or its multiples. + ▫ 10TB-100TB in 2.5TB increments or its multiples. name The desired logical name of the volume. @@ -154,15 +156,15 @@ REQUIRED FLAGS A list of security flavors that are allowed to be used during mount command in NFSv4.1 filestore instances. The security flavors supported are: - ◆ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults to - AUTH_SYS. - ◆ AUTH_SYS: The user's UNIX user-id and group-ids are passed in the - clear. - ◆ KRB5: The end-user authentication is done using Kerberos V5. - ◆ KRB5I: KRB5 plus integrity protection (data packets are tamper - proof). - ◆ KRB5P: KRB5I plus privacy protection (data packets are tamper - proof and encrypted). + ▫ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults + to AUTH_SYS. + ▫ AUTH_SYS: The user's UNIX user-id and group-ids are passed in + the clear. + ▫ KRB5: The end-user authentication is done using Kerberos V5. + ▫ KRB5I: KRB5 plus integrity protection (data packets are + tamper proof). + ▫ KRB5P: KRB5I plus privacy protection (data packets are tamper + proof and encrypted). source-snapshot The name of the snapshot to restore from. Supported for BASIC diff --git a/gcloud/alpha/filestore/instances/update b/gcloud/alpha/filestore/instances/update index 34b1e1313..2ea1ec483 100644 --- a/gcloud/alpha/filestore/instances/update +++ b/gcloud/alpha/filestore/instances/update @@ -154,7 +154,9 @@ FLAGS ▫ 1TB-9.75TB in 256GB increments or its multiples. ▫ 10TB-100TB in 2.5TB increments or its multiples. ▸ ENTERPRISE: 1TB-10TB in 256GB increments or its multiples. - ▸ REGIONAL: 1TB-9.75TB in 256GB increments or its multiples. + ▸ REGIONAL: 1TB-100TB: + ▫ 1TB-9.75TB in 256GB increments or its multiples. + ▫ 10TB-100TB in 2.5TB increments or its multiples. name The desired logical name of the volume. @@ -204,15 +206,15 @@ FLAGS A list of security flavors that are allowed to be used during mount command in NFSv4.1 filestore instances. The security flavors supported are: - ◆ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults to - AUTH_SYS. - ◆ AUTH_SYS: The user's UNIX user-id and group-ids are passed in the - clear. - ◆ KRB5: The end-user authentication is done using Kerberos V5. - ◆ KRB5I: KRB5 plus integrity protection (data packets are tamper - proof). - ◆ KRB5P: KRB5I plus privacy protection (data packets are tamper proof - and encrypted). + ▫ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults + to AUTH_SYS. + ▫ AUTH_SYS: The user's UNIX user-id and group-ids are passed in + the clear. + ▫ KRB5: The end-user authentication is done using Kerberos V5. + ▫ KRB5I: KRB5 plus integrity protection (data packets are + tamper proof). + ▫ KRB5P: KRB5I plus privacy protection (data packets are tamper + proof and encrypted). source-snapshot The name of the snapshot to restore from. Supported for BASIC diff --git a/gcloud/alpha/functions/deploy b/gcloud/alpha/functions/deploy index e6f19399b..5ef7c7acd 100644 --- a/gcloud/alpha/functions/deploy +++ b/gcloud/alpha/functions/deploy @@ -112,8 +112,6 @@ FLAGS If not provided, the function will use the project's default service account for Cloud Build. - Only applicable when the --gen2 flag is provided. - --buildpack-stack=BUILDPACK_STACK Specifies one of the Google provided buildpack stacks. diff --git a/gcloud/alpha/transfer/agents/install b/gcloud/alpha/transfer/agents/install index 916c7706e..06e2b65d3 100644 --- a/gcloud/alpha/transfer/agents/install +++ b/gcloud/alpha/transfer/agents/install @@ -9,7 +9,14 @@ SYNOPSIS [--max-concurrent-small-file-uploads=MAX_CONCURRENT_SMALL_FILE_UPLOADS] [--memlock-limit=MEMLOCK_LIMIT; default=64000000] [--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY] - [--s3-compatible-mode] [GCLOUD_WIDE_FLAG ...] + [--s3-compatible-mode] + [--hdfs-namenode-uri=HDFS_NAMENODE_URI --hdfs-username=HDFS_USERNAME + --hdfs-data-transfer-protection=HDFS_DATA_TRANSFER_PROTECTION] + [--kerberos-config-file=KERBEROS_CONFIG_FILE + --kerberos-keytab-file=KERBEROS_KEYTAB_FILE + --kerberos-user-principal=KERBEROS_USER_PRINCIPAL + --kerberos-service-principal=KERBEROS_SERVICE_PRINCIPAL] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Install Transfer Service agents to enable you to transfer data to @@ -40,7 +47,7 @@ REQUIRED FLAGS creating transfer jobs, the agent pool parameter will determine which agents are activated. -OPTIONAL FLAGS +FLAGS --count=COUNT Specify the number of agents to install on your current machine. System requirements: 8 GB of memory and 4 CPUs per agent. @@ -126,6 +133,43 @@ OPTIONAL FLAGS AWS_ACCESS_KEY_ID="id" AWS_SECRET_ACCESS_KEY="secret" gcloud transfer agents install --s3-compatible-mode +HDFS FLAGS + --hdfs-namenode-uri=HDFS_NAMENODE_URI + A URI representing an HDFS cluster including a schema, namenode, and + port. Examples: "rpc://my-namenode:8020", "http://my-namenode:9870". + + Use "http" or "https" for WebHDFS. If no schema is provided, the CLI + assumes native "rpc". If no port is provided, the default is 8020 for + RPC, 9870 for HTTP, and 9871 for HTTPS. For example, the input + "my-namenode" becomes "rpc://my-namenode:8020". + + --hdfs-username=HDFS_USERNAME + Username for connecting to an HDFS cluster with simple auth. + + --hdfs-data-transfer-protection=HDFS_DATA_TRANSFER_PROTECTION + Client-side quality of protection setting for Kerberized clusters. + Client-side QOP value cannot be more restrictive than the server-side + QOP value. HDFS_DATA_TRANSFER_PROTECTION must be one of: + authentication, integrity, privacy. + +Kerberos FLAGS + --kerberos-config-file=KERBEROS_CONFIG_FILE + Path to Kerberos config file. + + --kerberos-keytab-file=KERBEROS_KEYTAB_FILE + Path to a Keytab file containing the user principal specified with the + --kerberos-user-principal flag. + + --kerberos-user-principal=KERBEROS_USER_PRINCIPAL + Kerberos user principal to use when connecting to an HDFS cluster via + Kerberos auth. + + --kerberos-service-principal=KERBEROS_SERVICE_PRINCIPAL + Kerberos service principal to use, of the form "/". + Realm is mapped from your Kerberos config. Any supplied realm is + ignored. If not passed in, it will default to "hdfs/" + (fqdn = fully qualified domain name). + 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/workstations/configs/create b/gcloud/alpha/workstations/configs/create index 578a034c3..3725b019e 100644 --- a/gcloud/alpha/workstations/configs/create +++ b/gcloud/alpha/workstations/configs/create @@ -141,11 +141,11 @@ FLAGS address. --disable-ssh-to-vm - Default value is False. If set, workstations will disable SSH - connections to the root VM. + Default value is False. If set, workstations disable SSH connections to + the root VM. --disable-tcp-connections - Default value is false. If set, workstations will not allow plain TCP + Default value is false. If set, workstations don't allow plain TCP connections. --enable-audit-agent diff --git a/gcloud/alpha/workstations/configs/update b/gcloud/alpha/workstations/configs/update index 50fd1c83e..d80e56e3d 100644 --- a/gcloud/alpha/workstations/configs/update +++ b/gcloud/alpha/workstations/configs/update @@ -248,22 +248,18 @@ FLAGS At most one of these can be specified: --disable-ssh-to-vm - Default value is False. If set, workstations will enable SSH - connections to the root VM. + If set, workstations disable SSH connections to the root VM. --enable-ssh-to-vm - Default value is False. If set, workstations will enable SSH - connections to the root VM. + If set, workstations enable SSH connections to the root VM. At most one of these can be specified: --disable-tcp-connections - Default value is false. If set, workstations will allow plain TCP - connections. + If set, workstations don't allow plain TCP connections. --enable-tcp-connections - Default value is false. If set, workstations will allow plain TCP - connections. + If set, workstations allow plain TCP connections. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/artifacts/docker/help b/gcloud/artifacts/docker/help index c229fec04..40a3fabb9 100644 --- a/gcloud/artifacts/docker/help +++ b/gcloud/artifacts/docker/help @@ -48,6 +48,9 @@ GROUPS tags Manage Artifact Registry container image tags. + upgrade + Commands to support Container Registry to Artifact Registry upgrade. + NOTES These variants are also available: diff --git a/gcloud/artifacts/docker/upgrade/help b/gcloud/artifacts/docker/upgrade/help new file mode 100644 index 000000000..fb551cf8d --- /dev/null +++ b/gcloud/artifacts/docker/upgrade/help @@ -0,0 +1,24 @@ +NAME + gcloud artifacts docker upgrade - commands to support Container Registry to + Artifact Registry upgrade + +SYNOPSIS + gcloud artifacts docker upgrade COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + To print an equivalent Artifact Registry IAM policy for + 'gcr.io/my-project': + + $ gcloud artifacts docker upgrade print-iam-policy gcr.io \ + --project=my-project + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud beta artifacts docker upgrade + diff --git a/gcloud/beta/artifacts/docker/upgrade/help b/gcloud/beta/artifacts/docker/upgrade/help index b78f1d3c3..3dc94a96c 100644 --- a/gcloud/beta/artifacts/docker/upgrade/help +++ b/gcloud/beta/artifacts/docker/upgrade/help @@ -25,5 +25,8 @@ COMMANDS Artifact Registry upgrade. NOTES - This command is currently in beta and might change without notice. + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud artifacts docker upgrade diff --git a/gcloud/beta/bigtable/help b/gcloud/beta/bigtable/help index cea89fc0d..a51504ef1 100644 --- a/gcloud/beta/bigtable/help +++ b/gcloud/beta/bigtable/help @@ -33,6 +33,9 @@ GROUPS operations (BETA) Manage Cloud Bigtable operations. + tables + (BETA) Query Cloud Bigtable tables. + NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/bigtable/instances/tables/create b/gcloud/beta/bigtable/instances/tables/create index 394b9b96d..8f358679a 100644 --- a/gcloud/beta/bigtable/instances/tables/create +++ b/gcloud/beta/bigtable/instances/tables/create @@ -6,7 +6,8 @@ SYNOPSIS gcloud beta bigtable instances tables create (TABLE : --instance=INSTANCE) --column-families=[COLUMN_FAMILIES,...] [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD] - [--deletion-protection] [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + [--deletion-protection] [--enable-automated-backup] + [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) Create a new Cloud Bigtable table. @@ -59,6 +60,14 @@ EXAMPLES --instance=my-instance --column-families="my-family" \ --no-deletion-protection + To create a table my-table with automated backup policy + (retention_period=72h, frequency=24h) enabled in instance my-instance with + a column family my-family, run: + + $ gcloud beta bigtable instances tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --enable-automated-backup + POSITIONAL ARGUMENTS Table resource - Cloud Bigtable table to create. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some @@ -107,6 +116,10 @@ OPTIONAL FLAGS --deletion-protection Once specified, the table is deletion protected. + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + --splits=[SPLITS,...] Row keys where the table should initially be split. For example: car,key diff --git a/gcloud/beta/bigtable/instances/tables/update b/gcloud/beta/bigtable/instances/tables/update index b214b0f37..cc6b65e52 100644 --- a/gcloud/beta/bigtable/instances/tables/update +++ b/gcloud/beta/bigtable/instances/tables/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta bigtable instances tables update (TABLE : --instance=INSTANCE) - [--async] [--deletion-protection] + [--async] [--deletion-protection] [--disable-automated-backup] + [--enable-automated-backup] [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...] @@ -34,6 +35,17 @@ EXAMPLES $ gcloud beta bigtable instances tables update my-table \ --instance=my-instance --clear-change-stream-retention-period + To enable default automated backup policy (retention_period=72h, + frequency=24h), run: + + $ gcloud beta bigtable instances tables update my-table \ + --instance=my-instance --enable-automated-backup + + To disable automated backup: run: + + $ gcloud beta bigtable instances tables update my-table \ + --instance=my-instance --disable-automated-backup + POSITIONAL ARGUMENTS Table resource - Cloud Bigtable table to update. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some @@ -73,6 +85,13 @@ FLAGS --deletion-protection Once specified, the table is deletion protected. + --disable-automated-backup + Once set, disables automated backup policy for the table. + + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + At most one of these can be specified: --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD diff --git a/gcloud/beta/bigtable/tables/add-iam-policy-binding b/gcloud/beta/bigtable/tables/add-iam-policy-binding new file mode 100644 index 000000000..7241512d4 --- /dev/null +++ b/gcloud/beta/bigtable/tables/add-iam-policy-binding @@ -0,0 +1,146 @@ +NAME + gcloud beta bigtable tables add-iam-policy-binding - add an IAM policy + binding to a Cloud Bigtable table + +SYNOPSIS + gcloud beta bigtable tables add-iam-policy-binding + (TABLE : --instance=INSTANCE) --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Add an IAM policy binding to a Cloud Bigtable table. One binding + consists of a member, a role, and an optional condition. + +EXAMPLES + To add an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run: + + $ gcloud beta bigtable tables add-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To add an IAM policy binding which expires at the end of the year 2019 for + the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' with + table 'my-table' in instance 'my-instance', run: + + $ gcloud beta bigtable tables add-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/bigtable.admin' \ + --condition='expression=request.time < + timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\ + tion=Expires at midnight on 2019-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to add the 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 table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables add-iam-policy-binding + + $ gcloud alpha bigtable tables add-iam-policy-binding + diff --git a/gcloud/beta/bigtable/tables/create b/gcloud/beta/bigtable/tables/create new file mode 100644 index 000000000..abd9e0584 --- /dev/null +++ b/gcloud/beta/bigtable/tables/create @@ -0,0 +1,145 @@ +NAME + gcloud beta bigtable tables create - create a new Cloud Bigtable table + +SYNOPSIS + gcloud beta bigtable tables create (TABLE : --instance=INSTANCE) + --column-families=[COLUMN_FAMILIES,...] + [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD] + [--deletion-protection] [--enable-automated-backup] + [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a new Cloud Bigtable table. + +EXAMPLES + To create a table my-table in instance my-instance with a column family + my-family, run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" + + To create a table that has a column family named my-instance, a garbage + collection policy that lets data expire after 864,000 seconds, and initial + table splits on row keys car and key, run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance \ + --column-families="my-family:maxage=864000s" --splits=car,key + + To create a table my-table in instance my-instance that lets data in column + family my-family1 expire after 10 days and keeps a maximum of 5 cells per + column in column family my-family-2 if the data is less than 5 days old, + run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance \ + --column-families="my-family-1:maxage=10d,my-family-2:maxversion\ + s=5||maxage=5d" + + To create a table my-table that has one column family my-family that lets + data expire after 10 days, and to enable a change stream for the table to + be kept for 7 days, run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance \ + --column-families="my-family:maxage=10d" \ + --change-stream-retention-period=7d + + To create a deletion-protected table my-table in instance my-instance with + a column family my-family, run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --deletion-protection + + To create a table my-table without deletion protection in instance + my-instance with a column family my-family, run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --no-deletion-protection + + To create a table my-table with automated backup policy + (retention_period=72h, frequency=24h) enabled in instance my-instance with + a column family my-family, run: + + $ gcloud beta bigtable tables create my-table \ + --instance=my-instance --column-families="my-family" \ + --enable-automated-backup + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to create. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --column-families=[COLUMN_FAMILIES,...] + A double-quote (") wrapped list of family name and corresponding + garbage collection rules concatenated by :, where the rules are + optional. For example: \ + "family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5" + +OPTIONAL FLAGS + --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + The length of time to retain change stream data for the table, in the + range of [1 day, 7 days]. Acceptable units are days (d), hours (h), + minutes (m), and seconds (s). Passing in a value for this option + enables a change stream for the table. Examples: 5d or 48h. + + --deletion-protection + Once specified, the table is deletion protected. + + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + + --splits=[SPLITS,...] + Row keys where the table should initially be split. For example: + car,key + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables create + + $ gcloud alpha bigtable tables create + diff --git a/gcloud/beta/bigtable/tables/delete b/gcloud/beta/bigtable/tables/delete new file mode 100644 index 000000000..8a8d0bd19 --- /dev/null +++ b/gcloud/beta/bigtable/tables/delete @@ -0,0 +1,66 @@ +NAME + gcloud beta bigtable tables delete - delete a Cloud Bigtable table + +SYNOPSIS + gcloud beta bigtable tables delete (TABLE : --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Cloud Bigtable table. + +EXAMPLES + To delete the table my-table in instance my-instance, run: + + $ gcloud beta bigtable tables delete my-table --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to delete. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables delete + + $ gcloud alpha bigtable tables delete + diff --git a/gcloud/beta/bigtable/tables/describe b/gcloud/beta/bigtable/tables/describe new file mode 100644 index 000000000..6dcd87f7d --- /dev/null +++ b/gcloud/beta/bigtable/tables/describe @@ -0,0 +1,87 @@ +NAME + gcloud beta bigtable tables describe - retrieve information about a table + +SYNOPSIS + gcloud beta bigtable tables describe (TABLE : --instance=INSTANCE) + [--view=VIEW; default="schema"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Retrieve information about a table. + +EXAMPLES + To describe a table, run: + + $ gcloud beta bigtable tables describe TABLE_NAME \ + --instance=INSTANCE_NAME + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to describe. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --view=VIEW; default="schema" + The view to be applied to the returned table's fields. VIEW must be one + of: + + encryption + Only populates name and fields related to the table's encryption + status. + full + Populates all fields. + name + Only populates name. + replication + Only populates name and fields related to the table's replication. + schema + Only populates name and fields related to the table's schema. + stats + Only populates name and fields related to the table's statistics + (e.g. TableStats and ColumnFamilyStats). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables describe + + $ gcloud alpha bigtable tables describe + diff --git a/gcloud/beta/bigtable/tables/get-iam-policy b/gcloud/beta/bigtable/tables/get-iam-policy new file mode 100644 index 000000000..eb6ffa0e9 --- /dev/null +++ b/gcloud/beta/bigtable/tables/get-iam-policy @@ -0,0 +1,99 @@ +NAME + gcloud beta bigtable tables get-iam-policy - get an IAM policy on a Cloud + Bigtable table + +SYNOPSIS + gcloud beta bigtable tables get-iam-policy (TABLE : --instance=INSTANCE) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Get an IAM policy on a Cloud Bigtable table. + +EXAMPLES + To get the IAM policy on the table 'my-table' in instance 'my-instance', + run: + + $ gcloud beta bigtable tables get-iam-policy my-table \ + --instance='my-instance' + + See https://cloud.google.com/iam/docs/managing-policies for more + information. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to get the IAM policy for. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables get-iam-policy + + $ gcloud alpha bigtable tables get-iam-policy + diff --git a/gcloud/beta/bigtable/tables/help b/gcloud/beta/bigtable/tables/help new file mode 100644 index 000000000..2006f0dd8 --- /dev/null +++ b/gcloud/beta/bigtable/tables/help @@ -0,0 +1,58 @@ +NAME + gcloud beta bigtable tables - query Cloud Bigtable tables + +SYNOPSIS + gcloud beta bigtable tables COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Query Cloud Bigtable tables. + +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 + (BETA) Add an IAM policy binding to a Cloud Bigtable table. + + create + (BETA) Create a new Cloud Bigtable table. + + delete + (BETA) Delete a Cloud Bigtable table. + + describe + (BETA) Retrieve information about a table. + + get-iam-policy + (BETA) Get an IAM policy on a Cloud Bigtable table. + + list + (BETA) List existing Bigtable instance tables. + + remove-iam-policy-binding + (BETA) Remove an IAM policy binding from a Cloud Bigtable table. + + restore + (BETA) Restore a Cloud Bigtable backup to a new table. + + set-iam-policy + (BETA) Set an IAM policy on a Cloud Bigtable table. + + undelete + (BETA) Undelete a previously deleted Cloud Bigtable table. + + update + (BETA) Update an existing Cloud Bigtable table. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables + + $ gcloud alpha bigtable tables + diff --git a/gcloud/beta/bigtable/tables/list b/gcloud/beta/bigtable/tables/list new file mode 100644 index 000000000..4755ad963 --- /dev/null +++ b/gcloud/beta/bigtable/tables/list @@ -0,0 +1,68 @@ +NAME + gcloud beta bigtable tables list - list existing Bigtable instance tables + +SYNOPSIS + gcloud beta bigtable tables list --instances=[INSTANCE,...] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To list all tables in an instance, run: + + $ gcloud beta bigtable tables list --instances=INSTANCE_NAME + + To list all tables in several instances, run: $ gcloud beta bigtable tables list \ + --instances=INSTANCE_NAME1,INSTANCE_NAME2 + +REQUIRED FLAGS + --instances=[INSTANCE,...] + ID of the instances. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables list + + $ gcloud alpha bigtable tables list + diff --git a/gcloud/beta/bigtable/tables/remove-iam-policy-binding b/gcloud/beta/bigtable/tables/remove-iam-policy-binding new file mode 100644 index 000000000..7d4150439 --- /dev/null +++ b/gcloud/beta/bigtable/tables/remove-iam-policy-binding @@ -0,0 +1,151 @@ +NAME + gcloud beta bigtable tables remove-iam-policy-binding - remove an IAM + policy binding from a Cloud Bigtable table + +SYNOPSIS + gcloud beta bigtable tables remove-iam-policy-binding + (TABLE : --instance=INSTANCE) --member=PRINCIPAL --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Remove an IAM policy binding from a Cloud Bigtable table. One + binding consists of a member, a role, and an optional condition. + +EXAMPLES + To remove an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run: + + $ gcloud beta bigtable tables remove-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To remove an IAM policy binding which expires at the end of the year 2019 + for the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' + with table 'my-table' in instance 'my-instance', run: + + $ gcloud beta bigtable tables remove-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/bigtable.admin' \ + --condition='expression=request.time < + timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\ + tion=Expires at midnight on 2019-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to remove the 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 table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables remove-iam-policy-binding + + $ gcloud alpha bigtable tables remove-iam-policy-binding + diff --git a/gcloud/beta/bigtable/tables/restore b/gcloud/beta/bigtable/tables/restore new file mode 100644 index 000000000..5f2a2c6fd --- /dev/null +++ b/gcloud/beta/bigtable/tables/restore @@ -0,0 +1,123 @@ +NAME + gcloud beta bigtable tables restore - restore a Cloud Bigtable backup to a + new table + +SYNOPSIS + gcloud beta bigtable tables restore + (--destination=DESTINATION + : --destination-instance=DESTINATION_INSTANCE) + (--source=SOURCE + : --source-cluster=SOURCE_CLUSTER --source-instance=SOURCE_INSTANCE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) This command restores a Cloud Bigtable backup to a new table. + +EXAMPLES + To restore table 'table2' from backup 'backup1', run: + + $ gcloud beta bigtable tables restore --source-instance=instance1 \ + --source-cluster=cluster1 --source=backup1 \ + --destination-instance=instance1 --destination=table2 + + To restore table 'table2' from backup 'backup1' in a different project, + run: + + $ gcloud beta bigtable tables restore \ + --source=projects/project1/instances/instance1/clusters/\ + cluster1/backups/backup1 \ + --destination=projects/project2/instances/instance2/tables/\ + table2 + +REQUIRED FLAGS + Table resource - The destination to restore 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. + + This must be specified. + + --destination=DESTINATION + ID of the table or fully qualified identifier for the table. + + To set the destination attribute: + ▸ provide the argument --destination on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --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; + ▸ provide the argument --destination-instance on the command line; + ▸ provide the argument --source-instance on the command line. + + Backup resource - The source to restore 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. + + This must be specified. + + --source=SOURCE + ID of the backup or fully qualified identifier for the backup. + + To set the source attribute: + ▸ provide the argument --source 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; + ▸ 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; + ▸ provide the argument --source-instance on the command line; + ▸ provide the argument --destination-instance on the command line. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables restore + + $ gcloud alpha bigtable tables restore + diff --git a/gcloud/beta/bigtable/tables/set-iam-policy b/gcloud/beta/bigtable/tables/set-iam-policy new file mode 100644 index 000000000..b07762f6c --- /dev/null +++ b/gcloud/beta/bigtable/tables/set-iam-policy @@ -0,0 +1,79 @@ +NAME + gcloud beta bigtable tables set-iam-policy - set an IAM policy on a Cloud + Bigtable table + +SYNOPSIS + gcloud beta bigtable tables set-iam-policy (TABLE : --instance=INSTANCE) + POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set an IAM policy on a Cloud Bigtable table. + +EXAMPLES + To set the IAM policy from file 'my-policy' on the table 'my-table' in + instance 'my-instance', run: + + $ gcloud beta bigtable tables set-iam-policy my-table \ + --instance='my-instance' my-policy + + See https://cloud.google.com/iam/docs/managing-policies for more + information. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to set the IAM policy on. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables set-iam-policy + + $ gcloud alpha bigtable tables set-iam-policy + diff --git a/gcloud/beta/bigtable/tables/undelete b/gcloud/beta/bigtable/tables/undelete new file mode 100644 index 000000000..3eb9da18a --- /dev/null +++ b/gcloud/beta/bigtable/tables/undelete @@ -0,0 +1,73 @@ +NAME + gcloud beta bigtable tables undelete - undelete a previously deleted Cloud + Bigtable table + +SYNOPSIS + gcloud beta bigtable tables undelete (TABLE : --instance=INSTANCE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Undelete a previously deleted Cloud Bigtable table. + +EXAMPLES + To undelete the table my-table in instance my-instance, run: + + $ gcloud beta bigtable tables undelete my-table \ + --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to undelete. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables undelete + + $ gcloud alpha bigtable tables undelete + diff --git a/gcloud/beta/bigtable/tables/update b/gcloud/beta/bigtable/tables/update new file mode 100644 index 000000000..318bd8d30 --- /dev/null +++ b/gcloud/beta/bigtable/tables/update @@ -0,0 +1,126 @@ +NAME + gcloud beta bigtable tables update - update an existing Cloud Bigtable + table + +SYNOPSIS + gcloud beta bigtable tables update (TABLE : --instance=INSTANCE) [--async] + [--deletion-protection] [--disable-automated-backup] + [--enable-automated-backup] + [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update an existing new Cloud Bigtable table with the specified + configuration. + +EXAMPLES + To enable deletion protection, run: + + $ gcloud beta bigtable tables update my-table \ + --instance=my-instance --deletion-protection + + To disable deletion protection, run: + + $ gcloud beta bigtable tables update my-table \ + --instance=my-instance --no-deletion-protection + + To enable a change stream with a retention period of 1 day, or to update + your table's change stream retention period to 1 day, run: + + $ gcloud beta bigtable tables update my-table \ + --instance=my-instance --change-stream-retention-period=1d + + To disable a change stream, run: + + $ gcloud beta bigtable tables update my-table \ + --instance=my-instance --clear-change-stream-retention-period + + To enable default automated backup policy (retention_period=72h, + frequency=24h), run: + + $ gcloud beta bigtable tables update my-table \ + --instance=my-instance --enable-automated-backup + + To disable automated backup: run: + + $ gcloud beta bigtable tables update my-table \ + --instance=my-instance --disable-automated-backup + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to update. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deletion-protection + Once specified, the table is deletion protected. + + --disable-automated-backup + Once set, disables automated backup policy for the table. + + --enable-automated-backup + Once set, enables the default automated backup policy + (retention_period=72h, frequency=24h) for the table. + + At most one of these can be specified: + + --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + The length of time to retain change stream data for the table, in the + range of [1 day, 7 days]. Acceptable units are days (d), hours (h), + minutes (m), and seconds (s). If not already specified, enables a + change stream for the table. Examples: 5d or 48h. + + --clear-change-stream-retention-period + This disables the change stream and eventually removes the change + stream data. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud bigtable tables update + + $ gcloud alpha bigtable tables update + diff --git a/gcloud/beta/composer/environments/update b/gcloud/beta/composer/environments/update index f166aa280..073d72139 100644 --- a/gcloud/beta/composer/environments/update +++ b/gcloud/beta/composer/environments/update @@ -11,6 +11,9 @@ SYNOPSIS | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE | --airflow-version=AIRFLOW_VERSION | --image-version=IMAGE_VERSION + | --maintenance-window-end=MAINTENANCE_WINDOW_END + --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE + --maintenance-window-start=MAINTENANCE_WINDOW_START | --disable-cloud-data-lineage-integration | --enable-cloud-data-lineage-integration | --disable-master-authorized-networks @@ -21,9 +24,6 @@ SYNOPSIS --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE --snapshot-location=SNAPSHOT_LOCATION --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE - | --maintenance-window-end=MAINTENANCE_WINDOW_END - --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE - --maintenance-window-start=MAINTENANCE_WINDOW_START | --max-workers=MAX_WORKERS --min-workers=MIN_WORKERS --scheduler-count=SCHEDULER_COUNT --scheduler-cpu=SCHEDULER_CPU --scheduler-memory=SCHEDULER_MEMORY @@ -164,6 +164,43 @@ REQUIRED FLAGS Composer version. The resolved versions are stored in the upgraded environment. + Group of arguments for setting the maintenance window value during + update. + + At most one of these can be specified: + + Group of arguments for setting the maintenance window value. + + --maintenance-window-end=MAINTENANCE_WINDOW_END + End time of the mantenance window in the form of the full date. + Only the time of the day is used as a reference for an ending + time of the window with a provided recurrence. Specified date + must take place after the one specified as a start date, the + difference between will be used as a length of a single + maintenance window. See $ gcloud topic datetimes for information + on time formats. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE + An RFC 5545 RRULE, specifying how the maintenance window will + recur. The minimum requirement for the length of the maintenance + window is 12 hours a week. Only FREQ=DAILY and FREQ=WEEKLY rules + are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --maintenance-window-start=MAINTENANCE_WINDOW_START + Start time of the mantenance window in the form of the full date. + Only the time of the day is used as a reference for a starting + time of the window with a provided recurrence. See $ gcloud topic + datetimes for information on time formats. + + This flag argument must be specified if any of the other + arguments in this group are specified. + Group of arguments for setting Cloud Data Lineage integration configuration in Composer 2. @@ -239,37 +276,6 @@ REQUIRED FLAGS This flag argument must be specified if any of the other arguments in this group are specified. - Group of arguments for setting the maintenance window value. - - --maintenance-window-end=MAINTENANCE_WINDOW_END - End time of the mantenance window in the form of the full date. - Only the time of the day is used as a reference for an ending time - of the window with a provided recurrence. Specified date must take - place after the one specified as a start date, the difference - between will be used as a length of a single maintenance window. - See $ gcloud topic datetimes for information on time formats. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE - An RFC 5545 RRULE, specifying how the maintenance window will - recur. The minimum requirement for the length of the maintenance - window is 12 hours a week. Only FREQ=DAILY and FREQ=WEEKLY rules - are supported. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --maintenance-window-start=MAINTENANCE_WINDOW_START - Start time of the mantenance window in the form of the full date. - Only the time of the day is used as a reference for a starting time - of the window with a provided recurrence. See $ gcloud topic - datetimes for information on time formats. - - This flag argument must be specified if any of the other arguments - in this group are specified. - Group of arguments for setting workloads configuration in Composer 2.X or greater (--scheduler-count flag is available for Composer 1.X as well). diff --git a/gcloud/beta/compute/commitments/create b/gcloud/beta/compute/commitments/create index b14f5632e..5e2ab9b7c 100644 --- a/gcloud/beta/compute/commitments/create +++ b/gcloud/beta/compute/commitments/create @@ -103,8 +103,9 @@ OPTIONAL FLAGS accelerator-optimized-a3, compute-optimized, compute-optimized-c2d, compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, general-purpose-e2, general-purpose-n2, - general-purpose-n2d, general-purpose-t2d, graphics-optimized, - memory-optimized, memory-optimized-m3, storage-optimized-z3. + general-purpose-n2d, general-purpose-n4, general-purpose-t2d, + graphics-optimized, memory-optimized, memory-optimized-m3, + storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/beta/compute/public-advertised-prefixes/create b/gcloud/beta/compute/public-advertised-prefixes/create index b00641c1c..87dcfaa9d 100644 --- a/gcloud/beta/compute/public-advertised-prefixes/create +++ b/gcloud/beta/compute/public-advertised-prefixes/create @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud beta compute public-advertised-prefixes create NAME --dns-verification-ip=DNS_VERIFICATION_IP --range=RANGE - [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] + [--description=DESCRIPTION] [--pdp-scope=PDP_SCOPE] + [GCLOUD_WIDE_FLAG ...] EXAMPLES To create a public advertised prefix: @@ -14,6 +15,12 @@ EXAMPLES my-public-advertised-prefix --range=120.120.10.0/24 \ --dns-verification-ip=120.120.10.15 + To create a v2 public advertised prefix: + + $ gcloud beta compute public-advertised-prefixes create \ + my-v2-public-advertised-prefix --range=120.120.10.0/24 \ + --dns-verification-ip=120.120.10.15 --pdp-scope=REGIONAL + POSITIONAL ARGUMENTS NAME Name of the public advertised prefix to operate on. @@ -30,6 +37,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of this public advertised prefix. + --pdp-scope=PDP_SCOPE + Specifies how child public delegated prefix will be scoped. PDP_SCOPE + must be one of: GLOBAL, REGIONAL. + 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/compute/public-advertised-prefixes/update b/gcloud/beta/compute/public-advertised-prefixes/update index b2e540b9d..7f92ac2b6 100644 --- a/gcloud/beta/compute/public-advertised-prefixes/update +++ b/gcloud/beta/compute/public-advertised-prefixes/update @@ -3,7 +3,8 @@ NAME Engine public advertised prefix SYNOPSIS - gcloud beta compute public-advertised-prefixes update NAME --status=STATUS + gcloud beta compute public-advertised-prefixes update NAME + (--announce-prefix | --status=STATUS | --withdraw-prefix) [GCLOUD_WIDE_FLAG ...] EXAMPLES @@ -12,14 +13,32 @@ EXAMPLES $ gcloud beta compute public-advertised-prefixes update my-pap \ --status=ptr-configured + To announce a public advertised prefix: + + $ gcloud beta compute public-advertised-prefixes update my-pap \ + --announce-prefix + + To withdraw a public advertised prefix: + + $ gcloud beta compute public-advertised-prefixes update my-pap \ + --withdraw-prefix + POSITIONAL ARGUMENTS NAME Name of the public advertised prefix to operate on. REQUIRED FLAGS - --status=STATUS - The status of public advertised prefix. STATUS must be (only one value - is supported): ptr-configured. + Exactly one of these must be specified: + + --announce-prefix + Specify if the prefix will be announced. Default is false. + + --status=STATUS + The status of public advertised prefix. STATUS must be (only one + value is supported): ptr-configured. + + --withdraw-prefix + Specify if the prefix will be withdrawn. Default is false. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/compute/public-delegated-prefixes/help b/gcloud/beta/compute/public-delegated-prefixes/help index 6b4a90df7..0d8acc3d2 100644 --- a/gcloud/beta/compute/public-delegated-prefixes/help +++ b/gcloud/beta/compute/public-delegated-prefixes/help @@ -35,6 +35,9 @@ COMMANDS list (BETA) List Google Compute Engine public delegated prefixes. + update + (BETA) Updates a Compute Engine public delegated prefix. + NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/compute/public-delegated-prefixes/update b/gcloud/beta/compute/public-delegated-prefixes/update new file mode 100644 index 000000000..a91630d1e --- /dev/null +++ b/gcloud/beta/compute/public-delegated-prefixes/update @@ -0,0 +1,54 @@ +NAME + gcloud beta compute public-delegated-prefixes update - updates a Compute + Engine public delegated prefix + +SYNOPSIS + gcloud beta compute public-delegated-prefixes update NAME + (--announce-prefix | --withdraw-prefix) [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To announce a regional v2 public delegated prefix: + + $ gcloud beta compute public-delegated-prefixes update my-pdp \ + --announce-prefix --region=us-central1 + + To withdraw a regional v2 public delegated prefix: + + $ gcloud beta compute public-delegated-prefixes update my-pdp \ + --withdraw-prefix --region=us-central1 + +POSITIONAL ARGUMENTS + NAME + Name of the public delegated prefix to operate on. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --announce-prefix + Specify if the prefix will be announced. Default is false. + + --withdraw-prefix + Specify if the prefix will be withdrawn. Default is false. + +OPTIONAL FLAGS + --region=REGION + Region of the public delegated prefix 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 beta and might change without notice. These + variants are also available: + + $ gcloud compute public-delegated-prefixes update + + $ gcloud alpha compute public-delegated-prefixes update + diff --git a/gcloud/beta/container/binauthz/attestors/create b/gcloud/beta/container/binauthz/attestors/create index e7d0e20a2..80a248f65 100644 --- a/gcloud/beta/container/binauthz/attestors/create +++ b/gcloud/beta/container/binauthz/attestors/create @@ -7,12 +7,15 @@ SYNOPSIS : --attestation-authority-note-project=ATTESTATION_AUTHORITY_NOTE_PROJECT) [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] +DESCRIPTION + (BETA) Create an Attestor. + EXAMPLES To create an Attestor with an existing Note projects/my_proj/notes/my_note: $ gcloud beta container binauthz attestors create my_new_attestor \ --attestation-authority-note=my_note \ - --attestation-authority-note-project=my_proj \ + --attestation-authority-note-project=my_proj POSITIONAL ARGUMENTS Attestor resource - The attestor to be created. This represents a Cloud diff --git a/gcloud/beta/container/clusters/update b/gcloud/beta/container/clusters/update index fdca07409..f17ab4acb 100644 --- a/gcloud/beta/container/clusters/update +++ b/gcloud/beta/container/clusters/update @@ -20,10 +20,11 @@ SYNOPSIS | --enable-l4-ilb-subsetting | --enable-legacy-authorization | --enable-logging-monitoring-system-only | --enable-master-authorized-networks | --enable-master-global-access - | --enable-network-policy | --enable-pod-security-policy - | --enable-private-endpoint | --enable-secret-manager - | --enable-service-externalips | --enable-shielded-nodes - | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling + | --enable-multi-networking | --enable-network-policy + | --enable-pod-security-policy | --enable-private-endpoint + | --enable-secret-manager | --enable-service-externalips + | --enable-shielded-nodes | --enable-stackdriver-kubernetes + | --enable-vertical-pod-autoscaling | --fleet-project=PROJECT_ID_OR_NUMBER | --gateway-api=GATEWAY_API | --generate-password | --identity-provider=IDENTITY_PROVIDER | --in-transit-encryption=IN_TRANSIT_ENCRYPTION @@ -358,6 +359,10 @@ REQUIRED FLAGS endpoint from any Google Cloud region or on-premises environment regardless of the private cluster's region. + --enable-multi-networking + Enables multi-networking on the cluster. Multi-networking is disabled + by default. + --enable-network-policy Enable network policy enforcement for this cluster. If you are enabling network policy on an existing cluster the network policy diff --git a/gcloud/beta/dataflow/jobs/update-options b/gcloud/beta/dataflow/jobs/update-options index 8b226a7e8..5dc69c936 100644 --- a/gcloud/beta/dataflow/jobs/update-options +++ b/gcloud/beta/dataflow/jobs/update-options @@ -5,7 +5,9 @@ NAME SYNOPSIS gcloud beta dataflow jobs update-options JOB_ID [--max-num-workers=MAX_NUM_WORKERS] [--min-num-workers=MIN_NUM_WORKERS] - [--region=REGION_ID] [GCLOUD_WIDE_FLAG ...] + [--region=REGION_ID] [--unset-worker-utilization-hint] + [--worker-utilization-hint=WORKER_UTILIZATION_HINT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command can modify properties of running Dataflow jobs. @@ -13,8 +15,10 @@ DESCRIPTION supported. Adjust the autoscaling settings for Streaming Engine Dataflow jobs by - providing at-least one of --min-num-workers or --max-num-workers (or both). - Allow a few minutes for the changes to take effect. + providing at-least one of --min-num-workers or --max-num-workers or + --worker-utilization-hint (or all 3), or --unset-worker-utilization-hint + (which cannot be run at the same time as --worker-utilization-hint but + works with the others). Allow a few minutes for the changes to take effect. Note that autoscaling settings can only be modified on-the-fly for Streaming Engine jobs. Attempts to modify batch job or Streaming Appliance @@ -34,6 +38,18 @@ EXAMPLES $ gcloud beta dataflow jobs update-options --max-num-workers=20 + Adjust the hint of target worker utilization to 70% for horizontal + autoscaling: + + $ gcloud beta dataflow jobs update-options \ + --worker-utilization-hint=0.7 + + "Unset" worker utilization hint so that horizontal scaling will rely on its + default CPU utilization target: + + $ gcloud beta dataflow jobs update-options \ + --unset-worker-utilization-hint + POSITIONAL ARGUMENTS JOB_ID Job ID to operate on. @@ -50,6 +66,15 @@ FLAGS --region=REGION_ID Region ID of the job's regional endpoint. Defaults to 'us-central1'. + --unset-worker-utilization-hint + Unset --worker-utilization-hint. This causes the job autoscaling to + fall back to internal tunings if they exist, or otherwise use the + default hint value. + + --worker-utilization-hint=WORKER_UTILIZATION_HINT + Target CPU utilization for autoscaling, ranging from 0.1 to 0.9. Only + supported for streaming-engine jobs with autoscaling enabled. + 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/filestore/instances/create b/gcloud/beta/filestore/instances/create index 0a7f4fe68..c85f5eb80 100644 --- a/gcloud/beta/filestore/instances/create +++ b/gcloud/beta/filestore/instances/create @@ -114,7 +114,9 @@ REQUIRED FLAGS ▫ 1TB-9.75TB in 256GB increments or its multiples. ▫ 10TB-100TB in 2.5TB increments or its multiples. ▸ ENTERPRISE: 1TB-10TB in 256GB increments or its multiples. - ▸ REGIONAL: 1TB-9.75TB in 256GB increments or its multiples. + ▸ REGIONAL: 1TB-100TB: + ▫ 1TB-9.75TB in 256GB increments or its multiples. + ▫ 10TB-100TB in 2.5TB increments or its multiples. name The desired logical name of the volume. @@ -164,15 +166,15 @@ REQUIRED FLAGS A list of security flavors that are allowed to be used during mount command in NFSv4.1 filestore instances. The security flavors supported are: - ◆ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults to - AUTH_SYS. - ◆ AUTH_SYS: The user's UNIX user-id and group-ids are passed in the - clear. - ◆ KRB5: The end-user authentication is done using Kerberos V5. - ◆ KRB5I: KRB5 plus integrity protection (data packets are tamper - proof). - ◆ KRB5P: KRB5I plus privacy protection (data packets are tamper - proof and encrypted). + ▫ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults + to AUTH_SYS. + ▫ AUTH_SYS: The user's UNIX user-id and group-ids are passed in + the clear. + ▫ KRB5: The end-user authentication is done using Kerberos V5. + ▫ KRB5I: KRB5 plus integrity protection (data packets are + tamper proof). + ▫ KRB5P: KRB5I plus privacy protection (data packets are tamper + proof and encrypted). source-backup The name of the backup to restore from. diff --git a/gcloud/beta/filestore/instances/update b/gcloud/beta/filestore/instances/update index 493db34cc..e5a20b66c 100644 --- a/gcloud/beta/filestore/instances/update +++ b/gcloud/beta/filestore/instances/update @@ -171,7 +171,9 @@ FLAGS ▫ 1TB-9.75TB in 256GB increments or its multiples. ▫ 10TB-100TB in 2.5TB increments or its multiples. ▸ ENTERPRISE: 1TB-10TB in 256GB increments or its multiples. - ▸ REGIONAL: 1TB-9.75TB in 256GB increments or its multiples. + ▸ REGIONAL: 1TB-100TB: + ▫ 1TB-9.75TB in 256GB increments or its multiples. + ▫ 10TB-100TB in 2.5TB increments or its multiples. name The desired logical name of the volume. @@ -221,18 +223,18 @@ FLAGS A list of security flavors that are allowed to be used during mount command in NFSv4.1 filestore instances. The security flavors supported are: - ◆ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults to - AUTH_SYS. - ◆ AUTH_SYS: The user's UNIX user-id and group-ids are passed in the - clear. - ◆ KRB5: The end-user authentication is done using Kerberos V5. - ◆ KRB5I: KRB5 plus integrity protection (data packets are tamper - proof). - ◆ KRB5P: KRB5I plus privacy protection (data packets are tamper proof - and encrypted). + ▫ SECURITY_FLAVOR_UNSPECIFIED: SecurityFlavor not set. Defaults + to AUTH_SYS. + ▫ AUTH_SYS: The user's UNIX user-id and group-ids are passed in + the clear. + ▫ KRB5: The end-user authentication is done using Kerberos V5. + ▫ KRB5I: KRB5 plus integrity protection (data packets are + tamper proof). + ▫ KRB5P: KRB5I plus privacy protection (data packets are tamper + proof and encrypted). - This flag argument must be specified if any of the other arguments in this - group are specified. + This flag argument must be specified if any of the other + arguments in this group are specified. --clear-nfs-export-options Clears the NfsExportOptions. Must specify --file-share flag if diff --git a/gcloud/beta/functions/deploy b/gcloud/beta/functions/deploy index c9f148e55..7b6f368ce 100644 --- a/gcloud/beta/functions/deploy +++ b/gcloud/beta/functions/deploy @@ -112,8 +112,6 @@ FLAGS If not provided, the function will use the project's default service account for Cloud Build. - Only applicable when the --gen2 flag is provided. - --concurrency=CONCURRENCY Set the maximum number of concurrent requests allowed per container instance. Leave concurrency unspecified to receive the server default diff --git a/gcloud/beta/network-security/firewall-endpoint-associations/update b/gcloud/beta/network-security/firewall-endpoint-associations/update index fc1926c35..0025f84e9 100644 --- a/gcloud/beta/network-security/firewall-endpoint-associations/update +++ b/gcloud/beta/network-security/firewall-endpoint-associations/update @@ -6,7 +6,7 @@ SYNOPSIS gcloud beta network-security firewall-endpoint-associations update (FIREWALL_ENDPOINT_ASSOCIATION : --zone=ZONE) [--async] [--max-wait=MAX_WAIT; default="60m"] - [--update-labels=[KEY=VALUE,...] --clear-labels + [--disabled | --update-labels=[KEY=VALUE,...] --clear-labels | --remove-labels=[KEY,...] --no-tls-inspection-policy | [--tls-inspection-policy=TLS_INSPECTION_POLICY : --tls-inspection-policy-project=TLS_INSPECTION_POLICY_PROJECT @@ -84,78 +84,89 @@ FLAGS specified. See $ gcloud topic datetimes for information on time formats. - --update-labels=[KEY=VALUE,...] - List of label KEY=VALUE pairs to update. If a label exists, its value - is modified. Otherwise, a new label is created. - - Keys must start with a lowercase character and contain only hyphens - (-), underscores (_), lowercase characters, and numbers. Values must - contain only hyphens (-), underscores (_), lowercase characters, and - numbers. - At most one of these can be specified: - --clear-labels - Remove all labels. If --update-labels is also specified then - --clear-labels is applied first. - - For example, to remove all labels: + --disabled + Disable a firewall endpoint association. To enable a disabled + association, use: $ gcloud beta network-security firewall-endpoint-associations \ - update --clear-labels + update MY-ASSOCIATION --no-disabled - To remove all existing labels and create two new labels, foo and baz: + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. - $ gcloud beta network-security firewall-endpoint-associations \ - update --clear-labels --update-labels foo=bar,baz=qux + 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. - --remove-labels=[KEY,...] - List of label keys to remove. If a label does not exist it is - silently ignored. If --update-labels is also specified then - --update-labels is applied first. + At most one of these can be specified: - At most one of these can be specified: + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. - --no-tls-inspection-policy - Remove TLS inspection policy from this association. + For example, to remove all labels: - TLS Inspection Policy resource - Path to TLS Inspection Policy - configuration to use for intercepting TLS-encrypted traffic in this - network. The arguments in this group can be used to specify the - attributes of this resource. + $ gcloud beta network-security firewall-endpoint-associations \ + update --clear-labels - --tls-inspection-policy=TLS_INSPECTION_POLICY - ID of the TLS Inspection Policy or fully qualified identifier for - the TLS Inspection Policy. + To remove all existing labels and create two new labels, foo and + baz: - To set the tls_inspection_policy attribute: - ▫ provide the argument --tls-inspection-policy on the command - line. + $ gcloud beta network-security firewall-endpoint-associations \ + update --clear-labels --update-labels foo=bar,baz=qux - This flag argument must be specified if any of the other arguments - in this group are specified. + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. - --tls-inspection-policy-project=TLS_INSPECTION_POLICY_PROJECT - Project of the TLS Inspection Policy. + At most one of these can be specified: - To set the tls-inspection-policy-project attribute: - ▫ provide the argument --tls-inspection-policy on the command - line with a fully specified name; - ▫ provide the argument --tls-inspection-policy-project on the - command line; - ▫ provide the argument --project on the command line; - ▫ provide the argument FIREWALL_ENDPOINT_ASSOCIATION on the - command line with a fully specified name. + --no-tls-inspection-policy + Remove TLS inspection policy from this association. - --tls-inspection-policy-region=TLS_INSPECTION_POLICY_REGION - Region of the TLS Inspection Policy. NOTE: TLS Inspection Policy - needs to be in the same region as Firewall Plus endpoint resource. + TLS Inspection Policy resource - Path to TLS Inspection Policy + configuration to use for intercepting TLS-encrypted traffic in this + network. The arguments in this group can be used to specify the + attributes of this resource. - To set the tls-inspection-policy-region attribute: - ▫ provide the argument --tls-inspection-policy on the command - line with a fully specified name; - ▫ provide the argument --tls-inspection-policy-region on the - command line. + --tls-inspection-policy=TLS_INSPECTION_POLICY + ID of the TLS Inspection Policy or fully qualified identifier for + the TLS Inspection Policy. + + To set the tls_inspection_policy attribute: + ◇ provide the argument --tls-inspection-policy on the command + line. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --tls-inspection-policy-project=TLS_INSPECTION_POLICY_PROJECT + Project of the TLS Inspection Policy. + + To set the tls-inspection-policy-project attribute: + ◇ provide the argument --tls-inspection-policy on the command + line with a fully specified name; + ◇ provide the argument --tls-inspection-policy-project on the + command line; + ◇ provide the argument --project on the command line; + ◇ provide the argument FIREWALL_ENDPOINT_ASSOCIATION on the + command line with a fully specified name. + + --tls-inspection-policy-region=TLS_INSPECTION_POLICY_REGION + Region of the TLS Inspection Policy. NOTE: TLS Inspection Policy + needs to be in the same region as Firewall Plus endpoint + resource. + + To set the tls-inspection-policy-region attribute: + ◇ provide the argument --tls-inspection-policy on the command + line with a fully specified name; + ◇ provide the argument --tls-inspection-policy-region on the + command line. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/run/deploy b/gcloud/beta/run/deploy index 3da6ac8f9..88f189739 100644 --- a/gcloud/beta/run/deploy +++ b/gcloud/beta/run/deploy @@ -28,8 +28,8 @@ SYNOPSIS --[no-]default-url --description=DESCRIPTION --execution-environment=EXECUTION_ENVIRONMENT --remove-containers=[CONTAINER,...] --revision-suffix=REVISION_SUFFIX - --[no-]session-affinity --vpc-connector=VPC_CONNECTOR - --vpc-egress=VPC_EGRESS + --service-min-instances=SERVICE_MIN_INSTANCES --[no-]session-affinity + --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] | --clear-cloudsql-instances | --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -460,6 +460,11 @@ FLAGS [--revision-suffix=v1] for a service named 'helloworld', would lead to a revision named 'helloworld-v1'. + --service-min-instances=SERVICE_MIN_INSTANCES + The minimum number of container instances for this Service to run or + 'default' to remove any minimum. These instances will be divided + among all Revisions receiving a percentage of traffic. + --[no-]session-affinity Whether to enable session affinity for connections to the service. Use --session-affinity to enable and --no-session-affinity to diff --git a/gcloud/beta/run/services/update b/gcloud/beta/run/services/update index 2054e58fe..c3b477e10 100644 --- a/gcloud/beta/run/services/update +++ b/gcloud/beta/run/services/update @@ -23,8 +23,8 @@ SYNOPSIS --[no-]cpu-throttling --[no-]default-url --execution-environment=EXECUTION_ENVIRONMENT --remove-containers=[CONTAINER,...] --revision-suffix=REVISION_SUFFIX - --[no-]session-affinity --vpc-connector=VPC_CONNECTOR - --vpc-egress=VPC_EGRESS + --service-min-instances=SERVICE_MIN_INSTANCES --[no-]session-affinity + --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] | --clear-cloudsql-instances | --remove-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -343,6 +343,11 @@ FLAGS [--revision-suffix=v1] for a service named 'helloworld', would lead to a revision named 'helloworld-v1'. + --service-min-instances=SERVICE_MIN_INSTANCES + The minimum number of container instances for this Service to run or + 'default' to remove any minimum. These instances will be divided + among all Revisions receiving a percentage of traffic. + --[no-]session-affinity Whether to enable session affinity for connections to the service. Use --session-affinity to enable and --no-session-affinity to diff --git a/gcloud/beta/workstations/configs/create b/gcloud/beta/workstations/configs/create index d28c4963c..587a304c9 100644 --- a/gcloud/beta/workstations/configs/create +++ b/gcloud/beta/workstations/configs/create @@ -141,11 +141,11 @@ FLAGS address. --disable-ssh-to-vm - Default value is False. If set, workstations will disable SSH - connections to the root VM. + Default value is False. If set, workstations disable SSH connections to + the root VM. --disable-tcp-connections - Default value is false. If set, workstations will not allow plain TCP + Default value is false. If set, workstations don't allow plain TCP connections. --enable-audit-agent diff --git a/gcloud/beta/workstations/configs/update b/gcloud/beta/workstations/configs/update index c89d21593..7ba23e610 100644 --- a/gcloud/beta/workstations/configs/update +++ b/gcloud/beta/workstations/configs/update @@ -248,22 +248,18 @@ FLAGS At most one of these can be specified: --disable-ssh-to-vm - Default value is False. If set, workstations will enable SSH - connections to the root VM. + If set, workstations disable SSH connections to the root VM. --enable-ssh-to-vm - Default value is False. If set, workstations will enable SSH - connections to the root VM. + If set, workstations enable SSH connections to the root VM. At most one of these can be specified: --disable-tcp-connections - Default value is false. If set, workstations will allow plain TCP - connections. + If set, workstations don't allow plain TCP connections. --enable-tcp-connections - Default value is false. If set, workstations will allow plain TCP - connections. + If set, workstations allow plain TCP connections. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/bigtable/help b/gcloud/bigtable/help index 88ab99781..55c476941 100644 --- a/gcloud/bigtable/help +++ b/gcloud/bigtable/help @@ -33,6 +33,9 @@ GROUPS operations Manage Cloud Bigtable operations. + tables + Query Cloud Bigtable tables. + NOTES These variants are also available: diff --git a/gcloud/bigtable/tables/add-iam-policy-binding b/gcloud/bigtable/tables/add-iam-policy-binding new file mode 100644 index 000000000..0cd88c05e --- /dev/null +++ b/gcloud/bigtable/tables/add-iam-policy-binding @@ -0,0 +1,145 @@ +NAME + gcloud bigtable tables add-iam-policy-binding - add an IAM policy binding + to a Cloud Bigtable table + +SYNOPSIS + gcloud bigtable tables add-iam-policy-binding (TABLE : --instance=INSTANCE) + --member=PRINCIPAL --role=ROLE + [--condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Add an IAM policy binding to a Cloud Bigtable table. One binding consists + of a member, a role, and an optional condition. + +EXAMPLES + To add an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run: + + $ gcloud bigtable tables add-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To add an IAM policy binding which expires at the end of the year 2019 for + the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' with + table 'my-table' in instance 'my-instance', run: + + $ gcloud bigtable tables add-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/bigtable.admin' \ + --condition='expression=request.time < + timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\ + tion=Expires at midnight on 2019-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to add the 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 table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to add the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + Role name to assign to the principal. The role name is the complete + path of a predefined role, such as roles/logging.viewer, or the role ID + for a custom role, such as + organizations/{ORGANIZATION_ID}/roles/logging.viewer. + +OPTIONAL FLAGS + At most one of these can be specified: + + --condition=[KEY=VALUE,...] + A condition to include in the binding. When the condition is + explicitly specified as None (--condition=None), a binding without a + condition is added. When the condition is specified and is not None, + --role cannot be a basic role. Basic roles are roles/editor, + roles/owner, and roles/viewer. For more on conditions, refer to the + conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables add-iam-policy-binding + + $ gcloud beta bigtable tables add-iam-policy-binding + diff --git a/gcloud/bigtable/tables/create b/gcloud/bigtable/tables/create new file mode 100644 index 000000000..61a9936c6 --- /dev/null +++ b/gcloud/bigtable/tables/create @@ -0,0 +1,126 @@ +NAME + gcloud bigtable tables create - create a new Cloud Bigtable table + +SYNOPSIS + gcloud bigtable tables create (TABLE : --instance=INSTANCE) + --column-families=[COLUMN_FAMILIES,...] + [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD] + [--deletion-protection] [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new Cloud Bigtable table. + +EXAMPLES + To create a table my-table in instance my-instance with a column family + my-family, run: + + $ gcloud bigtable tables create my-table --instance=my-instance \ + --column-families="my-family" + + To create a table that has a column family named my-instance, a garbage + collection policy that lets data expire after 864,000 seconds, and initial + table splits on row keys car and key, run: + + $ gcloud bigtable tables create my-table --instance=my-instance \ + --column-families="my-family:maxage=864000s" --splits=car,key + + To create a table my-table in instance my-instance that lets data in column + family my-family1 expire after 10 days and keeps a maximum of 5 cells per + column in column family my-family-2 if the data is less than 5 days old, + run: + + $ gcloud bigtable tables create my-table --instance=my-instance \ + --column-families="my-family-1:maxage=10d,my-family-2:maxversion\ + s=5||maxage=5d" + + To create a table my-table that has one column family my-family that lets + data expire after 10 days, and to enable a change stream for the table to + be kept for 7 days, run: + + $ gcloud bigtable tables create my-table --instance=my-instance \ + --column-families="my-family:maxage=10d" \ + --change-stream-retention-period=7d + + To create a deletion-protected table my-table in instance my-instance with + a column family my-family, run: + + $ gcloud bigtable tables create my-table --instance=my-instance \ + --column-families="my-family" --deletion-protection + + To create a table my-table without deletion protection in instance + my-instance with a column family my-family, run: + + $ gcloud bigtable tables create my-table --instance=my-instance \ + --column-families="my-family" --no-deletion-protection + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to create. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --column-families=[COLUMN_FAMILIES,...] + A double-quote (") wrapped list of family name and corresponding + garbage collection rules concatenated by :, where the rules are + optional. For example: \ + "family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5" + +OPTIONAL FLAGS + --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + The length of time to retain change stream data for the table, in the + range of [1 day, 7 days]. Acceptable units are days (d), hours (h), + minutes (m), and seconds (s). Passing in a value for this option + enables a change stream for the table. Examples: 5d or 48h. + + --deletion-protection + Once specified, the table is deletion protected. + + --splits=[SPLITS,...] + Row keys where the table should initially be split. For example: + car,key + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables create + + $ gcloud beta bigtable tables create + diff --git a/gcloud/bigtable/tables/delete b/gcloud/bigtable/tables/delete new file mode 100644 index 000000000..2c1e8cb2b --- /dev/null +++ b/gcloud/bigtable/tables/delete @@ -0,0 +1,65 @@ +NAME + gcloud bigtable tables delete - delete a Cloud Bigtable table + +SYNOPSIS + gcloud bigtable tables delete (TABLE : --instance=INSTANCE) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Cloud Bigtable table. + +EXAMPLES + To delete the table my-table in instance my-instance, run: + + $ gcloud bigtable tables delete my-table --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to delete. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables delete + + $ gcloud beta bigtable tables delete + diff --git a/gcloud/bigtable/tables/describe b/gcloud/bigtable/tables/describe new file mode 100644 index 000000000..888329a33 --- /dev/null +++ b/gcloud/bigtable/tables/describe @@ -0,0 +1,85 @@ +NAME + gcloud bigtable tables describe - retrieve information about a table + +SYNOPSIS + gcloud bigtable tables describe (TABLE : --instance=INSTANCE) + [--view=VIEW; default="schema"] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Retrieve information about a table. + +EXAMPLES + To describe a table, run: + + $ gcloud bigtable tables describe TABLE_NAME --instance=INSTANCE_NAME + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to describe. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --view=VIEW; default="schema" + The view to be applied to the returned table's fields. VIEW must be one + of: + + encryption + Only populates name and fields related to the table's encryption + status. + full + Populates all fields. + name + Only populates name. + replication + Only populates name and fields related to the table's replication. + schema + Only populates name and fields related to the table's schema. + stats + Only populates name and fields related to the table's statistics + (e.g. TableStats and ColumnFamilyStats). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables describe + + $ gcloud beta bigtable tables describe + diff --git a/gcloud/bigtable/tables/get-iam-policy b/gcloud/bigtable/tables/get-iam-policy new file mode 100644 index 000000000..ae08cb16a --- /dev/null +++ b/gcloud/bigtable/tables/get-iam-policy @@ -0,0 +1,98 @@ +NAME + gcloud bigtable tables get-iam-policy - get an IAM policy on a Cloud + Bigtable table + +SYNOPSIS + gcloud bigtable tables get-iam-policy (TABLE : --instance=INSTANCE) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get an IAM policy on a Cloud Bigtable table. + +EXAMPLES + To get the IAM policy on the table 'my-table' in instance 'my-instance', + run: + + $ gcloud bigtable tables get-iam-policy my-table \ + --instance='my-instance' + + See https://cloud.google.com/iam/docs/managing-policies for more + information. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to get the IAM policy for. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +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 bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables get-iam-policy + + $ gcloud beta bigtable tables get-iam-policy + diff --git a/gcloud/bigtable/tables/help b/gcloud/bigtable/tables/help new file mode 100644 index 000000000..228f1b88b --- /dev/null +++ b/gcloud/bigtable/tables/help @@ -0,0 +1,57 @@ +NAME + gcloud bigtable tables - query Cloud Bigtable tables + +SYNOPSIS + gcloud bigtable tables COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Query Cloud Bigtable tables. + +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 + Add an IAM policy binding to a Cloud Bigtable table. + + create + Create a new Cloud Bigtable table. + + delete + Delete a Cloud Bigtable table. + + describe + Retrieve information about a table. + + get-iam-policy + Get an IAM policy on a Cloud Bigtable table. + + list + List existing Bigtable instance tables. + + remove-iam-policy-binding + Remove an IAM policy binding from a Cloud Bigtable table. + + restore + Restore a Cloud Bigtable backup to a new table. + + set-iam-policy + Set an IAM policy on a Cloud Bigtable table. + + undelete + Undelete a previously deleted Cloud Bigtable table. + + update + Update an existing Cloud Bigtable table. + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables + + $ gcloud beta bigtable tables + diff --git a/gcloud/bigtable/tables/list b/gcloud/bigtable/tables/list new file mode 100644 index 000000000..25bb8fd2e --- /dev/null +++ b/gcloud/bigtable/tables/list @@ -0,0 +1,67 @@ +NAME + gcloud bigtable tables list - list existing Bigtable instance tables + +SYNOPSIS + gcloud bigtable tables list --instances=[INSTANCE,...] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To list all tables in an instance, run: + + $ gcloud bigtable tables list --instances=INSTANCE_NAME + + To list all tables in several instances, run: $ gcloud bigtable tables list \ + --instances=INSTANCE_NAME1,INSTANCE_NAME2 + +REQUIRED FLAGS + --instances=[INSTANCE,...] + ID of the instances. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables list + + $ gcloud beta bigtable tables list + diff --git a/gcloud/bigtable/tables/remove-iam-policy-binding b/gcloud/bigtable/tables/remove-iam-policy-binding new file mode 100644 index 000000000..fa280dba8 --- /dev/null +++ b/gcloud/bigtable/tables/remove-iam-policy-binding @@ -0,0 +1,150 @@ +NAME + gcloud bigtable tables remove-iam-policy-binding - remove an IAM policy + binding from a Cloud Bigtable table + +SYNOPSIS + gcloud bigtable tables remove-iam-policy-binding + (TABLE : --instance=INSTANCE) --member=PRINCIPAL --role=ROLE + [--all | --condition=[KEY=VALUE,...] + | --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Remove an IAM policy binding from a Cloud Bigtable table. One binding + consists of a member, a role, and an optional condition. + +EXAMPLES + To remove an IAM policy binding for the role of 'roles/editor' for the user + 'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run: + + $ gcloud bigtable tables remove-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/editor' + + To remove an IAM policy binding which expires at the end of the year 2019 + for the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' + with table 'my-table' in instance 'my-instance', run: + + $ gcloud bigtable tables remove-iam-policy-binding my-table \ + --instance='my-instance' --member='user:test-user@gmail.com' \ + --role='roles/bigtable.admin' \ + --condition='expression=request.time < + timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\ + tion=Expires at midnight on 2019-12-31' + + See https://cloud.google.com/iam/docs/managing-policies for details of + policy role and member types. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to remove the 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 table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +REQUIRED FLAGS + --member=PRINCIPAL + The principal to remove the binding for. Should be of the form + user|group|serviceAccount:email or domain:domain. + + Examples: user:test-user@gmail.com, group:admins@example.com, + serviceAccount:test123@example.domain.com, or + domain:example.domain.com. + + Deleted principals have an additional deleted: prefix and a ?uid=UID + suffix, where UID is a unique identifier for the principal. Example: + deleted:user:test-user@gmail.com?uid=123456789012345678901. + + Some resources also accept the following special values: + ◆ allUsers - Special identifier that represents anyone who is on the + internet, with or without a Google account. + ◆ allAuthenticatedUsers - Special identifier that represents anyone + who is authenticated with a Google account or a service account. + + --role=ROLE + The role to remove the principal from. + +OPTIONAL FLAGS + At most one of these can be specified: + + --all + Remove all bindings with this role and principal, irrespective of any + conditions. + + --condition=[KEY=VALUE,...] + The condition of the binding that you want to remove. When the + condition is explicitly specified as None (--condition=None), a + binding without a condition is removed. Otherwise, only a binding + with a condition that exactly matches the specified condition + (including the optional description) is removed. For more on + conditions, refer to the conditions overview guide: + https://cloud.google.com/iam/docs/conditions-overview + + When using the --condition flag, include the following key-value + pairs: + + expression + (Required) Condition expression that evaluates to True or False. + This uses a subset of Common Expression Language syntax. + + If the condition expression includes a comma, use a different + delimiter to separate the key-value pairs. Specify the delimiter + before listing the key-value pairs. For example, to specify a + colon (:) as the delimiter, do the following: + --condition=^:^title=TITLE:expression=EXPRESSION. For more + information, see + https://cloud.google.com/sdk/gcloud/reference/topic/escaping. + + title + (Required) A short string describing the purpose of the + expression. + + description + (Optional) Additional description for the expression. + + --condition-from-file=CONDITION_FROM_FILE + Path to a local JSON or YAML file that defines the condition. To see + available fields, see the help for --condition. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables remove-iam-policy-binding + + $ gcloud beta bigtable tables remove-iam-policy-binding + diff --git a/gcloud/bigtable/tables/restore b/gcloud/bigtable/tables/restore new file mode 100644 index 000000000..8d37725a5 --- /dev/null +++ b/gcloud/bigtable/tables/restore @@ -0,0 +1,122 @@ +NAME + gcloud bigtable tables restore - restore a Cloud Bigtable backup to a new + table + +SYNOPSIS + gcloud bigtable tables restore + (--destination=DESTINATION + : --destination-instance=DESTINATION_INSTANCE) + (--source=SOURCE + : --source-cluster=SOURCE_CLUSTER --source-instance=SOURCE_INSTANCE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + This command restores a Cloud Bigtable backup to a new table. + +EXAMPLES + To restore table 'table2' from backup 'backup1', run: + + $ gcloud bigtable tables restore --source-instance=instance1 \ + --source-cluster=cluster1 --source=backup1 \ + --destination-instance=instance1 --destination=table2 + + To restore table 'table2' from backup 'backup1' in a different project, + run: + + $ gcloud bigtable tables restore \ + --source=projects/project1/instances/instance1/clusters/\ + cluster1/backups/backup1 \ + --destination=projects/project2/instances/instance2/tables/\ + table2 + +REQUIRED FLAGS + Table resource - The destination to restore 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. + + This must be specified. + + --destination=DESTINATION + ID of the table or fully qualified identifier for the table. + + To set the destination attribute: + ▸ provide the argument --destination on the command line. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --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; + ▸ provide the argument --destination-instance on the command line; + ▸ provide the argument --source-instance on the command line. + + Backup resource - The source to restore 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. + + This must be specified. + + --source=SOURCE + ID of the backup or fully qualified identifier for the backup. + + To set the source attribute: + ▸ provide the argument --source 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; + ▸ 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; + ▸ provide the argument --source-instance on the command line; + ▸ provide the argument --destination-instance on the command line. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables restore + + $ gcloud beta bigtable tables restore + diff --git a/gcloud/bigtable/tables/set-iam-policy b/gcloud/bigtable/tables/set-iam-policy new file mode 100644 index 000000000..4338e3d8b --- /dev/null +++ b/gcloud/bigtable/tables/set-iam-policy @@ -0,0 +1,78 @@ +NAME + gcloud bigtable tables set-iam-policy - set an IAM policy on a Cloud + Bigtable table + +SYNOPSIS + gcloud bigtable tables set-iam-policy (TABLE : --instance=INSTANCE) + POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Set an IAM policy on a Cloud Bigtable table. + +EXAMPLES + To set the IAM policy from file 'my-policy' on the table 'my-table' in + instance 'my-instance', run: + + $ gcloud bigtable tables set-iam-policy my-table \ + --instance='my-instance' my-policy + + See https://cloud.google.com/iam/docs/managing-policies for more + information. + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to set the IAM policy on. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables set-iam-policy + + $ gcloud beta bigtable tables set-iam-policy + diff --git a/gcloud/bigtable/tables/undelete b/gcloud/bigtable/tables/undelete new file mode 100644 index 000000000..95dbf1ee6 --- /dev/null +++ b/gcloud/bigtable/tables/undelete @@ -0,0 +1,71 @@ +NAME + gcloud bigtable tables undelete - undelete a previously deleted Cloud + Bigtable table + +SYNOPSIS + gcloud bigtable tables undelete (TABLE : --instance=INSTANCE) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Undelete a previously deleted Cloud Bigtable table. + +EXAMPLES + To undelete the table my-table in instance my-instance, run: + + $ gcloud bigtable tables undelete my-table --instance=my-instance + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to undelete. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables undelete + + $ gcloud beta bigtable tables undelete + diff --git a/gcloud/bigtable/tables/update b/gcloud/bigtable/tables/update new file mode 100644 index 000000000..bf88df098 --- /dev/null +++ b/gcloud/bigtable/tables/update @@ -0,0 +1,105 @@ +NAME + gcloud bigtable tables update - update an existing Cloud Bigtable table + +SYNOPSIS + gcloud bigtable tables update (TABLE : --instance=INSTANCE) [--async] + [--deletion-protection] + [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update an existing new Cloud Bigtable table with the specified + configuration. + +EXAMPLES + To enable deletion protection, run: + + $ gcloud bigtable tables update my-table --instance=my-instance \ + --deletion-protection + + To disable deletion protection, run: + + $ gcloud bigtable tables update my-table --instance=my-instance \ + --no-deletion-protection + + To enable a change stream with a retention period of 1 day, or to update + your table's change stream retention period to 1 day, run: + + $ gcloud bigtable tables update my-table --instance=my-instance \ + --change-stream-retention-period=1d + + To disable a change stream, run: + + $ gcloud bigtable tables update my-table --instance=my-instance \ + --clear-change-stream-retention-period + +POSITIONAL ARGUMENTS + Table resource - Cloud Bigtable table to update. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument table on the command line with a fully specified + name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TABLE + ID of the table or fully qualified identifier for the table. + + To set the table attribute: + ▸ provide the argument table on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --instance=INSTANCE + Name of the Cloud Bigtable instance. + + To set the instance attribute: + ▸ provide the argument table on the command line with a fully + specified name; + ▸ provide the argument --instance on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deletion-protection + Once specified, the table is deletion protected. + + At most one of these can be specified: + + --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD + The length of time to retain change stream data for the table, in the + range of [1 day, 7 days]. Acceptable units are days (d), hours (h), + minutes (m), and seconds (s). If not already specified, enables a + change stream for the table. Examples: 5d or 48h. + + --clear-change-stream-retention-period + This disables the change stream and eventually removes the change + stream data. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the bigtableadmin/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/bigtable/ + +NOTES + These variants are also available: + + $ gcloud alpha bigtable tables update + + $ gcloud beta bigtable tables update + diff --git a/gcloud/composer/environments/update b/gcloud/composer/environments/update index aab47c6e0..e444bb323 100644 --- a/gcloud/composer/environments/update +++ b/gcloud/composer/environments/update @@ -9,6 +9,9 @@ SYNOPSIS | --enable-high-resilience | --enable-logs-in-cloud-logging-only | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE + | --maintenance-window-end=MAINTENANCE_WINDOW_END + --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE + --maintenance-window-start=MAINTENANCE_WINDOW_START | --disable-cloud-data-lineage-integration | --enable-cloud-data-lineage-integration | --disable-master-authorized-networks @@ -19,9 +22,6 @@ SYNOPSIS --snapshot-creation-schedule=SNAPSHOT_CREATION_SCHEDULE --snapshot-location=SNAPSHOT_LOCATION --snapshot-schedule-timezone=SNAPSHOT_SCHEDULE_TIMEZONE - | --maintenance-window-end=MAINTENANCE_WINDOW_END - --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE - --maintenance-window-start=MAINTENANCE_WINDOW_START | --max-workers=MAX_WORKERS --min-workers=MIN_WORKERS --scheduler-count=SCHEDULER_COUNT --scheduler-cpu=SCHEDULER_CPU --scheduler-memory=SCHEDULER_MEMORY @@ -126,6 +126,43 @@ REQUIRED FLAGS machine types is available here: https://cloud.google.com/composer/pricing. + Group of arguments for setting the maintenance window value during + update. + + At most one of these can be specified: + + Group of arguments for setting the maintenance window value. + + --maintenance-window-end=MAINTENANCE_WINDOW_END + End time of the mantenance window in the form of the full date. + Only the time of the day is used as a reference for an ending + time of the window with a provided recurrence. Specified date + must take place after the one specified as a start date, the + difference between will be used as a length of a single + maintenance window. See $ gcloud topic datetimes for information + on time formats. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE + An RFC 5545 RRULE, specifying how the maintenance window will + recur. The minimum requirement for the length of the maintenance + window is 12 hours a week. Only FREQ=DAILY and FREQ=WEEKLY rules + are supported. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --maintenance-window-start=MAINTENANCE_WINDOW_START + Start time of the mantenance window in the form of the full date. + Only the time of the day is used as a reference for a starting + time of the window with a provided recurrence. See $ gcloud topic + datetimes for information on time formats. + + This flag argument must be specified if any of the other + arguments in this group are specified. + Group of arguments for setting Cloud Data Lineage integration configuration in Composer 2. @@ -201,37 +238,6 @@ REQUIRED FLAGS This flag argument must be specified if any of the other arguments in this group are specified. - Group of arguments for setting the maintenance window value. - - --maintenance-window-end=MAINTENANCE_WINDOW_END - End time of the mantenance window in the form of the full date. - Only the time of the day is used as a reference for an ending time - of the window with a provided recurrence. Specified date must take - place after the one specified as a start date, the difference - between will be used as a length of a single maintenance window. - See $ gcloud topic datetimes for information on time formats. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --maintenance-window-recurrence=MAINTENANCE_WINDOW_RECURRENCE - An RFC 5545 RRULE, specifying how the maintenance window will - recur. The minimum requirement for the length of the maintenance - window is 12 hours a week. Only FREQ=DAILY and FREQ=WEEKLY rules - are supported. - - This flag argument must be specified if any of the other arguments - in this group are specified. - - --maintenance-window-start=MAINTENANCE_WINDOW_START - Start time of the mantenance window in the form of the full date. - Only the time of the day is used as a reference for a starting time - of the window with a provided recurrence. See $ gcloud topic - datetimes for information on time formats. - - This flag argument must be specified if any of the other arguments - in this group are specified. - Group of arguments for setting workloads configuration in Composer 2.X or greater (--scheduler-count flag is available for Composer 1.X as well). diff --git a/gcloud/compute/commitments/create b/gcloud/compute/commitments/create index 038baa07f..115fa90f6 100644 --- a/gcloud/compute/commitments/create +++ b/gcloud/compute/commitments/create @@ -100,8 +100,9 @@ OPTIONAL FLAGS accelerator-optimized-a3, compute-optimized, compute-optimized-c2d, compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, general-purpose-e2, general-purpose-n2, - general-purpose-n2d, general-purpose-t2d, graphics-optimized, - memory-optimized, memory-optimized-m3, storage-optimized-z3. + general-purpose-n2d, general-purpose-n4, general-purpose-t2d, + graphics-optimized, memory-optimized, memory-optimized-m3, + storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/compute/public-advertised-prefixes/create b/gcloud/compute/public-advertised-prefixes/create index 994ae8a54..1b9ebc6b1 100644 --- a/gcloud/compute/public-advertised-prefixes/create +++ b/gcloud/compute/public-advertised-prefixes/create @@ -5,7 +5,8 @@ NAME SYNOPSIS gcloud compute public-advertised-prefixes create NAME --dns-verification-ip=DNS_VERIFICATION_IP --range=RANGE - [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] + [--description=DESCRIPTION] [--pdp-scope=PDP_SCOPE] + [GCLOUD_WIDE_FLAG ...] EXAMPLES To create a public advertised prefix: @@ -14,6 +15,12 @@ EXAMPLES my-public-advertised-prefix --range=120.120.10.0/24 \ --dns-verification-ip=120.120.10.15 + To create a v2 public advertised prefix: + + $ gcloud compute public-advertised-prefixes create \ + my-v2-public-advertised-prefix --range=120.120.10.0/24 \ + --dns-verification-ip=120.120.10.15 --pdp-scope=REGIONAL + POSITIONAL ARGUMENTS NAME Name of the public advertised prefix to operate on. @@ -30,6 +37,10 @@ OPTIONAL FLAGS --description=DESCRIPTION Description of this public advertised prefix. + --pdp-scope=PDP_SCOPE + Specifies how child public delegated prefix will be scoped. PDP_SCOPE + must be one of: GLOBAL, REGIONAL. + 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/public-advertised-prefixes/update b/gcloud/compute/public-advertised-prefixes/update index 3a3371082..84a2d610d 100644 --- a/gcloud/compute/public-advertised-prefixes/update +++ b/gcloud/compute/public-advertised-prefixes/update @@ -3,7 +3,8 @@ NAME public advertised prefix SYNOPSIS - gcloud compute public-advertised-prefixes update NAME --status=STATUS + gcloud compute public-advertised-prefixes update NAME + (--announce-prefix | --status=STATUS | --withdraw-prefix) [GCLOUD_WIDE_FLAG ...] EXAMPLES @@ -12,14 +13,32 @@ EXAMPLES $ gcloud compute public-advertised-prefixes update my-pap \ --status=ptr-configured + To announce a public advertised prefix: + + $ gcloud compute public-advertised-prefixes update my-pap \ + --announce-prefix + + To withdraw a public advertised prefix: + + $ gcloud compute public-advertised-prefixes update my-pap \ + --withdraw-prefix + POSITIONAL ARGUMENTS NAME Name of the public advertised prefix to operate on. REQUIRED FLAGS - --status=STATUS - The status of public advertised prefix. STATUS must be (only one value - is supported): ptr-configured. + Exactly one of these must be specified: + + --announce-prefix + Specify if the prefix will be announced. Default is false. + + --status=STATUS + The status of public advertised prefix. STATUS must be (only one + value is supported): ptr-configured. + + --withdraw-prefix + Specify if the prefix will be withdrawn. Default is false. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/compute/public-delegated-prefixes/help b/gcloud/compute/public-delegated-prefixes/help index 9c2c2b170..655d6017c 100644 --- a/gcloud/compute/public-delegated-prefixes/help +++ b/gcloud/compute/public-delegated-prefixes/help @@ -35,6 +35,9 @@ COMMANDS list List Google Compute Engine public delegated prefixes. + update + Updates a Compute Engine public delegated prefix. + NOTES These variants are also available: diff --git a/gcloud/compute/public-delegated-prefixes/update b/gcloud/compute/public-delegated-prefixes/update new file mode 100644 index 000000000..4ca1c8990 --- /dev/null +++ b/gcloud/compute/public-delegated-prefixes/update @@ -0,0 +1,53 @@ +NAME + gcloud compute public-delegated-prefixes update - updates a Compute Engine + public delegated prefix + +SYNOPSIS + gcloud compute public-delegated-prefixes update NAME + (--announce-prefix | --withdraw-prefix) [--region=REGION] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To announce a regional v2 public delegated prefix: + + $ gcloud compute public-delegated-prefixes update my-pdp \ + --announce-prefix --region=us-central1 + + To withdraw a regional v2 public delegated prefix: + + $ gcloud compute public-delegated-prefixes update my-pdp \ + --withdraw-prefix --region=us-central1 + +POSITIONAL ARGUMENTS + NAME + Name of the public delegated prefix to operate on. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --announce-prefix + Specify if the prefix will be announced. Default is false. + + --withdraw-prefix + Specify if the prefix will be withdrawn. Default is false. + +OPTIONAL FLAGS + --region=REGION + Region of the public delegated prefix 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 + These variants are also available: + + $ gcloud alpha compute public-delegated-prefixes update + + $ gcloud beta compute public-delegated-prefixes update + diff --git a/gcloud/compute/tpus/help b/gcloud/compute/tpus/help index 32c8c100f..a82782a19 100644 --- a/gcloud/compute/tpus/help +++ b/gcloud/compute/tpus/help @@ -30,6 +30,9 @@ GROUPS locations List or Describe Available Cloud TPU Locations. + queued-resources + List, create, delete, and manage Queued Resources. + topologies List available Cloud TPU topologies. diff --git a/gcloud/compute/tpus/queued-resources/create b/gcloud/compute/tpus/queued-resources/create new file mode 100644 index 000000000..39550000f --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/create @@ -0,0 +1,268 @@ +NAME + gcloud compute tpus queued-resources create - create a Queued Resource + +SYNOPSIS + gcloud compute tpus queued-resources create (QUEUED_RESOURCE : --zone=ZONE) + --runtime-version=RUNTIME_VERSION + (--accelerator-type=ACCELERATOR_TYPE | --topology=TOPOLOGY --type=TYPE) + (--node-id=NODE_ID + | [--node-count=NODE_COUNT : --node-prefix=NODE_PREFIX]) [--async] + [--data-disk=[mode=MODE],[source=SOURCE]] [--description=DESCRIPTION] + [--guaranteed] [--internal-ips] [--labels=[KEY=VALUE,...]] + [--metadata=[KEY=VALUE,...]] [--metadata-from-file=[KEY=VALUE,...]] + [--network=NETWORK; default="default"] [--range=RANGE] + [--reservation-host-folder=RESERVATION_HOST_FOLDER] + [--reservation-host-organization=RESERVATION_HOST_ORGANIZATION] + [--reservation-host-project=RESERVATION_HOST_PROJECT] + [--scopes=[SCOPES,...]] [--service-account=SERVICE_ACCOUNT] + [--shielded-secure-boot] [--spot] [--subnetwork=SUBNETWORK] + [--tags=[TAGS,...]] [--valid-after-duration=VALID_AFTER_DURATION] + [--valid-after-time=VALID_AFTER_TIME] + [--valid-until-duration=VALID_UNTIL_DURATION] + [--valid-until-time=VALID_UNTIL_TIME] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a new Queued Resource with the specified attributes. + +EXAMPLES + To create a Queued Resource with ID my-queued-resource in zone + us-central2-b and project my-project, run: + + $ gcloud compute tpus queued-resources create my-queued-resource \ + --accelerator-type=v4-8 --runtime-version=v2-alpha-tpuv4 \ + --node-id=my-node-001 --zone=us-central2-b --project=my-project + + To create a Queued Resource with multiple nodes, run: + + $ gcloud compute tpus queued-resources create my-queued-resource \ + --accelerator-type=v4-8 --runtime-version=v2-alpha-tpuv4 \ + --node-count=2 --zone=us-central2-b --project=my-project + +POSITIONAL ARGUMENTS + Queued resource resource - The Queued Resource you want to create. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument queued_resource 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. + + QUEUED_RESOURCE + ID of the queued_resource or fully qualified identifier for the + queued_resource. + + To set the queued_resource attribute: + ▸ provide the argument queued_resource on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --zone=ZONE + The compute/zone of the Cloud TPU. + + If not specified, will use default compute/zone. + + To set the zone attribute: + ▸ provide the argument queued_resource on the command line with a + fully specified name; + ▸ provide the argument --zone on the command line; + ▸ set the property compute/zone. + +REQUIRED FLAGS + --runtime-version=RUNTIME_VERSION + Runtime version for the TPU, such as 2.3. + + Specify a chip-based or core-based TPU node. + + Exactly one of these must be specified: + + Core-based TPU configuration + + --accelerator-type=ACCELERATOR_TYPE + Accelerator type for the TPU. + + Chip-based TPU configuration + + --topology=TOPOLOGY + Chip topology for TPU. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --type=TYPE + Type of TPU. TYPE must be one of: v2, v3, v4. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + Specify TPU node(s) with either a single node id or a node count and an + optional node prefix + + Exactly one of these must be specified: + + Single node creation + + --node-id=NODE_ID + Unqualified node identifier used to identify the node in the + project once provisioned. + + To request a resource with multiple nodes, in place of --node-id, + use --node-count to specify the number of nodes and optionally use + --node-prefix to specify the prefix for each node. + + Multinode creation + + --node-count=NODE_COUNT + The number of nodes in a multislice provision, also used to + generate the qualified name for nodes in the provision. Value must + be greater than 1. + + This flag argument must be specified if any of the other arguments + in this group are specified. + + --node-prefix=NODE_PREFIX + Node prefix used to generate the qualified name of each node the + multislice node provision. If not supplied, the queued resource id + will be used as the prefix. + + Must also specify --node-count. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --data-disk=[mode=MODE],[source=SOURCE] + Additional data disks for the TPU VM. + + This flag must be repeated to provide multiple data disks. For example: + + $ gcloud compute tpus queued-resources create \ + --data-disk \ + source=projects/my-project/zones/us-central1-c/disks/my-disk,\ + mode=read-only + + The following keys are allowed: + + source + Specifies the full path to an existing disk. Required. The disk + must be in the same zone. + + mode + Specifies the mode in which to attach this disk. Valid options are + 'read-write', 'read-only'. If not specified, the default is + 'read-write'. + + --description=DESCRIPTION + Text description of the TPU. + + --guaranteed + If provided, the Node requested here will only be scheduled at the + 'guaranteed' tier. + + --internal-ips + Indicates that the IP addresses for the node should be internal. The + default is that external IP addresses will be associated with the TPU + workers. + + --labels=[KEY=VALUE,...] + Resource labels to represent user-provided metadata. See + https://cloud.google.com/compute/docs/labeling-resources for details. + + --metadata=[KEY=VALUE,...] + List of comma-separated metadata key-value pairs for the Cloud TPU VM + node. Example: --metadata='key1=value1,key2=value2' + + --metadata-from-file=[KEY=VALUE,...] + Same as --metadata except the value for the entry will be read from a + local file. Example: --metadata-from-file='key1=value1.txt' + + --network=NETWORK; default="default" + Network that this TPU will be a part of. + + --range=RANGE + CIDR range for the TPU. + + The IP range that the TPU will select an IP address from. Must be in + CIDR notation and a /29 range, for example 192.168.0.0/29. Errors will + occur if the CIDR range has already been used for a currently existing + TPU, the CIDR range conflicts with any networks in the user's provided + network, or the provided network is peered with another network that is + using that CIDR range. + + --reservation-host-folder=RESERVATION_HOST_FOLDER + The folder hosting the reservation that the TPU should use. Only one + reservation host entity may be specified. + + --reservation-host-organization=RESERVATION_HOST_ORGANIZATION + The organization hosting the reservation that the TPU should use. Only + one reservation host entity may be specified. + + --reservation-host-project=RESERVATION_HOST_PROJECT + The project hosting the reservation that the TPU should use. Only one + reservation host entity may be specified. + + --scopes=[SCOPES,...] + List of comma-separated scopes to be made available for the service + account. + + --service-account=SERVICE_ACCOUNT + Email address of the service account. If empty, default Google Compute + Engine service account will be used. + + --shielded-secure-boot + Specifies that the TPU instances are created with secure boot enabled. + This implicitly makes them Shielded VM instances. + + --spot + If provided, the Node requested here will be created as Spot VMs. + + --subnetwork=SUBNETWORK + Subnetwork that this TPU will be a part of. + + --tags=[TAGS,...] + Tags to apply to the TPU Node. Tags are used to identify valid sources + or targets for network firewalls. See + https://cloud.google.com/vpc/docs/add-remove-network-tags for more + details. + + --valid-after-duration=VALID_AFTER_DURATION + A duration before which the TPU must not be provisioned, relative to + the current time. See $ gcloud topic datetimes for information on + duration formats. + + --valid-after-time=VALID_AFTER_TIME + An absolute time before which the TPU must not be provisioned. See $ + gcloud topic datetimes for information on duration formats. + + --valid-until-duration=VALID_UNTIL_DURATION + A duration after which the TPU must not be provisioned, relative to the + current time. See $ gcloud topic datetimes for information on duration + formats. + + --valid-until-time=VALID_UNTIL_TIME + An absolute time after which resources must not be created. See $ + gcloud topic datetimes for information on duration formats. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the tpu/v2 API. The full documentation for this API can + be found at: https://cloud.google.com/tpu/ + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources create + diff --git a/gcloud/compute/tpus/queued-resources/delete b/gcloud/compute/tpus/queued-resources/delete new file mode 100644 index 000000000..34802889c --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/delete @@ -0,0 +1,83 @@ +NAME + gcloud compute tpus queued-resources delete - delete a Queued Resource + +SYNOPSIS + gcloud compute tpus queued-resources delete (QUEUED_RESOURCE : --zone=ZONE) + [--async] [--force] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete an existing Queued Resource. + + To get a list of Queued Resources for deletion, run: + + $ gcloud compute tpus queued-resources list + +EXAMPLES + To delete a Queued Resource in zone us-central1-b and project my-project, + run: + + $ gcloud compute tpus queued-resources delete --zone=us-central1-b \ + --project=my-project + +POSITIONAL ARGUMENTS + Queued resource resource - The Queued Resource 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 queued_resource 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. + + QUEUED_RESOURCE + ID of the queued_resource or fully qualified identifier for the + queued_resource. + + To set the queued_resource attribute: + ▸ provide the argument queued_resource on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --zone=ZONE + The compute/zone of the Cloud TPU. + + If not specified, will use default compute/zone. + + To set the zone attribute: + ▸ provide the argument queued_resource on the command line with a + fully specified name; + ▸ provide the argument --zone on the command line; + ▸ set the property compute/zone. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --force + If set to true, any nodes in this queued resource will also be deleted. + Otherwise, the request will only work if the queued resource has no + nodes. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the tpu/v2 API. The full documentation for this API can + be found at: https://cloud.google.com/tpu/ + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources delete + diff --git a/gcloud/compute/tpus/queued-resources/describe b/gcloud/compute/tpus/queued-resources/describe new file mode 100644 index 000000000..9ccee31f6 --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/describe @@ -0,0 +1,73 @@ +NAME + gcloud compute tpus queued-resources describe - describe a Queued Resource + +SYNOPSIS + gcloud compute tpus queued-resources describe + (QUEUED_RESOURCE : --zone=ZONE) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get details on a Queued Resource. + + To get a list of Queued Resources to describe in more detail, run: + + $ gcloud compute tpus queued-resources list + +EXAMPLES + To describe a Queued Resource with ID my-queued-resource in zone + us-central1-b and project 'my-project', run: + + $ gcloud compute tpus queued-resources describe my-queued-resource \ + --zone=us-central1-b --project=my-project + +POSITIONAL ARGUMENTS + Queued resource resource - The Queued Resource you want to describe. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument queued_resource 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. + + QUEUED_RESOURCE + ID of the queued_resource or fully qualified identifier for the + queued_resource. + + To set the queued_resource attribute: + ▸ provide the argument queued_resource on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --zone=ZONE + The compute/zone of the Cloud TPU. + + If not specified, will use default compute/zone. + + To set the zone attribute: + ▸ provide the argument queued_resource on the command line with a + fully specified name; + ▸ provide the argument --zone on the command line; + ▸ set the property compute/zone. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the tpu/v2 API. The full documentation for this API can + be found at: https://cloud.google.com/tpu/ + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources describe + diff --git a/gcloud/compute/tpus/queued-resources/help b/gcloud/compute/tpus/queued-resources/help new file mode 100644 index 000000000..c0c50a154 --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/help @@ -0,0 +1,44 @@ +NAME + gcloud compute tpus queued-resources - list, create, delete, and manage + Queued Resources + +SYNOPSIS + gcloud compute tpus queued-resources COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List, create, delete, and manage Queued Resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create a Queued Resource. + + delete + Delete a Queued Resource. + + describe + Describe a Queued Resource. + + list + List Queued Resources. + + reset + Reset a Queued Resource. + + scp + Copy files to and from a Cloud TPU Queued Resource via SCP. + + ssh + SSH into a Cloud TPU Queued Resource's node(s). + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources + diff --git a/gcloud/compute/tpus/queued-resources/list b/gcloud/compute/tpus/queued-resources/list new file mode 100644 index 000000000..652a53e83 --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/list @@ -0,0 +1,90 @@ +NAME + gcloud compute tpus queued-resources list - list Queued Resources + +SYNOPSIS + gcloud compute tpus queued-resources list [--zone=ZONE] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List all Queued Resources associated with a project and location. + +EXAMPLES + To list all Queued Resources available in zone us-central1-b for project + my-project, run: + + $ gcloud compute tpus queued-resources list --zone=us-central1-b \ + --project=my-project + +FLAGS + Location resource - The compute/zone of the Queued Resource. + + If not specified, will use the value of the [compute/zone] property in the + current gcloud configuration. To find a list of compute zones available + for Cloud TPUs in your project, run gcloud compute tpus queued-resources + locations list. This represents a Cloud resource. (NOTE) Some attributes + are not given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument --zone on the command line with a fully + specified name; + ◆ set the property compute/zone with a fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + --zone=ZONE + ID of the location or fully qualified identifier for the location. + + To set the zone attribute: + ▸ provide the argument --zone on the command line; + ▸ set the property compute/zone. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --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 tpu/v2 API. The full documentation for this API can + be found at: https://cloud.google.com/tpu/ + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources list + diff --git a/gcloud/compute/tpus/queued-resources/reset b/gcloud/compute/tpus/queued-resources/reset new file mode 100644 index 000000000..17a777329 --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/reset @@ -0,0 +1,78 @@ +NAME + gcloud compute tpus queued-resources reset - reset a Queued Resource + +SYNOPSIS + gcloud compute tpus queued-resources reset (QUEUED_RESOURCE : --zone=ZONE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Reset an existing Queued Resource. + + To get a list of Queued Resources for resetting, run: + + $ gcloud compute tpus queued-resources list + +EXAMPLES + To reset a Queued Resource in zone us-central1-b and project my-project, + run: + + $ gcloud compute tpus queued-resources reset --zone=us-central1-b \ + --project=my-project + +POSITIONAL ARGUMENTS + Queued resource resource - The Queued Resource you want to reset. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument queued_resource 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. + + QUEUED_RESOURCE + ID of the queued_resource or fully qualified identifier for the + queued_resource. + + To set the queued_resource attribute: + ▸ provide the argument queued_resource on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --zone=ZONE + The compute/zone of the Cloud TPU. + + If not specified, will use default compute/zone. + + To set the zone attribute: + ▸ provide the argument queued_resource on the command line with a + fully specified name; + ▸ provide the argument --zone on the command line; + ▸ set the property compute/zone. + +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 tpu/v2 API. The full documentation for this API can + be found at: https://cloud.google.com/tpu/ + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources reset + diff --git a/gcloud/compute/tpus/queued-resources/scp b/gcloud/compute/tpus/queued-resources/scp new file mode 100644 index 000000000..8cbb35eaa --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/scp @@ -0,0 +1,206 @@ +NAME + gcloud compute tpus queued-resources scp - copy files to and from a Cloud + TPU Queued Resource via SCP + +SYNOPSIS + gcloud compute tpus queued-resources scp [[USER@]INSTANCE:]SRC + [[[USER@]INSTANCE:]SRC ...] [[USER@]INSTANCE:]DEST + [--batch-size=BATCH_SIZE; default=64] [--compress] [--dry-run] + [--force-key-file-overwrite] [--node=NODE; default="0"] [--plain] + [--recurse] [--scp-flag=SCP_FLAG] [--ssh-key-file=SSH_KEY_FILE] + [--strict-host-key-checking=STRICT_HOST_KEY_CHECKING] + [--worker=WORKER; default="0"] [--zone=ZONE] + [--internal-ip | --tunnel-through-iap] + [--ssh-key-expiration=SSH_KEY_EXPIRATION + | --ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Copy files to and from a Cloud TPU Queued Resource via SCP. + +EXAMPLES + To copy a file (for example, a text file in the local home directory) to a + Cloud Queued Resource, run: + + $ gcloud compute tpus queued-resources scp ~/my-file my-qr: + + To copy a file into all nodes and workers in a Cloud TPU Queued Resource + (with the default batch size), run: + + $ gcloud compute tpus queued-resources scp ~/my-file my-qr: \ + --worker=all --node=all + + To copy a file into all nodes and workers in a Cloud TPU Queued Resource + with a batch size of 4, run: + + $ gcloud compute tpus queued-resources scp ~/my-file my-qr: \ + --worker=all --node=all --batch-size=4 + + To copy a file into all workers in the first node of a Cloud TPU Queued + Resource, run: + + $ gcloud compute tpus queued-resources scp ~/my-file my-qr: \ + --worker=all + + To copy a file from a Cloud TPU Queued Resource to the home directory of + the local computer, run: + + $ gcloud compute tpus queued-resources scp my-qr:~/my-file ~/ + + To copy all files in a folder to a Cloud TPU Queued Resource, run: + + $ gcloud compute tpus queued-resources scp ~/my-folder/ my-qr: \ + --recurse + +POSITIONAL ARGUMENTS + [[USER@]INSTANCE:]SRC [[[USER@]INSTANCE:]SRC ...] + Specifies the files to copy. + + [[USER@]INSTANCE:]DEST + Specifies a destination for the source files. + +FLAGS + --batch-size=BATCH_SIZE; default=64 + Batch size for simultaneous command execution on the client's side. + When using a comma-separated list (e.g. '1,4,6') or a range (e.g. + '1-3') or ``all`` keyword in --worker flag, it executes the command + concurrently in groups of the batch size. This flag takes a value + greater than 0 to specify the batch size to control the concurrent + connections that can be established with the TPU workers, or the + special keyword ``all`` to allow the concurrent command executions on + all the specified workers in --worker flag. Maximum value of this flag + should not be more than the number of specified workers, otherwise the + value will be treated as ``--batch-size=all``. + + --compress + Enable compression. + + --dry-run + Print the equivalent scp/ssh command that would be run to stdout, + instead of executing it. + + --force-key-file-overwrite + If enabled, the gcloud command-line tool will regenerate and overwrite + the files associated with a broken SSH key without asking for + confirmation in both interactive and non-interactive environments. + + If disabled, the files associated with a broken SSH key will not be + regenerated and will fail in both interactive and non-interactive + environments. + + --node=NODE; default="0" + TPU node(s) to connect to. The supported value is a single 0-based + index of the node(s) in the case of a TPU Pod. It additionally supports + a comma-separated list (e.g. '1,4,6'), range (e.g. '1-3'), or special + keyword ``all" to run the command concurrently on each of the specified + node(s). + + Note that when targeting multiple nodes, you should run 'ssh-add' with + your private key prior to executing the gcloud command. Default: + 'ssh-add ~/.ssh/google_compute_engine'. + + --plain + Suppress the automatic addition of ssh(1)/scp(1) flags. This flag is + useful if you want to take care of authentication yourself or use + specific ssh/scp features. + + --recurse + Upload directories recursively. + + --scp-flag=SCP_FLAG + Additional flags to be passed to scp(1). This flag may be repeated. + + --ssh-key-file=SSH_KEY_FILE + The path to the SSH key file. By default, this is + ~/.ssh/google_compute_engine. + + --strict-host-key-checking=STRICT_HOST_KEY_CHECKING + Override the default behavior of StrictHostKeyChecking for the + connection. By default, StrictHostKeyChecking is set to 'no' the first + time you connect to an instance, and will be set to 'yes' for all + subsequent connections. STRICT_HOST_KEY_CHECKING must be one of: yes, + no, ask. + + --worker=WORKER; default="0" + TPU worker to connect to. The supported value is a single 0-based index + of the worker in the case of a TPU Pod. When also using the --command + flag, it additionally supports a comma-separated list (e.g. '1,4,6'), + range (e.g. '1-3'), or special keyword ``all" to run the command + concurrently on each of the specified workers. + + Note that when targeting multiple workers, you should run 'ssh-add' + with your private key prior to executing the gcloud command. Default: + 'ssh-add ~/.ssh/google_compute_engine'. + + --zone=ZONE + Zone of the tpu to scp. If not specified and the compute/zone property + isn't set, you might be prompted to select a zone (interactive mode + only). + + To avoid prompting when this flag is omitted, you can set the + compute/zone property: + + $ gcloud config set compute/zone ZONE + + A list of zones can be fetched by running: + + $ gcloud compute zones list + + To unset the property, run: + + $ gcloud config unset compute/zone + + Alternatively, the zone can be stored in the environment variable + CLOUDSDK_COMPUTE_ZONE. + + At most one of these can be specified: + + --internal-ip + Connect to TPU VMs using their internal IP addresses rather than + their external IP addresses. Use this to connect from a Google + Compute Engine VM to a TPU VM on the same VPC network, or between two + peered VPC networks. + + --tunnel-through-iap + Tunnel the SSH connection through Cloud Identity-Aware Proxy for TCP + forwarding. + + This flag must be specified to attempt to connect via IAP tunneling. + If it is not set, and connection to a Cloud TPU VM without external + IP address is attempted from outside the network, then the command + will fail. + + To use IAP tunneling, there must be firewall access to the SSH port + for the IAP TCP IP address range for the network the TPU is created + in. See the user guide + (https://cloud.google.com/iap/docs/using-tcp-forwarding) for more + details. + + To learn more, see the IAP for TCP forwarding documentation + (https://cloud.google.com/iap/docs/tcp-forwarding-overview). + + At most one of these can be specified: + + --ssh-key-expiration=SSH_KEY_EXPIRATION + The time when the ssh key will be valid until, such as + "2017-08-29T18:52:51.142Z." This is only valid if the instance is not + using OS Login. See $ gcloud topic datetimes for information on time + formats. + + --ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER + The maximum length of time an SSH key is valid for once created and + installed, e.g. 2m for 2 minutes. See $ gcloud topic datetimes for + information on duration formats. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources scp + diff --git a/gcloud/compute/tpus/queued-resources/ssh b/gcloud/compute/tpus/queued-resources/ssh new file mode 100644 index 000000000..f47f72978 --- /dev/null +++ b/gcloud/compute/tpus/queued-resources/ssh @@ -0,0 +1,237 @@ +NAME + gcloud compute tpus queued-resources ssh - SSH into a Cloud TPU Queued + Resource's node(s) + +SYNOPSIS + gcloud compute tpus queued-resources ssh [USER@]QR + [--batch-size=BATCH_SIZE; default=64] [--dry-run] + [--force-key-file-overwrite] [--node=NODE; default="0"] [--plain] + [--ssh-flag=SSH_FLAG] [--ssh-key-file=SSH_KEY_FILE] + [--strict-host-key-checking=STRICT_HOST_KEY_CHECKING] + [--worker=WORKER; default="0"] [--zone=ZONE] + [--command=COMMAND : --output-directory=OUTPUT_DIRECTORY] + [--internal-ip | --tunnel-through-iap] + [--ssh-key-expiration=SSH_KEY_EXPIRATION + | --ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER] [GCLOUD_WIDE_FLAG ...] + [-- SSH_ARGS ...] + +DESCRIPTION + Send SSH commands to a Cloud TPU Queued Resource. + +EXAMPLES + To run an SSH command in a Cloud TPU Queued Resource's first node and first + worker (for example, to print the time since last boot), run: + + $ gcloud compute tpus queued-resources ssh my-qr \ + --command="last boot" + + To run the same command in all nodes and workers in a Cloud TPU Queued + Resource (with the default batch size), run: + + $ gcloud compute tpus queued-resources ssh my-qr \ + --command="last boot" --worker=all --node=all + + To run the same command in all nodes and workers in a Cloud TPU Queued + Resource but batching the request in groups of 4, run: + + $ gcloud compute tpus queued-resources ssh my-qr \ + --command="last boot" --worker=all --node=all --batch-size=4 + +POSITIONAL ARGUMENTS + [USER@]QR + Specifies the Cloud TPU Queued Resource to send SSH command to. + + USER specifies the username with which to SSH. If omitted, the user + login name is used. + + QR specifies the name of the Cloud TPU Queued Resource to send SSH + command to. + + [-- SSH_ARGS ...] + Flags and positionals passed to the underlying ssh implementation. + + The '--' argument must be specified between gcloud specific args on the + left and SSH_ARGS on the right. Example: + + $ gcloud compute tpus queued-resources ssh example-instance \ + --zone=us-central1-a -- -vvv -L 80:%TPU%:80 + +FLAGS + --batch-size=BATCH_SIZE; default=64 + Batch size for simultaneous command execution on the client's side. + When using a comma-separated list (e.g. '1,4,6') or a range (e.g. + '1-3') or ``all`` keyword in --worker flag, it executes the command + concurrently in groups of the batch size. This flag takes a value + greater than 0 to specify the batch size to control the concurrent + connections that can be established with the TPU workers, or the + special keyword ``all`` to allow the concurrent command executions on + all the specified workers in --worker flag. Maximum value of this flag + should not be more than the number of specified workers, otherwise the + value will be treated as ``--batch-size=all``. + + --dry-run + Print the equivalent scp/ssh command that would be run to stdout, + instead of executing it. + + --force-key-file-overwrite + If enabled, the gcloud command-line tool will regenerate and overwrite + the files associated with a broken SSH key without asking for + confirmation in both interactive and non-interactive environments. + + If disabled, the files associated with a broken SSH key will not be + regenerated and will fail in both interactive and non-interactive + environments. + + --node=NODE; default="0" + TPU node(s) to connect to. The supported value is a single 0-based + index of the node(s) in the case of a TPU Pod. When also using the + --command flag, it additionally supports a comma-separated list (e.g. + '1,4,6'), range (e.g. '1-3'), or special keyword ``all" to run the + command concurrently on each of the specified node(s). + + Note that when targeting multiple nodes, you should run 'ssh-add' with + your private key prior to executing the gcloud command. Default: + 'ssh-add ~/.ssh/google_compute_engine'. + + --plain + Suppress the automatic addition of ssh(1)/scp(1) flags. This flag is + useful if you want to take care of authentication yourself or use + specific ssh/scp features. + + --ssh-flag=SSH_FLAG + Additional flags to be passed to ssh(1). It is recommended that flags + be passed using an assignment operator and quotes. Example: + + $ gcloud compute tpus queued-resources ssh example-instance \ + --zone=us-central1-a --ssh-flag="-vvv" \ + --ssh-flag="-L 80:localhost:80" + + This flag will replace occurences of %USER% and %TPU% with their + dereferenced values. For example, passing ``80:%TPU%:80`` into the flag + is equivalent to passing 80:162.222.181.197:80 to ssh(1) if the + external IP address of 'example-instance' is 162.222.181.197. + + If connecting to the instance's external IP, then %TPU% is replaced + with that, otherwise it is replaced with the internal IP. + + --ssh-key-file=SSH_KEY_FILE + The path to the SSH key file. By default, this is + ~/.ssh/google_compute_engine. + + --strict-host-key-checking=STRICT_HOST_KEY_CHECKING + Override the default behavior of StrictHostKeyChecking for the + connection. By default, StrictHostKeyChecking is set to 'no' the first + time you connect to an instance, and will be set to 'yes' for all + subsequent connections. STRICT_HOST_KEY_CHECKING must be one of: yes, + no, ask. + + --worker=WORKER; default="0" + TPU worker to connect to. The supported value is a single 0-based index + of the worker in the case of a TPU Pod. When also using the --command + flag, it additionally supports a comma-separated list (e.g. '1,4,6'), + range (e.g. '1-3'), or special keyword ``all" to run the command + concurrently on each of the specified workers. + + Note that when targeting multiple workers, you should run 'ssh-add' + with your private key prior to executing the gcloud command. Default: + 'ssh-add ~/.ssh/google_compute_engine'. + + --zone=ZONE + Zone of the tpu to ssh. If not specified and the compute/zone property + isn't set, you might be prompted to select a zone (interactive mode + only). + + To avoid prompting when this flag is omitted, you can set the + compute/zone property: + + $ gcloud config set compute/zone ZONE + + A list of zones can be fetched by running: + + $ gcloud compute zones list + + To unset the property, run: + + $ gcloud config unset compute/zone + + Alternatively, the zone can be stored in the environment variable + CLOUDSDK_COMPUTE_ZONE. + + These arguments are used to run commands using SSH. + + --command=COMMAND + Command to run on the Cloud TPU VM. + + Runs the command on the target Cloud TPU Queued Resource's nodes and + then exits. + + Note: in the case of a TPU Pod, it will only run the command in the + workers specified with the --worker flag (defaults to worker all if + not set). + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --output-directory=OUTPUT_DIRECTORY + Path to the directory to output the logs of the commands. + + The path can be relative or absolute. The directory must already + exist. + + If not specified, standard output will be used. + + The logs will be written in files named {WORKER_ID}.log. For example: + "2.log". + + At most one of these can be specified: + + --internal-ip + Connect to TPU VMs using their internal IP addresses rather than + their external IP addresses. Use this to connect from a Google + Compute Engine VM to a TPU VM on the same VPC network, or between two + peered VPC networks. + + --tunnel-through-iap + Tunnel the SSH connection through Cloud Identity-Aware Proxy for TCP + forwarding. + + This flag must be specified to attempt to connect via IAP tunneling. + If it is not set, and connection to a Cloud TPU VM without external + IP address is attempted from outside the network, then the command + will fail. + + To use IAP tunneling, there must be firewall access to the SSH port + for the IAP TCP IP address range for the network the TPU is created + in. See the user guide + (https://cloud.google.com/iap/docs/using-tcp-forwarding) for more + details. + + To learn more, see the IAP for TCP forwarding documentation + (https://cloud.google.com/iap/docs/tcp-forwarding-overview). + + At most one of these can be specified: + + --ssh-key-expiration=SSH_KEY_EXPIRATION + The time when the ssh key will be valid until, such as + "2017-08-29T18:52:51.142Z." This is only valid if the instance is not + using OS Login. See $ gcloud topic datetimes for information on time + formats. + + --ssh-key-expire-after=SSH_KEY_EXPIRE_AFTER + The maximum length of time an SSH key is valid for once created and + installed, e.g. 2m for 2 minutes. See $ gcloud topic datetimes for + information on duration formats. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha compute tpus queued-resources ssh + diff --git a/gcloud/container/binauthz/attestors/create b/gcloud/container/binauthz/attestors/create index 617695cf2..5bd7407ef 100644 --- a/gcloud/container/binauthz/attestors/create +++ b/gcloud/container/binauthz/attestors/create @@ -7,12 +7,15 @@ SYNOPSIS : --attestation-authority-note-project=ATTESTATION_AUTHORITY_NOTE_PROJECT) [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] +DESCRIPTION + Create an Attestor. + EXAMPLES To create an Attestor with an existing Note projects/my_proj/notes/my_note: $ gcloud container binauthz attestors create my_new_attestor \ --attestation-authority-note=my_note \ - --attestation-authority-note-project=my_proj \ + --attestation-authority-note-project=my_proj POSITIONAL ARGUMENTS Attestor resource - The attestor to be created. This represents a Cloud diff --git a/gcloud/container/clusters/update b/gcloud/container/clusters/update index a5f04d3f4..aa194bad1 100644 --- a/gcloud/container/clusters/update +++ b/gcloud/container/clusters/update @@ -19,9 +19,10 @@ SYNOPSIS | --enable-kubernetes-unstable-apis=API,[API,...] | --enable-l4-ilb-subsetting | --enable-legacy-authorization | --enable-master-authorized-networks | --enable-master-global-access - | --enable-network-policy | --enable-private-endpoint - | --enable-service-externalips | --enable-shielded-nodes - | --enable-stackdriver-kubernetes | --enable-vertical-pod-autoscaling + | --enable-multi-networking | --enable-network-policy + | --enable-private-endpoint | --enable-service-externalips + | --enable-shielded-nodes | --enable-stackdriver-kubernetes + | --enable-vertical-pod-autoscaling | --fleet-project=PROJECT_ID_OR_NUMBER | --gateway-api=GATEWAY_API | --generate-password | --in-transit-encryption=IN_TRANSIT_ENCRYPTION | --logging-variant=LOGGING_VARIANT | --maintenance-window=START_TIME @@ -329,6 +330,10 @@ REQUIRED FLAGS endpoint from any Google Cloud region or on-premises environment regardless of the private cluster's region. + --enable-multi-networking + Enables multi-networking on the cluster. Multi-networking is disabled + by default. + --enable-network-policy Enable network policy enforcement for this cluster. If you are enabling network policy on an existing cluster the network policy diff --git a/gcloud/container/images/help b/gcloud/container/images/help index 37f33a4ff..e916d1c66 100644 --- a/gcloud/container/images/help +++ b/gcloud/container/images/help @@ -28,6 +28,9 @@ COMMANDS list List existing images. + list-gcr-usage + List Container Registry usage. + list-tags List tags and digests for the specified image. diff --git a/gcloud/container/images/list-gcr-usage b/gcloud/container/images/list-gcr-usage new file mode 100644 index 000000000..b135ffae3 --- /dev/null +++ b/gcloud/container/images/list-gcr-usage @@ -0,0 +1,118 @@ +NAME + gcloud container images list-gcr-usage - list Container Registry usage + +SYNOPSIS + gcloud container images list-gcr-usage + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID + | --project=PROJECT_ID) [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List Container Registry usage for all projects in the specified scope + (project/organization/folder). Caller must have + cloudasset.assets.searchAllResources permission on the requested scope and + storage.objects.list permission on the Cloud Storage buckets used by + Container Registry. + + The tool returns the following lists of usage states: + + ACTIVE: Container Registry usage has occurred in the last 30 days. The host + location and project are not redirected. + + INACTIVE: No Container Registry usage has occurred in the last 30 days. The + host location and project are not redirected. + + REDIRECTED: The project has been redirected to Artifact Registry but still + has Container Registry Cloud Storage buckets. This project will continue to + function after Container Registry is turned down and no further action is + required. You can reduce costs by deleting the Container Registry Cloud + Storage buckets. + + REDIRECTION_INCOMPLETE: Requests are redirected to Artifact Registry, but + data is still being copied from Container Registry. + + LEGACY: Container Registry usage is unknown. This state is caused by legacy + Container Registry projects that store container image metadata files in + Cloud Storage buckets. For more information on legacy Container Registry + projects, see + https://cloud.google.com/container-registry/docs/deprecations/feature-deprecations#container_image_metadata_storage_change. + +EXAMPLES + To list Container Registry usage in a project: + + $ gcloud container images list-gcr-usage --project=my-proj + + To list Container Registry usage in an organization: + + $ gcloud container images list-gcr-usage --organization=my-org + + To list Container Registry usage in a folder: + + $ gcloud container images list-gcr-usage --folder=my-folder + + To list all active Container Registry usage in an organization: + + $ gcloud container images list-gcr-usage --organization=my-org \ + --filter="usage=ACTIVE" + + To list all projects that aren't redirected yet: + + $ gcloud container images list-gcr-usage --organization=my-org \ + --filter="usage!=REDIRECTED" + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder ID. + + --organization=ORGANIZATION_ID + Organization ID. + + --project=PROJECT_ID + Project ID. + + The Google Cloud project ID to use for this invocation. If omitted, + then the current project is assumed; the current project can be + listed using gcloud config list --format='text(core.project)' and can + be set using gcloud config set project PROJECTID. + + --project and its fallback core/project property play two roles in + the invocation. It specifies the project of the resource to operate + on. It also specifies the project for API enablement check, quota, + and billing. To specify a different project for quota and billing, + use --billing-project or billing/quota_project property. + +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. diff --git a/gcloud/dataflow/jobs/update-options b/gcloud/dataflow/jobs/update-options index d119c073b..719911451 100644 --- a/gcloud/dataflow/jobs/update-options +++ b/gcloud/dataflow/jobs/update-options @@ -5,15 +5,19 @@ NAME SYNOPSIS gcloud dataflow jobs update-options JOB_ID [--max-num-workers=MAX_NUM_WORKERS] [--min-num-workers=MIN_NUM_WORKERS] - [--region=REGION_ID] [GCLOUD_WIDE_FLAG ...] + [--region=REGION_ID] [--unset-worker-utilization-hint] + [--worker-utilization-hint=WORKER_UTILIZATION_HINT] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command can modify properties of running Dataflow jobs. Currently, only updating autoscaling settings for Streaming Engine jobs is supported. Adjust the autoscaling settings for Streaming Engine Dataflow jobs by - providing at-least one of --min-num-workers or --max-num-workers (or both). - Allow a few minutes for the changes to take effect. + providing at-least one of --min-num-workers or --max-num-workers or + --worker-utilization-hint (or all 3), or --unset-worker-utilization-hint + (which cannot be run at the same time as --worker-utilization-hint but + works with the others). Allow a few minutes for the changes to take effect. Note that autoscaling settings can only be modified on-the-fly for Streaming Engine jobs. Attempts to modify batch job or Streaming Appliance @@ -33,6 +37,16 @@ EXAMPLES $ gcloud dataflow jobs update-options --max-num-workers=20 + Adjust the hint of target worker utilization to 70% for horizontal + autoscaling: + + $ gcloud dataflow jobs update-options --worker-utilization-hint=0.7 + + "Unset" worker utilization hint so that horizontal scaling will rely on its + default CPU utilization target: + + $ gcloud dataflow jobs update-options --unset-worker-utilization-hint + POSITIONAL ARGUMENTS JOB_ID Job ID to operate on. @@ -49,6 +63,15 @@ FLAGS --region=REGION_ID Region ID of the job's regional endpoint. Defaults to 'us-central1'. + --unset-worker-utilization-hint + Unset --worker-utilization-hint. This causes the job autoscaling to + fall back to internal tunings if they exist, or otherwise use the + default hint value. + + --worker-utilization-hint=WORKER_UTILIZATION_HINT + Target CPU utilization for autoscaling, ranging from 0.1 to 0.9. Only + supported for streaming-engine jobs with autoscaling enabled. + 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/filestore/instances/create b/gcloud/filestore/instances/create index 7cca0482d..ca8ba270c 100644 --- a/gcloud/filestore/instances/create +++ b/gcloud/filestore/instances/create @@ -106,7 +106,9 @@ REQUIRED FLAGS ▫ 1TB-9.75TB in 256GB increments or its multiples. ▫ 10TB-100TB in 2.5TB increments or its multiples. ▸ ENTERPRISE: 1TB-10TB in 256GB increments or its multiples. - ▸ REGIONAL: 1TB-9.75TB in 256GB increments or its multiples. + ▸ REGIONAL: 1TB-100TB: + ▫ 1TB-9.75TB in 256GB increments or its multiples. + ▫ 10TB-100TB in 2.5TB increments or its multiples. name The desired logical name of the volume. diff --git a/gcloud/filestore/instances/update b/gcloud/filestore/instances/update index 61aa211af..e65a1efd6 100644 --- a/gcloud/filestore/instances/update +++ b/gcloud/filestore/instances/update @@ -151,7 +151,9 @@ FLAGS ▫ 1TB-9.75TB in 256GB increments or its multiples. ▫ 10TB-100TB in 2.5TB increments or its multiples. ▸ ENTERPRISE: 1TB-10TB in 256GB increments or its multiples. - ▸ REGIONAL: 1TB-9.75TB in 256GB increments or its multiples. + ▸ REGIONAL: 1TB-100TB: + ▫ 1TB-9.75TB in 256GB increments or its multiples. + ▫ 10TB-100TB in 2.5TB increments or its multiples. name The desired logical name of the volume. diff --git a/gcloud/infra-manager/deployments/apply b/gcloud/infra-manager/deployments/apply index b973894bf..1ade37e9c 100644 --- a/gcloud/infra-manager/deployments/apply +++ b/gcloud/infra-manager/deployments/apply @@ -121,7 +121,7 @@ FLAGS projects/{projectID}/serviceAccounts/{serviceAccount} --worker-pool=WORKER_POOL - User-specified Worker Pool resource in which the Cloud Build jobwill + User-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} diff --git a/gcloud/infra-manager/previews/create b/gcloud/infra-manager/previews/create index 82f49f125..2fc9cafb7 100644 --- a/gcloud/infra-manager/previews/create +++ b/gcloud/infra-manager/previews/create @@ -121,7 +121,7 @@ FLAGS projects/{projectID}/serviceAccounts/{serviceAccount} --worker-pool=WORKER_POOL - User-specified Worker Pool resource in which the Cloud Build jobwill + User-specified Worker Pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId} diff --git a/gcloud/run/services/replace b/gcloud/run/services/replace index 3c3d40ef1..aeb781b7e 100644 --- a/gcloud/run/services/replace +++ b/gcloud/run/services/replace @@ -3,8 +3,8 @@ NAME service specification SYNOPSIS - gcloud run services replace FILE [--async] [--namespace=NAMESPACE] - [--platform=PLATFORM; default="managed"] + gcloud run services replace FILE [--async] [--dry-run] + [--namespace=NAMESPACE] [--platform=PLATFORM; default="managed"] [--region=REGION | --cluster=CLUSTER --cluster-location=CLUSTER_LOCATION | --context=CONTEXT --kubeconfig=KUBECONFIG] [GCLOUD_WIDE_FLAG ...] @@ -27,6 +27,10 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. + --dry-run + If set to true, only validates the configuration. The configuration + will not be applied. + Only applicable if connecting to Cloud Run for Anthos deployed on Google Cloud or Cloud Run for Anthos deployed on VMware. Specify --platform=gke or --platform=kubernetes to use: diff --git a/gcloud/transfer/agents/install b/gcloud/transfer/agents/install index 4fe31e094..bb44ac62a 100644 --- a/gcloud/transfer/agents/install +++ b/gcloud/transfer/agents/install @@ -8,7 +8,14 @@ SYNOPSIS [--logs-directory=LOGS_DIRECTORY; default="/tmp"] [--memlock-limit=MEMLOCK_LIMIT; default=64000000] [--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY] - [--s3-compatible-mode] [GCLOUD_WIDE_FLAG ...] + [--s3-compatible-mode] + [--hdfs-namenode-uri=HDFS_NAMENODE_URI --hdfs-username=HDFS_USERNAME + --hdfs-data-transfer-protection=HDFS_DATA_TRANSFER_PROTECTION] + [--kerberos-config-file=KERBEROS_CONFIG_FILE + --kerberos-keytab-file=KERBEROS_KEYTAB_FILE + --kerberos-user-principal=KERBEROS_USER_PRINCIPAL + --kerberos-service-principal=KERBEROS_SERVICE_PRINCIPAL] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Install Transfer Service agents to enable you to transfer data to or from @@ -39,7 +46,7 @@ REQUIRED FLAGS creating transfer jobs, the agent pool parameter will determine which agents are activated. -OPTIONAL FLAGS +FLAGS --count=COUNT Specify the number of agents to install on your current machine. System requirements: 8 GB of memory and 4 CPUs per agent. @@ -120,6 +127,43 @@ OPTIONAL FLAGS AWS_ACCESS_KEY_ID="id" AWS_SECRET_ACCESS_KEY="secret" gcloud transfer agents install --s3-compatible-mode +HDFS FLAGS + --hdfs-namenode-uri=HDFS_NAMENODE_URI + A URI representing an HDFS cluster including a schema, namenode, and + port. Examples: "rpc://my-namenode:8020", "http://my-namenode:9870". + + Use "http" or "https" for WebHDFS. If no schema is provided, the CLI + assumes native "rpc". If no port is provided, the default is 8020 for + RPC, 9870 for HTTP, and 9871 for HTTPS. For example, the input + "my-namenode" becomes "rpc://my-namenode:8020". + + --hdfs-username=HDFS_USERNAME + Username for connecting to an HDFS cluster with simple auth. + + --hdfs-data-transfer-protection=HDFS_DATA_TRANSFER_PROTECTION + Client-side quality of protection setting for Kerberized clusters. + Client-side QOP value cannot be more restrictive than the server-side + QOP value. HDFS_DATA_TRANSFER_PROTECTION must be one of: + authentication, integrity, privacy. + +Kerberos FLAGS + --kerberos-config-file=KERBEROS_CONFIG_FILE + Path to Kerberos config file. + + --kerberos-keytab-file=KERBEROS_KEYTAB_FILE + Path to a Keytab file containing the user principal specified with the + --kerberos-user-principal flag. + + --kerberos-user-principal=KERBEROS_USER_PRINCIPAL + Kerberos user principal to use when connecting to an HDFS cluster via + Kerberos auth. + + --kerberos-service-principal=KERBEROS_SERVICE_PRINCIPAL + Kerberos service principal to use, of the form "/". + Realm is mapped from your Kerberos config. Any supplied realm is + ignored. If not passed in, it will default to "hdfs/" + (fqdn = fully qualified domain name). + 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/workstations/configs/create b/gcloud/workstations/configs/create index 1f0c996da..4633c88ff 100644 --- a/gcloud/workstations/configs/create +++ b/gcloud/workstations/configs/create @@ -137,11 +137,11 @@ FLAGS address. --disable-ssh-to-vm - Default value is False. If set, workstations will disable SSH - connections to the root VM. + Default value is False. If set, workstations disable SSH connections to + the root VM. --disable-tcp-connections - Default value is false. If set, workstations will not allow plain TCP + Default value is false. If set, workstations don't allow plain TCP connections. --enable-audit-agent diff --git a/gcloud/workstations/configs/update b/gcloud/workstations/configs/update index 006db5923..95e9e457b 100644 --- a/gcloud/workstations/configs/update +++ b/gcloud/workstations/configs/update @@ -232,22 +232,18 @@ FLAGS At most one of these can be specified: --disable-ssh-to-vm - Default value is False. If set, workstations will enable SSH - connections to the root VM. + If set, workstations disable SSH connections to the root VM. --enable-ssh-to-vm - Default value is False. If set, workstations will enable SSH - connections to the root VM. + If set, workstations enable SSH connections to the root VM. At most one of these can be specified: --disable-tcp-connections - Default value is false. If set, workstations will allow plain TCP - connections. + If set, workstations don't allow plain TCP connections. --enable-tcp-connections - Default value is false. If set, workstations will allow plain TCP - connections. + If set, workstations allow plain TCP connections. GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account,