diff --git a/gcloud/_version b/gcloud/_version index b71dcde89..a74333f22 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,6 +1,6 @@ -Google Cloud SDK 389.0.0 -alpha 2022.06.03 -beta 2022.06.03 -bq 2.0.74 -core 2022.06.03 +Google Cloud SDK 390.0.0 +alpha 2022.06.10 +beta 2022.06.10 +bq 2.0.75 +core 2022.06.10 gsutil 5.10 diff --git a/gcloud/access-approval/requests/approve b/gcloud/access-approval/requests/approve index 118d19ebd..f7e0e0fb8 100644 --- a/gcloud/access-approval/requests/approve +++ b/gcloud/access-approval/requests/approve @@ -18,7 +18,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/access-approval/requests/dismiss b/gcloud/access-approval/requests/dismiss index 168c7217e..d0d093a51 100644 --- a/gcloud/access-approval/requests/dismiss +++ b/gcloud/access-approval/requests/dismiss @@ -19,7 +19,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/access-approval/requests/get b/gcloud/access-approval/requests/get index cf808f217..3128c30f7 100644 --- a/gcloud/access-approval/requests/get +++ b/gcloud/access-approval/requests/get @@ -16,7 +16,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/access-approval/requests/help b/gcloud/access-approval/requests/help index 8db1666d4..6b9a62c12 100644 --- a/gcloud/access-approval/requests/help +++ b/gcloud/access-approval/requests/help @@ -27,6 +27,9 @@ COMMANDS get Get an Access Approval request. + invalidate + Invalidate an Access Approval request. + list List Access Approval requests. diff --git a/gcloud/access-approval/requests/invalidate b/gcloud/access-approval/requests/invalidate new file mode 100644 index 000000000..63a37106b --- /dev/null +++ b/gcloud/access-approval/requests/invalidate @@ -0,0 +1,37 @@ +NAME + gcloud access-approval requests invalidate - invalidate an Access Approval + request + +SYNOPSIS + gcloud access-approval requests invalidate NAME [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Invalidate an Access Approval request. This will raise an error if the + request does not exist or is not in an approved state. + +EXAMPLES + To invalidate an approval request using its name (e.g. + projects/12345/approvalRequests/abc123), run: + + $ gcloud access-approval requests invalidate \ + projects/12345/approvalRequests/abc123 + +POSITIONAL ARGUMENTS + NAME + Name of the Access Approval request to invalidate + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 access-approval requests invalidate + + $ gcloud beta access-approval requests invalidate + diff --git a/gcloud/alpha/access-approval/requests/approve b/gcloud/alpha/access-approval/requests/approve index facdc746b..7e94db955 100644 --- a/gcloud/alpha/access-approval/requests/approve +++ b/gcloud/alpha/access-approval/requests/approve @@ -18,7 +18,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/access-approval/requests/dismiss b/gcloud/alpha/access-approval/requests/dismiss index 57ac0e077..2582b9e08 100644 --- a/gcloud/alpha/access-approval/requests/dismiss +++ b/gcloud/alpha/access-approval/requests/dismiss @@ -19,7 +19,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/access-approval/requests/get b/gcloud/alpha/access-approval/requests/get index 194088325..b0e7ccb19 100644 --- a/gcloud/alpha/access-approval/requests/get +++ b/gcloud/alpha/access-approval/requests/get @@ -17,7 +17,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/alpha/access-approval/requests/help b/gcloud/alpha/access-approval/requests/help index a506467c6..1779645fd 100644 --- a/gcloud/alpha/access-approval/requests/help +++ b/gcloud/alpha/access-approval/requests/help @@ -27,6 +27,9 @@ COMMANDS get (ALPHA) Get an Access Approval request. + invalidate + (ALPHA) Invalidate an Access Approval request. + list (ALPHA) List Access Approval requests. diff --git a/gcloud/alpha/access-approval/requests/invalidate b/gcloud/alpha/access-approval/requests/invalidate new file mode 100644 index 000000000..61ab1d6e4 --- /dev/null +++ b/gcloud/alpha/access-approval/requests/invalidate @@ -0,0 +1,41 @@ +NAME + gcloud alpha access-approval requests invalidate - invalidate an Access + Approval request + +SYNOPSIS + gcloud alpha access-approval requests invalidate NAME + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Invalidate an Access Approval request. This will raise an error if + the request does not exist or is not in an approved state. + +EXAMPLES + To invalidate an approval request using its name (e.g. + projects/12345/approvalRequests/abc123), run: + + $ gcloud alpha access-approval requests invalidate \ + projects/12345/approvalRequests/abc123 + +POSITIONAL ARGUMENTS + NAME + Name of the Access Approval request to invalidate + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 access-approval requests invalidate + + $ gcloud beta access-approval requests invalidate + diff --git a/gcloud/alpha/asset/analyze-org-policies b/gcloud/alpha/asset/analyze-org-policies new file mode 100644 index 000000000..3eea0d7b9 --- /dev/null +++ b/gcloud/alpha/asset/analyze-org-policies @@ -0,0 +1,83 @@ +NAME + gcloud alpha asset analyze-org-policies - analyze organization policies + under a scope + +SYNOPSIS + gcloud alpha asset analyze-org-policies --constraint=CONSTRAINT + --scope=SCOPE [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Analyze organization policies under a scope. + +EXAMPLES + To list 10 org policies of a constraint in an organization, run: + + $ gcloud alpha asset analyze-org-policies \ + --scope=organizations/YOUR_ORG_ID \ + --constraint=YOUR_CONSTRAINT_NAME --limit=10 + +REQUIRED FLAGS + --constraint=CONSTRAINT + The name of the constraint to analyze organization policies for. The + response only contains analyzed organization policies for the provided + constraint. + + Examples: + + ◆ ``organizations/{ORGANIZATION_NUMBER}/customConstraints/{CUSTOM_CONSTRAINT_NAME} + for a user-defined custom constraint. + + --scope=SCOPE + Scope can be a project, a folder, or an organization. The analysis is + limited to the Cloud org policies within this scope. The caller must be + granted the cloudasset.assets.searchAllResources permission on the + desired scope. + + The allowed values are: + + ◆ projects/{PROJECT_ID} (e.g., projects/foo-bar) + ◆ projects/{PROJECT_NUMBER} (e.g., projects/12345678) + ◆ folders/{FOLDER_NUMBER} (e.g., folders/1234567) + ◆ organizations/{ORGANIZATION_NUMBER} (e.g. organizations/123456) + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/asset/analyze-org-policy-governed-containers b/gcloud/alpha/asset/analyze-org-policy-governed-containers new file mode 100644 index 000000000..7d888998d --- /dev/null +++ b/gcloud/alpha/asset/analyze-org-policy-governed-containers @@ -0,0 +1,84 @@ +NAME + gcloud alpha asset analyze-org-policy-governed-containers - analyze + organization policies governed containers under a scope + +SYNOPSIS + gcloud alpha asset analyze-org-policy-governed-containers + --constraint=CONSTRAINT --scope=SCOPE [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Analyze organization policies governed containers under a scope. + +EXAMPLES + To list 10 containers governed by a constraint in an organization, run: + + $ gcloud alpha asset analyze-org-policy-governed-containers \ + --scope=organizations/YOUR_ORG_ID \ + --constraint=YOUR_CONSTRAINT_NAME --limit=10 + +REQUIRED FLAGS + --constraint=CONSTRAINT + The name of the constraint to analyze organization policies for. The + response only contains analyzed organization policies for the provided + constraint. + + Examples: + + ◆ ``organizations/{ORGANIZATION_NUMBER}/customConstraints/{CUSTOM_CONSTRAINT_NAME} + for a user-defined custom constraint. + + --scope=SCOPE + Scope can be a project, a folder, or an organization. The analysis is + limited to the Cloud org policies and containers within this scope. The + caller must be granted the cloudasset.assets.searchAllResources + permission on the desired scope. + + The allowed values are: + + ◆ projects/{PROJECT_ID} (e.g., projects/foo-bar) + ◆ projects/{PROJECT_NUMBER} (e.g., projects/12345678) + ◆ folders/{FOLDER_NUMBER} (e.g., folders/1234567) + ◆ organizations/{ORGANIZATION_NUMBER} (e.g. organizations/123456) + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/asset/analyze-org-policy-governed-resources b/gcloud/alpha/asset/analyze-org-policy-governed-resources new file mode 100644 index 000000000..a76437bc9 --- /dev/null +++ b/gcloud/alpha/asset/analyze-org-policy-governed-resources @@ -0,0 +1,84 @@ +NAME + gcloud alpha asset analyze-org-policy-governed-resources - analyze + organization policies governed resources under a scope + +SYNOPSIS + gcloud alpha asset analyze-org-policy-governed-resources + --constraint=CONSTRAINT --scope=SCOPE [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Analyze organization policies governed resources under a scope. + +EXAMPLES + To list 10 resources governed by a constraint in an organization, run: + + $ gcloud alpha asset analyze-org-policy-governed-resources \ + --scope=organizations/YOUR_ORG_ID \ + --constraint=YOUR_CONSTRAINT_NAME --limit=10 + +REQUIRED FLAGS + --constraint=CONSTRAINT + The name of the constraint to analyze organization policies for. The + response only contains analyzed organization policies for the provided + constraint. + + Examples: + + ◆ ``organizations/{ORGANIZATION_NUMBER}/customConstraints/{CUSTOM_CONSTRAINT_NAME} + for a user-defined custom constraint. + + --scope=SCOPE + Scope can be a project, a folder, or an organization. The analysis is + limited to the Cloud org policies and resources within this scope. The + caller must be granted the cloudasset.assets.searchAllResources + permission on the desired scope. + + The allowed values are: + + ◆ projects/{PROJECT_ID} (e.g., projects/foo-bar) + ◆ projects/{PROJECT_NUMBER} (e.g., projects/12345678) + ◆ folders/{FOLDER_NUMBER} (e.g., folders/1234567) + ◆ organizations/{ORGANIZATION_NUMBER} (e.g. organizations/123456) + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/asset/help b/gcloud/alpha/asset/help index c550e6884..e3be580fa 100644 --- a/gcloud/alpha/asset/help +++ b/gcloud/alpha/asset/help @@ -24,6 +24,16 @@ GROUPS COMMANDS COMMAND is one of the following: + analyze-org-policies + (ALPHA) Analyze organization policies under a scope. + + analyze-org-policy-governed-containers + (ALPHA) Analyze organization policies governed containers under a + scope. + + analyze-org-policy-governed-resources + (ALPHA) Analyze organization policies governed resources under a scope. + export (ALPHA) Export the cloud assets to Google Cloud Storage/BigQuery. diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index a3963a47b..b10f261ae 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -12,9 +12,10 @@ SYNOPSIS | [--reservation=RESERVATION : --reservation-zone=RESERVATION_ZONE --accelerator=[count=COUNT],[type=TYPE] --local-ssd=[interface=INTERFACE],[size=SIZE] - --machine-type=MACHINE_TYPE --min-cpu-platform=MIN_CPU_PLATFORM - --require-specific-reservation --vm-count=VM_COUNT - --share-setting=SHARE_SETTING + --machine-type=MACHINE_TYPE + --maintenance-interval=MAINTENANCE_INTERVAL + --min-cpu-platform=MIN_CPU_PLATFORM --require-specific-reservation + --vm-count=VM_COUNT --share-setting=SHARE_SETTING --share-with=SHARE_WITH,[SHARE_WITH,...]]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -168,6 +169,18 @@ OPTIONAL FLAGS custom-number_of_CPUs-amount_of_memory pattern, e.g. custom-32-29440. + --maintenance-interval=MAINTENANCE_INTERVAL + Specifies how infrastructure upgrades should be applied to the + VM. MAINTENANCE_INTERVAL must be (currently only one value is + supported): + + PERIODIC + VMs receive infrastructure and hypervisor updates on a + periodic basis, minimizing the number of maintenance + operations (live migrations or terminations) on an individual + VM. Security updates will still be applied as soon as they + are available. + --min-cpu-platform=MIN_CPU_PLATFORM Optional minimum CPU platform of the reservation to create. diff --git a/gcloud/alpha/compute/tpus/queued-resources/create b/gcloud/alpha/compute/tpus/queued-resources/create index e008f1fe0..c75f874a1 100644 --- a/gcloud/alpha/compute/tpus/queued-resources/create +++ b/gcloud/alpha/compute/tpus/queued-resources/create @@ -6,7 +6,11 @@ SYNOPSIS gcloud alpha compute tpus queued-resources create (QUEUED_RESOURCE : --zone=ZONE) --accelerator-type=ACCELERATOR_TYPE --node-id=[NODE_ID,...] --runtime-version=RUNTIME_VERSION [--async] - [GCLOUD_WIDE_FLAG ...] + [--best-effort] [--guaranteed] [--reserved] + [--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 (ALPHA) Create a new Queued Resource with the specified attributes. @@ -77,6 +81,33 @@ OPTIONAL FLAGS Return immediately, without waiting for the operation in progress to complete. + --best-effort + If provided, the Node requested here may be scheduled at the 'best + effort' tier. + + --guaranteed + If provided, the Node requested here will only be scheduled at the + 'guaranteed' tier. + + --reserved + Specifies the request should be scheduled on reserved capacity. + + If this flag is set the guaranteed flag is also set. + + --valid-after-duration=VALID_AFTER_DURATION + A duration before which the TPU must not be provisioned, relative to + the current time. + + --valid-after-time=VALID_AFTER_TIME + An absolute time before which the TPU must not be provisioned. + + --valid-until-duration=VALID_UNTIL_DURATION + A duration after which the TPU must not be provisioned, relative to the + current time. + + --valid-until-time=VALID_UNTIL_TIME + An absolute time after which resources must not be created. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/alpha/container/backup-restore/backup-plans/create b/gcloud/alpha/container/backup-restore/backup-plans/create index ebc3f25ad..cc05d95c3 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/create +++ b/gcloud/alpha/container/backup-restore/backup-plans/create @@ -168,5 +168,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans create diff --git a/gcloud/alpha/container/backup-restore/backup-plans/delete b/gcloud/alpha/container/backup-restore/backup-plans/delete index c58f03494..b795dd9c9 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/delete +++ b/gcloud/alpha/container/backup-restore/backup-plans/delete @@ -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 beta container backup-restore backup-plans delete diff --git a/gcloud/alpha/container/backup-restore/backup-plans/describe b/gcloud/alpha/container/backup-restore/backup-plans/describe index c26f9f355..c131ab142 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/describe +++ b/gcloud/alpha/container/backup-restore/backup-plans/describe @@ -64,5 +64,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans describe diff --git a/gcloud/alpha/container/backup-restore/backup-plans/get-iam-policy b/gcloud/alpha/container/backup-restore/backup-plans/get-iam-policy index 3fbf62f4a..21dcc91db 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/get-iam-policy +++ b/gcloud/alpha/container/backup-restore/backup-plans/get-iam-policy @@ -93,5 +93,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans get-iam-policy diff --git a/gcloud/alpha/container/backup-restore/backup-plans/help b/gcloud/alpha/container/backup-restore/backup-plans/help index fdf19af3d..d5993a73b 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/help +++ b/gcloud/alpha/container/backup-restore/backup-plans/help @@ -42,5 +42,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans diff --git a/gcloud/alpha/container/backup-restore/backup-plans/list b/gcloud/alpha/container/backup-restore/backup-plans/list index 39716416e..48f0f001e 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/list +++ b/gcloud/alpha/container/backup-restore/backup-plans/list @@ -89,5 +89,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans list diff --git a/gcloud/alpha/container/backup-restore/backup-plans/set-iam-policy b/gcloud/alpha/container/backup-restore/backup-plans/set-iam-policy index 33aba96d6..2d9fcbbd6 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/set-iam-policy +++ b/gcloud/alpha/container/backup-restore/backup-plans/set-iam-policy @@ -73,5 +73,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans set-iam-policy diff --git a/gcloud/alpha/container/backup-restore/backup-plans/update b/gcloud/alpha/container/backup-restore/backup-plans/update index ef6700fad..33eecd457 100644 --- a/gcloud/alpha/container/backup-restore/backup-plans/update +++ b/gcloud/alpha/container/backup-restore/backup-plans/update @@ -185,5 +185,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backup-plans update diff --git a/gcloud/alpha/container/backup-restore/backups/create b/gcloud/alpha/container/backup-restore/backups/create index 1df39e2b1..d0ff69c80 100644 --- a/gcloud/alpha/container/backup-restore/backups/create +++ b/gcloud/alpha/container/backup-restore/backups/create @@ -133,5 +133,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backups create diff --git a/gcloud/alpha/container/backup-restore/backups/delete b/gcloud/alpha/container/backup-restore/backups/delete index e6216e882..626200f51 100644 --- a/gcloud/alpha/container/backup-restore/backups/delete +++ b/gcloud/alpha/container/backup-restore/backups/delete @@ -83,5 +83,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backups delete diff --git a/gcloud/alpha/container/backup-restore/backups/describe b/gcloud/alpha/container/backup-restore/backups/describe index 2453a1e26..1a57daaf5 100644 --- a/gcloud/alpha/container/backup-restore/backups/describe +++ b/gcloud/alpha/container/backup-restore/backups/describe @@ -73,5 +73,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backups describe diff --git a/gcloud/alpha/container/backup-restore/backups/get-iam-policy b/gcloud/alpha/container/backup-restore/backups/get-iam-policy index fc5d44681..5a4375d07 100644 --- a/gcloud/alpha/container/backup-restore/backups/get-iam-policy +++ b/gcloud/alpha/container/backup-restore/backups/get-iam-policy @@ -101,5 +101,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backups get-iam-policy diff --git a/gcloud/alpha/container/backup-restore/backups/help b/gcloud/alpha/container/backup-restore/backups/help index 6c038a08c..c9a5d18e0 100644 --- a/gcloud/alpha/container/backup-restore/backups/help +++ b/gcloud/alpha/container/backup-restore/backups/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 beta container backup-restore backups diff --git a/gcloud/alpha/container/backup-restore/backups/list b/gcloud/alpha/container/backup-restore/backups/list index 7365df96f..15e564b6f 100644 --- a/gcloud/alpha/container/backup-restore/backups/list +++ b/gcloud/alpha/container/backup-restore/backups/list @@ -101,5 +101,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backups list diff --git a/gcloud/alpha/container/backup-restore/backups/set-iam-policy b/gcloud/alpha/container/backup-restore/backups/set-iam-policy index bf3e94ea3..a210bebfb 100644 --- a/gcloud/alpha/container/backup-restore/backups/set-iam-policy +++ b/gcloud/alpha/container/backup-restore/backups/set-iam-policy @@ -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 beta container backup-restore backups set-iam-policy diff --git a/gcloud/alpha/container/backup-restore/backups/update b/gcloud/alpha/container/backup-restore/backups/update index d5e69254a..d80c47503 100644 --- a/gcloud/alpha/container/backup-restore/backups/update +++ b/gcloud/alpha/container/backup-restore/backups/update @@ -143,5 +143,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore backups update diff --git a/gcloud/alpha/container/backup-restore/help b/gcloud/alpha/container/backup-restore/help index 2266871a2..c9f3757c4 100644 --- a/gcloud/alpha/container/backup-restore/help +++ b/gcloud/alpha/container/backup-restore/help @@ -40,5 +40,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore diff --git a/gcloud/alpha/container/backup-restore/locations/describe b/gcloud/alpha/container/backup-restore/locations/describe index 59ce503f0..040eb8040 100644 --- a/gcloud/alpha/container/backup-restore/locations/describe +++ b/gcloud/alpha/container/backup-restore/locations/describe @@ -48,5 +48,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore locations describe diff --git a/gcloud/alpha/container/backup-restore/locations/help b/gcloud/alpha/container/backup-restore/locations/help index 61ddaff2e..ef724fd84 100644 --- a/gcloud/alpha/container/backup-restore/locations/help +++ b/gcloud/alpha/container/backup-restore/locations/help @@ -26,5 +26,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore locations diff --git a/gcloud/alpha/container/backup-restore/locations/list b/gcloud/alpha/container/backup-restore/locations/list index 09f4d11e0..dca3d35d1 100644 --- a/gcloud/alpha/container/backup-restore/locations/list +++ b/gcloud/alpha/container/backup-restore/locations/list @@ -64,5 +64,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore locations list diff --git a/gcloud/alpha/container/backup-restore/restore-plans/create b/gcloud/alpha/container/backup-restore/restore-plans/create index 909600eca..b94fe579a 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/create +++ b/gcloud/alpha/container/backup-restore/restore-plans/create @@ -156,5 +156,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans create diff --git a/gcloud/alpha/container/backup-restore/restore-plans/delete b/gcloud/alpha/container/backup-restore/restore-plans/delete index 77cd21f0b..3b4279b2f 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/delete +++ b/gcloud/alpha/container/backup-restore/restore-plans/delete @@ -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 beta container backup-restore restore-plans delete diff --git a/gcloud/alpha/container/backup-restore/restore-plans/describe b/gcloud/alpha/container/backup-restore/restore-plans/describe index 69465d1b1..527a47f57 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/describe +++ b/gcloud/alpha/container/backup-restore/restore-plans/describe @@ -64,5 +64,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans describe diff --git a/gcloud/alpha/container/backup-restore/restore-plans/get-iam-policy b/gcloud/alpha/container/backup-restore/restore-plans/get-iam-policy index 65b0056a1..c2daf2e3a 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/get-iam-policy +++ b/gcloud/alpha/container/backup-restore/restore-plans/get-iam-policy @@ -93,5 +93,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans get-iam-policy diff --git a/gcloud/alpha/container/backup-restore/restore-plans/help b/gcloud/alpha/container/backup-restore/restore-plans/help index 9a5b745bf..94f7a8008 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/help +++ b/gcloud/alpha/container/backup-restore/restore-plans/help @@ -42,5 +42,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans diff --git a/gcloud/alpha/container/backup-restore/restore-plans/list b/gcloud/alpha/container/backup-restore/restore-plans/list index bed0dd00f..952983cc7 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/list +++ b/gcloud/alpha/container/backup-restore/restore-plans/list @@ -90,5 +90,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans list diff --git a/gcloud/alpha/container/backup-restore/restore-plans/set-iam-policy b/gcloud/alpha/container/backup-restore/restore-plans/set-iam-policy index 648171366..88a443516 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/set-iam-policy +++ b/gcloud/alpha/container/backup-restore/restore-plans/set-iam-policy @@ -73,5 +73,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans set-iam-policy diff --git a/gcloud/alpha/container/backup-restore/restore-plans/update b/gcloud/alpha/container/backup-restore/restore-plans/update index 98c8050ea..e956b83d3 100644 --- a/gcloud/alpha/container/backup-restore/restore-plans/update +++ b/gcloud/alpha/container/backup-restore/restore-plans/update @@ -161,5 +161,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restore-plans update diff --git a/gcloud/alpha/container/backup-restore/restores/create b/gcloud/alpha/container/backup-restore/restores/create index 81fce1c50..385c2c364 100644 --- a/gcloud/alpha/container/backup-restore/restores/create +++ b/gcloud/alpha/container/backup-restore/restores/create @@ -98,5 +98,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restores create diff --git a/gcloud/alpha/container/backup-restore/restores/delete b/gcloud/alpha/container/backup-restore/restores/delete index 2db07d3dc..eacecfd18 100644 --- a/gcloud/alpha/container/backup-restore/restores/delete +++ b/gcloud/alpha/container/backup-restore/restores/delete @@ -83,5 +83,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restores delete diff --git a/gcloud/alpha/container/backup-restore/restores/describe b/gcloud/alpha/container/backup-restore/restores/describe index a8901d89c..90c6d052f 100644 --- a/gcloud/alpha/container/backup-restore/restores/describe +++ b/gcloud/alpha/container/backup-restore/restores/describe @@ -14,7 +14,9 @@ EXAMPLES To describe a restore 'my-restore' in project 'my-project' in location 'us-central1' under restore plan my-restore-plan, run: - s$ gcloud alpha container backup-restore restores describe my-restore --project=my-project --location=us-central1 --restore-plan=my-restore-plan + $ gcloud alpha container backup-restore restores describe \ + my-restore --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan POSITIONAL ARGUMENTS Restore resource - Name of the restore to describe. The name may be @@ -72,5 +74,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restores describe diff --git a/gcloud/alpha/container/backup-restore/restores/get-iam-policy b/gcloud/alpha/container/backup-restore/restores/get-iam-policy index fc8dda88f..88afabed5 100644 --- a/gcloud/alpha/container/backup-restore/restores/get-iam-policy +++ b/gcloud/alpha/container/backup-restore/restores/get-iam-policy @@ -101,5 +101,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restores get-iam-policy diff --git a/gcloud/alpha/container/backup-restore/restores/help b/gcloud/alpha/container/backup-restore/restores/help index 742e35f1c..b8ac020f7 100644 --- a/gcloud/alpha/container/backup-restore/restores/help +++ b/gcloud/alpha/container/backup-restore/restores/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 beta container backup-restore restores diff --git a/gcloud/alpha/container/backup-restore/restores/list b/gcloud/alpha/container/backup-restore/restores/list index 65b30866d..a19660e48 100644 --- a/gcloud/alpha/container/backup-restore/restores/list +++ b/gcloud/alpha/container/backup-restore/restores/list @@ -99,5 +99,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restores list diff --git a/gcloud/alpha/container/backup-restore/restores/set-iam-policy b/gcloud/alpha/container/backup-restore/restores/set-iam-policy index 3bdf72fe2..17b176f44 100644 --- a/gcloud/alpha/container/backup-restore/restores/set-iam-policy +++ b/gcloud/alpha/container/backup-restore/restores/set-iam-policy @@ -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 beta container backup-restore restores set-iam-policy diff --git a/gcloud/alpha/container/backup-restore/restores/update b/gcloud/alpha/container/backup-restore/restores/update index ff5b432ee..4513f86e2 100644 --- a/gcloud/alpha/container/backup-restore/restores/update +++ b/gcloud/alpha/container/backup-restore/restores/update @@ -118,5 +118,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore restores update diff --git a/gcloud/alpha/container/backup-restore/volume-backups/describe b/gcloud/alpha/container/backup-restore/volume-backups/describe index 9a740c62a..2c47ddb0d 100644 --- a/gcloud/alpha/container/backup-restore/volume-backups/describe +++ b/gcloud/alpha/container/backup-restore/volume-backups/describe @@ -83,5 +83,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore volume-backups describe diff --git a/gcloud/alpha/container/backup-restore/volume-backups/help b/gcloud/alpha/container/backup-restore/volume-backups/help index 65f6c9cc4..57751a0c7 100644 --- a/gcloud/alpha/container/backup-restore/volume-backups/help +++ b/gcloud/alpha/container/backup-restore/volume-backups/help @@ -27,5 +27,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore volume-backups diff --git a/gcloud/alpha/container/backup-restore/volume-backups/list b/gcloud/alpha/container/backup-restore/volume-backups/list index 50894687e..22ccc7a69 100644 --- a/gcloud/alpha/container/backup-restore/volume-backups/list +++ b/gcloud/alpha/container/backup-restore/volume-backups/list @@ -115,5 +115,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore volume-backups list diff --git a/gcloud/alpha/container/backup-restore/volume-restores/describe b/gcloud/alpha/container/backup-restore/volume-restores/describe index 9314ca866..729bf9b32 100644 --- a/gcloud/alpha/container/backup-restore/volume-restores/describe +++ b/gcloud/alpha/container/backup-restore/volume-restores/describe @@ -83,5 +83,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore volume-restores describe diff --git a/gcloud/alpha/container/backup-restore/volume-restores/help b/gcloud/alpha/container/backup-restore/volume-restores/help index 5ff0de929..4cc1fe37b 100644 --- a/gcloud/alpha/container/backup-restore/volume-restores/help +++ b/gcloud/alpha/container/backup-restore/volume-restores/help @@ -27,5 +27,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore volume-restores diff --git a/gcloud/alpha/container/backup-restore/volume-restores/list b/gcloud/alpha/container/backup-restore/volume-restores/list index 8365594d9..7c4310c30 100644 --- a/gcloud/alpha/container/backup-restore/volume-restores/list +++ b/gcloud/alpha/container/backup-restore/volume-restores/list @@ -109,5 +109,7 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. + access allowlist. This variant is also available: + + $ gcloud beta container backup-restore volume-restores list diff --git a/gcloud/alpha/database-migration/migration-jobs/create b/gcloud/alpha/database-migration/migration-jobs/create index a910c3494..71e55c5ef 100644 --- a/gcloud/alpha/database-migration/migration-jobs/create +++ b/gcloud/alpha/database-migration/migration-jobs/create @@ -12,14 +12,35 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Create a Database Migration Service migration job. + (ALPHA) Create a Database Migration Service migration job. Recommended + steps before creating the migration job: + ▪ Create a source connection profile. See prerequisites here + (https://cloud.google.com/database-migration/docs/mysql/configure-source-database). + ▪ Create a destination connection profile. + ▪ Configure the connectivity method. See prerequisites here + (https://cloud.google.com/database-migration/docs/mysql/configure-connectivity). EXAMPLES - To create a migration job with vpc peering connectivity: + To create a continuous migration job with IP allowlist connectivity: $ gcloud alpha database-migration migration-jobs create \ - MIGRATION_JOB --region=us-central1 --display-name=my-job \ - --source=cp1 --destination=cp2 --peer-vpc=network1 + my-migration-job --region=us-central1 --type=CONTINUOUS \ + --source=cp1 --destination=cp2 + + To create a continuous migration job with VPC peering connectivity: + + $ gcloud alpha database-migration migration-jobs create \ + my-migration-job --region=us-central1 --type=CONTINUOUS \ + --source=cp1 --destination=cp2 \ + --peer-vpc=projects/my-project/global/networks/my-network + + To create a one-time migration job with reverse-SSH tunnel connectivity: + + $ gcloud alpha database-migration migration-jobs create \ + my-migration-job --region=us-central1 --type=ONE_TIME \ + --source=cp1 --destination=cp2 --vm=vm1 --vm-ip=1.1.1.1 \ + --vm-port=1111 \ + --vpc=projects/my-project/global/networks/my-network POSITIONAL ARGUMENTS Migration job resource - The migration job to create. The arguments in @@ -48,10 +69,10 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line. REQUIRED FLAGS - Connection profile resource - Resource ID of the destination connection - profile. 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: + Connection profile resource - ID of the destination connection profile, + representing thedestination database. This represents a Cloud resource. + (NOTE) Some attributes are not given arguments in this group but can be + set in other ways. To set the project attribute: ◆ provide the argument --destination on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -67,10 +88,10 @@ REQUIRED FLAGS connection_profile. To set the connection_profile attribute: ▸ provide the argument --destination on the command line. - Connection profile resource - Resource ID of the source connection - profile. 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: + Connection profile resource - ID of the source connection profile, + representing the source database. This represents a Cloud resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: ◆ provide the argument --source on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -87,15 +108,16 @@ REQUIRED FLAGS ▸ provide the argument --source on the command line. --type=TYPE - Type of the migration job (ONE_TIME or CONTINUOUS). TYPE must be one - of: ONE_TIME, CONTINUOUS. + Type of the migration job. TYPE must be one of: ONE_TIME, CONTINUOUS. OPTIONAL FLAGS --no-async Waits for the operation in progress to complete before returning. --display-name=DISPLAY_NAME - Friendly name for the migration job. + A user-friendly name for the migration job. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. --dump-path=DUMP_PATH Path to the dump file in Google Cloud Storage, in the format: diff --git a/gcloud/alpha/database-migration/migration-jobs/generate-ssh-script b/gcloud/alpha/database-migration/migration-jobs/generate-ssh-script index 3f25ee665..f613dede3 100644 --- a/gcloud/alpha/database-migration/migration-jobs/generate-ssh-script +++ b/gcloud/alpha/database-migration/migration-jobs/generate-ssh-script @@ -10,31 +10,43 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Generate a SSH script for a Database Migration Service migration - job. + (ALPHA) Generate a script for a Database Migration Service migration job, + to configure Reverse SSH tunnel connectivity with a bastion host on a + Compute Engine VM instance. You can use an existing VM instance or create a + new VM for this purpose. + + Copy the generated script and run it in bash from a machine that has: + ▪ The gcloud command-line tool installed. + ▪ Access to your source database. + ▪ Access to the existing bastion VM, or permissions and access to the + Cloud Compute API if creating a new bastion VM. Make sure this machine + is available during the entire migration. + + Running the script will set up the SSH tunnel on the VM you selected and + will establish connectivity between the source database and the Cloud SQL + instance. Find additional information here + (https://cloud.google.com/database-migration/docs/mysql/configure-connectivity-reverse-ssh-tunnel). EXAMPLES - To generate a SSH script for a Database Migration Service migration job - with vm creation config, run: + To generate an SSH script with bastion VM instance creation: $ gcloud alpha database-migration migration-jobs \ - generate-ssh-script my-migration-job --vm=sample-vm \ - --vm-port=1111 --vm-machine-type=n1-standard-1 \ - --vm-zone-create=us-central1-a --vpc=sample-vpc \ + generate-ssh-script my-migration-job --vm=vm1 --vm-port=1111 \ + --vm-machine-type=n1-standard-1 --vm-zone-create=us-central1-a \ + --vpc=projects/my-project/global/networks/my-network \ --region=us-central1 - To generate a SSH script for a Database Migration Service migration job - with vm selection config, run: + To generate an SSH script with an existing bastion VM instance: $ gcloud alpha database-migration migration-jobs \ - generate-ssh-script my-migration-job --vm=sample-vm \ - --vm-port=1111 --vm-zone=us-central1-a --region=us-central1 + generate-ssh-script my-migration-job --vm=vm1 --vm-port=1111 \ + --vm-zone=us-central1-a --region=us-central1 POSITIONAL ARGUMENTS - Migration job resource - The migration job you want to generate SSH script - 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: + Migration job resource - The migration job to generate the SSH script 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 migration_job on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -58,27 +70,28 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --vm=VM - Bastion VM Instance name to use or to create (if machineType is given). + Bastion Compute Engine VM instance name to use or to create. Exactly one of these must be specified: --vm-zone=VM_ZONE - Google Cloud Platform zone the VM is located in. + Zone the existing bastion VM instance is located in. --vm-machine-type=VM_MACHINE_TYPE - VM instance machine type to create. + Machine type for a new VM instance. To get a list of available + machine types, run 'gcloud compute machine-types list'. This flag must be specified if any of the other arguments in this group are specified. --vpc=VPC - VPC name the VM needs to be created in. + VPC to create the VM instance in. This flag must be specified if any of the other arguments in this group are specified. --vm-zone-create=VM_ZONE_CREATE - Google Cloud Platform zone to create the VM in. + Zone to create the VM instance in. OPTIONAL FLAGS --vm-port=VM_PORT diff --git a/gcloud/alpha/database-migration/migration-jobs/update b/gcloud/alpha/database-migration/migration-jobs/update index b087a6508..6b19ff7de 100644 --- a/gcloud/alpha/database-migration/migration-jobs/update +++ b/gcloud/alpha/database-migration/migration-jobs/update @@ -14,14 +14,22 @@ SYNOPSIS DESCRIPTION (ALPHA) Update a Database Migration Service migration job. + ▪ Draft migration job: user can update all available flags. + ▪ Any other state can only update flags: --display-name, --dump-path, + and connectivity method flags. EXAMPLES - To update a migration job in draft with new display name, source and - destination connection profiles: + To update the source and destination connection profiles of a draft + migration job: $ gcloud alpha database-migration migration-jobs update \ - MIGRATION_JOB --region=us-central1 --display-name=new-name \ - --source=new-src --destination=new-dest + my-migration-job --region=us-central1 --source=new-src \ + --destination=new-dest + + To update the display name of a running migration job: + + $ gcloud alpha database-migration migration-jobs update \ + my-migration-job --region=us-central1 --display-name=new-name POSITIONAL ARGUMENTS Migration job resource - The migration job to update. The arguments in @@ -50,10 +58,10 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line. FLAGS - Connection profile resource - Resource ID of the destination connection - profile. 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: + Connection profile resource - ID of the destination connection profile, + representing thedestination database. This represents a Cloud resource. + (NOTE) Some attributes are not given arguments in this group but can be + set in other ways. To set the project attribute: ◆ provide the argument --destination on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -67,10 +75,10 @@ FLAGS connection_profile. To set the connection_profile attribute: ▸ provide the argument --destination on the command line. - Connection profile resource - Resource ID of the source connection - profile. 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: + Connection profile resource - ID of the source connection profile, + representing the source database. This represents a Cloud resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: ◆ provide the argument --source on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -88,15 +96,16 @@ FLAGS Waits for the operation in progress to complete before returning. --display-name=DISPLAY_NAME - Friendly name for the migration job. + A user-friendly name for the migration job. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. --dump-path=DUMP_PATH Path to the dump file in Google Cloud Storage, in the format: gs://[BUCKET_NAME]/[OBJECT_NAME]. --type=TYPE - Type of the migration job (ONE_TIME or CONTINUOUS). TYPE must be one - of: ONE_TIME, CONTINUOUS. + Type of the migration job. TYPE must be one of: ONE_TIME, CONTINUOUS. --update-labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to update. If a label exists, its value diff --git a/gcloud/alpha/firebase/test/android/run b/gcloud/alpha/firebase/test/android/run index 28519fa82..d3eb8a2f5 100644 --- a/gcloud/alpha/firebase/test/android/run +++ b/gcloud/alpha/firebase/test/android/run @@ -266,13 +266,13 @@ FLAGS Enable code coverage and provide a directory to store the coverage results when using Android Test Orchestrator (--use-orchestrator): - --environment-variables clearPackageData=true,coverage=true,coverageFilePath=/sdcard/ + --environment-variables clearPackageData=true,coverage=true,coverageFilePath=/sdcard/Download/ Enable code coverage and provide a file path to store the coverage results when not using Android Test Orchestrator (--no-use-orchestrator): - --environment-variables coverage=true,coverageFile=/sdcard/coverage.ec + --environment-variables coverage=true,coverageFile=/sdcard/Download/coverage.ec Note: If you need to embed a comma into a VALUE string, please refer to gcloud topic escaping for ways to change the default list delimiter. diff --git a/gcloud/alpha/firestore/fields/help b/gcloud/alpha/firestore/fields/help new file mode 100644 index 000000000..7fb2ea4e2 --- /dev/null +++ b/gcloud/alpha/firestore/fields/help @@ -0,0 +1,28 @@ +NAME + gcloud alpha firestore fields - manage field metadata for Cloud Firestore + +SYNOPSIS + gcloud alpha firestore fields GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage field metadata for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + ttls + (ALPHA) Manage Time-to-live metadata for Cloud Firestore. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud beta firestore fields + diff --git a/gcloud/alpha/firestore/fields/ttls/help b/gcloud/alpha/firestore/fields/ttls/help new file mode 100644 index 000000000..fec14b674 --- /dev/null +++ b/gcloud/alpha/firestore/fields/ttls/help @@ -0,0 +1,32 @@ +NAME + gcloud alpha firestore fields ttls - manage Time-to-live metadata for Cloud + Firestore + +SYNOPSIS + gcloud alpha firestore fields ttls COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Time-to-live metadata for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + (ALPHA) List all fields used as a Time To Live expiration setting. + + update + (ALPHA) Update the TTL configuration of the given field. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud beta firestore fields ttls + diff --git a/gcloud/alpha/firestore/fields/ttls/list b/gcloud/alpha/firestore/fields/ttls/list new file mode 100644 index 000000000..94733c9bd --- /dev/null +++ b/gcloud/alpha/firestore/fields/ttls/list @@ -0,0 +1,98 @@ +NAME + gcloud alpha firestore fields ttls list - list all fields used as a Time To + Live expiration setting + +SYNOPSIS + gcloud alpha firestore fields ttls list + [--collection-group=COLLECTION_GROUP] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List fields that give an expiration timestamp for documents in a + collection group or kind. + +EXAMPLES + The following command lists all TTL fields for the whole database: + + $ gcloud alpha firestore fields ttls list + +FLAGS + Collection group resource - Collection group of the ttl. + + This can be omitted to include fields across all collection groups + (kinds). This represents a Cloud resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument --collection-group on the command line with a + fully specified name; + ◆ provide the argument [--collection-group] on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. To set the + database attribute: + ◆ provide the argument --collection-group on the command line with a + fully specified name; + ◆ provide the argument [--collection-group] on the command line with a + fully specified name; + ◆ provide the argument [--database] on the command line (currently + '(default)' is the only supported value). + + --collection-group=COLLECTION_GROUP + ID of the collection group or fully qualified identifier for the + collection group. To set the collection-group attribute: + ▸ provide the argument --collection-group on the command line; + ▸ provide the argument [--collection-group] on the command line. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the firestore/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/firestore + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud beta firestore fields ttls list + diff --git a/gcloud/alpha/firestore/fields/ttls/update b/gcloud/alpha/firestore/fields/ttls/update new file mode 100644 index 000000000..5dee5a28a --- /dev/null +++ b/gcloud/alpha/firestore/fields/ttls/update @@ -0,0 +1,96 @@ +NAME + gcloud alpha firestore fields ttls update - update the TTL configuration of + the given field + +SYNOPSIS + gcloud alpha firestore fields ttls update + (FIELD : --collection-group=COLLECTION_GROUP) + (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update the TTL configuration of the given field. + + This enables or disables using a field as the TTL field for its collection + group or kind. Note that only one field can be the TTL field for a + collection group. + +EXAMPLES + The following command sets the expiry field of the Events collection group + (kind) to be the TTL field: + + $ gcloud alpha firestore fields ttls update expiry \ + --collection-group=Events --enable-ttl + + The following command disables the expiry field so it is no longer the TTL + for the Events collection group (kind): + + $ gcloud alpha firestore fields ttls update expiry \ + --collection-group=Events --disable-ttl + +POSITIONAL ARGUMENTS + Field resource - Field 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 field on the command line with a fully specified + name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. To set the + database attribute: + ◆ provide the argument field on the command line with a fully specified + name; + ◆ provide the argument [--database] on the command line (currently + '(default)' is the only supported value). + + This must be specified. + + FIELD + ID of the field or fully qualified identifier for the field. To set + the field attribute: + ▸ provide the argument field on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --collection-group=COLLECTION_GROUP + Collection group of the field. + + To set the collection-group attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --collection-group on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --disable-ttl + Set to make this field no longer the TTL for its collection group. + + --enable-ttl + Set to enable this field as the TTL for its collection group. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the firestore/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/firestore + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud beta firestore fields ttls update + diff --git a/gcloud/alpha/firestore/help b/gcloud/alpha/firestore/help index a8b8bb9b1..0196bb617 100644 --- a/gcloud/alpha/firestore/help +++ b/gcloud/alpha/firestore/help @@ -24,6 +24,9 @@ GROUPS databases (ALPHA) Manage Creation of Cloud Firestore in Native mode Database. + fields + (ALPHA) Manage field metadata for Cloud Firestore. + indexes (ALPHA) Manage indexes for Cloud Firestore. diff --git a/gcloud/alpha/healthcare/datasets/create b/gcloud/alpha/healthcare/datasets/create index fa3b855b6..4c6e98367 100644 --- a/gcloud/alpha/healthcare/datasets/create +++ b/gcloud/alpha/healthcare/datasets/create @@ -4,8 +4,7 @@ NAME SYNOPSIS gcloud alpha healthcare datasets create (DATASET : --location=LOCATION) - [--async] [--storage-class=STORAGE_CLASS] [--time-zone=TIME_ZONE] - [GCLOUD_WIDE_FLAG ...] + [--async] [--time-zone=TIME_ZONE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) Create a new Cloud Healthcare API dataset @@ -52,11 +51,6 @@ FLAGS Return immediately, without waiting for the operation in progress to complete. - --storage-class=STORAGE_CLASS - Default blob storage class to store DICOM instances in this dataset. - STORAGE_CLASS must be one of: archive, blob-storage-class-unspecified, - coldline, nearline, standard. - --time-zone=TIME_ZONE Default timezone used by this dataset. diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index 4ea378c25..1e29ebbee 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -22,7 +22,7 @@ SYNOPSIS --update-config-maps=[KEY=VALUE,...]] [--image=IMAGE | --source=SOURCE] [--[no-]allow-unauthenticated --breakglass=JUSTIFICATION - --clear-vpc-connector --[no-]confidential --[no-]cpu-throttling + --clear-vpc-connector --[no-]cpu-throttling --description=DESCRIPTION --execution-environment=EXECUTION_ENVIRONMENT --revision-suffix=REVISION_SUFFIX --[no-]session-affinity --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS @@ -373,15 +373,14 @@ FLAGS --clear-vpc-connector Remove the VPC connector for this resource. - --[no-]confidential - Enables confidential Cloud Run. Use --confidential to enable and - --no-confidential to disable. - --[no-]cpu-throttling Whether to throttle the CPU when the container is not actively serving requests. Use --cpu-throttling to enable and --no-cpu-throttling to disable. + --description=DESCRIPTION + Provides an optional, human-readable description of the service. + --execution-environment=EXECUTION_ENVIRONMENT Selects the execution environment where the application will run. EXECUTION_ENVIRONMENT must be one of: diff --git a/gcloud/alpha/run/services/update b/gcloud/alpha/run/services/update index f17b62c2f..be56612d3 100644 --- a/gcloud/alpha/run/services/update +++ b/gcloud/alpha/run/services/update @@ -11,8 +11,8 @@ SYNOPSIS [--platform=PLATFORM; default="managed"] [--port=PORT] [--service-account=SERVICE_ACCOUNT] [--tag=TAG] [--timeout=TIMEOUT] [--no-traffic] [--[no-]use-http2] - [--breakglass=JUSTIFICATION --clear-vpc-connector --[no-]confidential - --[no-]cpu-throttling --execution-environment=EXECUTION_ENVIRONMENT + [--breakglass=JUSTIFICATION --clear-vpc-connector --[no-]cpu-throttling + --execution-environment=EXECUTION_ENVIRONMENT --revision-suffix=REVISION_SUFFIX --[no-]session-affinity --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS --add-cloudsql-instances=[CLOUDSQL-INSTANCES,...] @@ -209,10 +209,6 @@ FLAGS --clear-vpc-connector Remove the VPC connector for this resource. - --[no-]confidential - Enables confidential Cloud Run. Use --confidential to enable and - --no-confidential to disable. - --[no-]cpu-throttling Whether to throttle the CPU when the container is not actively serving requests. Use --cpu-throttling to enable and diff --git a/gcloud/alpha/transfer/jobs/create b/gcloud/alpha/transfer/jobs/create index 1b753981b..aacbeacdb 100644 --- a/gcloud/alpha/transfer/jobs/create +++ b/gcloud/alpha/transfer/jobs/create @@ -67,20 +67,15 @@ POSITIONAL ARGUMENTS SOURCE The source of your data. Available sources and formatting information: - Public clouds - For Google Cloud Storage and Amazon S3, specify the - scheme of the source type; name of the resource; and, if transferring - from a folder, the path to the folder. For Azure Storage, note the - Azure-specific formatting below. For example: - ◆ [Google Cloud Storage] gs://example-bucket/example-folder + Public clouds - + ◆ [Google Cloud Storage] gs://example-bucket/example-folder/ ◆ [Amazon S3] s3://examplebucket/example-folder ◆ [Azure Blob Storage or Data Lake Storage] http://examplestorageaccount.blob.core.windows.net/examplecontainer/examplefolder - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the posix:// - scheme followed by the absolute path to the desired directory, starting - from the root of the host machine (denoted by a leading slash). For - example: + POSIX filesystem - Specify the posix:// scheme followed by the absolute + path to the desired directory, starting from the root of the host + machine (denoted by a leading slash). For example: ◆ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and @@ -96,13 +91,11 @@ POSITIONAL ARGUMENTS Google Cloud Storage - Specify the gs:// scheme; name of the bucket; and, if transferring to a folder, the path to the folder. For example: - ◆ gs://example-bucket/example-folder + ◆ gs://example-bucket/example-folder/ - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the posix:// - scheme followed by the absolute path to the desired directory, starting - from the root of the host machine (denoted by a leading slash). For - example: + POSIX filesystem - Specify the posix:// scheme followed by the absolute + path to the desired directory, starting from the root of the host + machine (denoted by a leading slash). For example: ◆ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and diff --git a/gcloud/alpha/transfer/jobs/update b/gcloud/alpha/transfer/jobs/update index 139f746e5..49797c59d 100644 --- a/gcloud/alpha/transfer/jobs/update +++ b/gcloud/alpha/transfer/jobs/update @@ -71,20 +71,15 @@ FLAGS The source of your data. Available sources and formatting information: - Public clouds - For Google Cloud Storage and Amazon S3, specify the - scheme of the source type; name of the resource; and, if transferring - from a folder, the path to the folder. For Azure Storage, note the - Azure-specific formatting below. For example: - ▸ [Google Cloud Storage] gs://example-bucket/example-folder + Public clouds - + ▸ [Google Cloud Storage] gs://example-bucket/example-folder/ ▸ [Amazon S3] s3://examplebucket/example-folder ▸ [Azure Blob Storage or Data Lake Storage] http://examplestorageaccount.blob.core.windows.net/examplecontainer/examplefolder - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the - posix:// scheme followed by the absolute path to the desired - directory, starting from the root of the host machine (denoted by a - leading slash). For example: + POSIX filesystem - Specify the posix:// scheme followed by the + absolute path to the desired directory, starting from the root of the + host machine (denoted by a leading slash). For example: ▸ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and @@ -103,13 +98,11 @@ FLAGS Google Cloud Storage - Specify the gs:// scheme; name of the bucket; and, if transferring to a folder, the path to the folder. For example: - ▸ gs://example-bucket/example-folder + ▸ gs://example-bucket/example-folder/ - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the - posix:// scheme followed by the absolute path to the desired - directory, starting from the root of the host machine (denoted by a - leading slash). For example: + POSIX filesystem - Specify the posix:// scheme followed by the + absolute path to the desired directory, starting from the root of the + host machine (denoted by a leading slash). For example: ▸ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and diff --git a/gcloud/artifacts/repositories/create b/gcloud/artifacts/repositories/create index 142173511..82903fa72 100644 --- a/gcloud/artifacts/repositories/create +++ b/gcloud/artifacts/repositories/create @@ -70,6 +70,8 @@ REQUIRED FLAGS APT package format. docker Docker image format. + kfp + KFP package format. maven Maven package format. npm diff --git a/gcloud/asset/search-all-resources b/gcloud/asset/search-all-resources index eb8557879..7683a8c4a 100644 --- a/gcloud/asset/search-all-resources +++ b/gcloud/asset/search-all-resources @@ -95,6 +95,14 @@ FLAGS ◆ labels.env:* to find Cloud resources that have a label env. ◆ kmsKey:key to find Cloud resources encrypted with a customer-managed encryption key whose name contains key as a word. + ◆ relationships:instance-group-1 to find Cloud resources that have + relationships with instance-group-1 in the related resource name. + ◆ relationships:INSTANCE_TO_INSTANCEGROUP to find Compute instances + that have relationships of type INSTANCE_TO_INSTANCEGROUP. + ◆ relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find + Compute instances that have relationships with instance-group-1 in + the Compute instance group resource name, for relationship type + INSTANCE_TO_INSTANCEGROUP. ◆ state:ACTIVE to find Cloud resources whose state contains ACTIVE as a word. ◆ NOT state:ACTIVE to find Cloud resources whose state doesn't diff --git a/gcloud/beta/access-approval/requests/approve b/gcloud/beta/access-approval/requests/approve index d15d8eb33..9b42105a5 100644 --- a/gcloud/beta/access-approval/requests/approve +++ b/gcloud/beta/access-approval/requests/approve @@ -18,7 +18,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/access-approval/requests/dismiss b/gcloud/beta/access-approval/requests/dismiss index 4cdc16d9a..367d57c8e 100644 --- a/gcloud/beta/access-approval/requests/dismiss +++ b/gcloud/beta/access-approval/requests/dismiss @@ -19,7 +19,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/access-approval/requests/get b/gcloud/beta/access-approval/requests/get index a7514f42d..cd2ab593b 100644 --- a/gcloud/beta/access-approval/requests/get +++ b/gcloud/beta/access-approval/requests/get @@ -17,7 +17,7 @@ EXAMPLES POSITIONAL ARGUMENTS NAME - approval request name + Name of the Access Approval request to invalidate GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, diff --git a/gcloud/beta/access-approval/requests/help b/gcloud/beta/access-approval/requests/help index bfc1171db..0caf4f4d7 100644 --- a/gcloud/beta/access-approval/requests/help +++ b/gcloud/beta/access-approval/requests/help @@ -27,6 +27,9 @@ COMMANDS get (BETA) Get an Access Approval request. + invalidate + (BETA) Invalidate an Access Approval request. + list (BETA) List Access Approval requests. diff --git a/gcloud/beta/access-approval/requests/invalidate b/gcloud/beta/access-approval/requests/invalidate new file mode 100644 index 000000000..4dc1408e5 --- /dev/null +++ b/gcloud/beta/access-approval/requests/invalidate @@ -0,0 +1,38 @@ +NAME + gcloud beta access-approval requests invalidate - invalidate an Access + Approval request + +SYNOPSIS + gcloud beta access-approval requests invalidate NAME [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Invalidate an Access Approval request. This will raise an error if + the request does not exist or is not in an approved state. + +EXAMPLES + To invalidate an approval request using its name (e.g. + projects/12345/approvalRequests/abc123), run: + + $ gcloud beta access-approval requests invalidate \ + projects/12345/approvalRequests/abc123 + +POSITIONAL ARGUMENTS + NAME + Name of the Access Approval request to invalidate + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 access-approval requests invalidate + + $ gcloud alpha access-approval requests invalidate + diff --git a/gcloud/beta/asset/search-all-resources b/gcloud/beta/asset/search-all-resources index 3b306d09b..135f1b489 100644 --- a/gcloud/beta/asset/search-all-resources +++ b/gcloud/beta/asset/search-all-resources @@ -96,6 +96,14 @@ FLAGS ◆ labels.env:* to find Cloud resources that have a label env. ◆ kmsKey:key to find Cloud resources encrypted with a customer-managed encryption key whose name contains key as a word. + ◆ relationships:instance-group-1 to find Cloud resources that have + relationships with instance-group-1 in the related resource name. + ◆ relationships:INSTANCE_TO_INSTANCEGROUP to find Compute instances + that have relationships of type INSTANCE_TO_INSTANCEGROUP. + ◆ relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find + Compute instances that have relationships with instance-group-1 in + the Compute instance group resource name, for relationship type + INSTANCE_TO_INSTANCEGROUP. ◆ state:ACTIVE to find Cloud resources whose state contains ACTIVE as a word. ◆ NOT state:ACTIVE to find Cloud resources whose state doesn't diff --git a/gcloud/beta/compute/instance-templates/create b/gcloud/beta/compute/instance-templates/create index 2a16b8da3..86eded4ae 100644 --- a/gcloud/beta/compute/instance-templates/create +++ b/gcloud/beta/compute/instance-templates/create @@ -38,6 +38,7 @@ SYNOPSIS [--source-instance-zone=SOURCE_INSTANCE_ZONE] [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] [--threads-per-core=THREADS_PER_CORE] + [--visible-core-count=VISIBLE_CORE_COUNT] [--address=ADDRESS | --no-address] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY : --boot-disk-kms-keyring=BOOT_DISK_KMS_KEYRING @@ -739,6 +740,12 @@ FLAGS For more information about configuring SMT, see: https://cloud.google.com/compute/docs/instances/configuring-simultaneous-multithreading. + --visible-core-count=VISIBLE_CORE_COUNT + The number of physical cores to expose to the instance's guest + operating system. The number of virtual CPUs visible to the instance's + guest operating system is this number of cores multiplied by the + instance's count of visible threads per physical core. + At most one of these can be specified: --address=ADDRESS diff --git a/gcloud/beta/compute/instances/bulk/create b/gcloud/beta/compute/instances/bulk/create index 945b9837f..a9526b149 100644 --- a/gcloud/beta/compute/instances/bulk/create +++ b/gcloud/beta/compute/instances/bulk/create @@ -38,6 +38,7 @@ SYNOPSIS [--subnet=SUBNET] [--tags=TAG,[TAG,...]] [--target-distribution-shape=SHAPE] [--threads-per-core=THREADS_PER_CORE] + [--visible-core-count=VISIBLE_CORE_COUNT] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY : --boot-disk-kms-keyring=BOOT_DISK_KMS_KEYRING --boot-disk-kms-location=BOOT_DISK_KMS_LOCATION @@ -677,6 +678,12 @@ OPTIONAL FLAGS For more information about configuring SMT, see: https://cloud.google.com/compute/docs/instances/configuring-simultaneous-multithreading. + --visible-core-count=VISIBLE_CORE_COUNT + The number of physical cores to expose to the instance's guest + operating system. The number of virtual CPUs visible to the instance's + guest operating system is this number of cores multiplied by the + instance's count of visible threads per physical core. + Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the disk. The arguments in this group can be used to specify the attributes of this resource. diff --git a/gcloud/beta/compute/instances/create b/gcloud/beta/compute/instances/create index 0a2191563..a9a0abc2a 100644 --- a/gcloud/beta/compute/instances/create +++ b/gcloud/beta/compute/instances/create @@ -42,7 +42,8 @@ SYNOPSIS [--source-machine-image=SOURCE_MACHINE_IMAGE] [--source-machine-image-csek-key-file=FILE] [--stack-type=STACK_TYPE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] - [--threads-per-core=THREADS_PER_CORE] [--zone=ZONE] + [--threads-per-core=THREADS_PER_CORE] + [--visible-core-count=VISIBLE_CORE_COUNT] [--zone=ZONE] [--address=ADDRESS | --no-address] [--boot-disk-kms-key=BOOT_DISK_KMS_KEY : --boot-disk-kms-keyring=BOOT_DISK_KMS_KEYRING @@ -792,6 +793,12 @@ FLAGS For more information about configuring SMT, see: https://cloud.google.com/compute/docs/instances/configuring-simultaneous-multithreading. + --visible-core-count=VISIBLE_CORE_COUNT + The number of physical cores to expose to the instance's guest + operating system. The number of virtual CPUs visible to the instance's + guest operating system is this number of cores multiplied by the + instance's count of visible threads per physical core. + --zone=ZONE Zone of the instances to create. If not specified and the compute/zone property isn't set, you might be prompted to select a zone (interactive diff --git a/gcloud/beta/compute/instances/create-with-container b/gcloud/beta/compute/instances/create-with-container index 9a46b4d15..cbaf609c4 100644 --- a/gcloud/beta/compute/instances/create-with-container +++ b/gcloud/beta/compute/instances/create-with-container @@ -43,7 +43,8 @@ SYNOPSIS [--shielded-integrity-monitoring] [--shielded-secure-boot] [--shielded-vtpm] [--source-instance-template=SOURCE_INSTANCE_TEMPLATE] [--subnet=SUBNET] [--tags=TAG,[TAG,...]] - [--threads-per-core=THREADS_PER_CORE] [--zone=ZONE] + [--threads-per-core=THREADS_PER_CORE] + [--visible-core-count=VISIBLE_CORE_COUNT] [--zone=ZONE] [--address=ADDRESS | --no-address] [--custom-cpu=CUSTOM_CPU --custom-memory=CUSTOM_MEMORY : --custom-extensions --custom-vm-type=CUSTOM_VM_TYPE] @@ -689,6 +690,12 @@ FLAGS For more information about configuring SMT, see: https://cloud.google.com/compute/docs/instances/configuring-simultaneous-multithreading. + --visible-core-count=VISIBLE_CORE_COUNT + The number of physical cores to expose to the instance's guest + operating system. The number of virtual CPUs visible to the instance's + guest operating system is this number of cores multiplied by the + instance's count of visible threads per physical core. + --zone=ZONE Zone of the instances to create. If not specified, you might be prompted to select a zone (interactive mode only). gcloud attempts to diff --git a/gcloud/beta/container/backup-restore/backup-plans/create b/gcloud/beta/container/backup-restore/backup-plans/create new file mode 100644 index 000000000..0fd79167b --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/create @@ -0,0 +1,172 @@ +NAME + gcloud beta container backup-restore backup-plans create - create a backup + plan + +SYNOPSIS + gcloud beta container backup-restore backup-plans create + (BACKUP_PLAN : --location=LOCATION) --cluster=CLUSTER + (--all-namespaces | --selected-applications=SELECTED_APPLICATIONS + | --selected-namespaces=[SELECTED_NAMESPACES,...]) [--async] + [--deactivated] [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS + --backup-retain-days=BACKUP_RETAIN_DAYS --locked] + [--cron-schedule=CRON_SCHEDULE : --paused] + [--encryption-key=ENCRYPTION_KEY + --include-secrets --include-volume-data] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Backup for GKE backup plan. + +EXAMPLES + To create a backup plan my-backup-plan in project my-project in location + us-central1, run: + + $ gcloud beta container backup-restore backup-plans create \ + my-backup-plan --project=my-project --location=us-central1 \ + --cluster=project/my-project/location/us-central1/clusters/\ + my-cluster --all-namespaces + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan to create. Once the plan is + created, this name can't be changed. This must be 63 or fewer characters + long and must be unique within the project and location. The name may be + provided either as a relative name, e.g. + projects//locations//backupPlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. BACKUP_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument backup_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +REQUIRED FLAGS + --cluster=CLUSTER + Name of the cluster from which backups will be produced. Value must be + entered as a relative name, e.g.: + + projects//locations//clusters/ for a + regional cluster or projects//zones//clusters/ + for a zonal cluster. + + Exactly one of these must be specified: + + --all-namespaces + Scope of the backup includes resources from all namespaces. Mutually + exclusive with --selected-namespaces and --selected-applications. + + --selected-applications=SELECTED_APPLICATIONS + List of ProtectedApplication instances whose resources are included + in the backup. Mutually exclusive with --all-namespaces and + --selected-namespaces. e.g: + --selected-applications=namespace1/foo,namespace2/bar + + --selected-namespaces=[SELECTED_NAMESPACES,...] + List of namespaces whose resources are included in the backup. + Mutually exclusive with --all-namespaces and --selected-applications. + e.g: --selected-namespaces=foo,bar + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deactivated + If set, no further changes may be made to this backup plan and no + further backups may be created for this plan. Backup deletion is still + allowed. + + --description=DESCRIPTION + Optional text description for the backup plan. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS + Number of days a backup produced via this plan cannot be deleted. + + Must be less than or equal to 90 days. If 0, delete operations are + allowed. + + --backup-retain-days=BACKUP_RETAIN_DAYS + Number of days after which a backup produced via this plan is + automatically deleted. + + If not set (value is 0), backups are not automatically deleted. If set, + must be greater than the value for backup_delete_lock_days. + + --locked + If set, subsequent updates are not allowed to the backup plan's + retention policy and this value cannot be changed. + + --cron-schedule=CRON_SCHEDULE + Schedule on which backups will be automatically created. + + Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. + For example, "10 3 * * " will automatically create a backup at 0310 + every day. All times are interpreted as UTC. The minimum interval + between scheduled backups is 10 minutes. + + --paused + If set, automatic backup creation is suppressed. When unset, automatic + backup creation resumes with the next scheduled create event. + + --encryption-key=ENCRYPTION_KEY + Encryption key used for encrypting the backup. + + At this time, only the Cloud Key Management Service (Cloud KMS) is + supported. Value must be entered as a relative name, e.g.: + projects//locations//keyRings//cryptoKeys/. + + --include-secrets + If true, secret resources are included in the backup if they fall + within the scope. If unset, the default is false. + + --include-volume-data + If true, snapshots are created for PD volumes corresponding to + PersistentVolumeClaims that fall within the scope. If unset, the + default is false. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans create + diff --git a/gcloud/beta/container/backup-restore/backup-plans/delete b/gcloud/beta/container/backup-restore/backup-plans/delete new file mode 100644 index 000000000..945875b38 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/delete @@ -0,0 +1,79 @@ +NAME + gcloud beta container backup-restore backup-plans delete - delete a backup + plan + +SYNOPSIS + gcloud beta container backup-restore backup-plans delete + (BACKUP_PLAN : --location=LOCATION) [--async] [--etag=ETAG] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Backup for GKE backup plan. + +EXAMPLES + To delete a backup plan my-backup-plan in project my-project in location + us-central1, run: + + $ gcloud beta container backup-restore backup-plans delete \ + my-backup-plan --project=my-project --location=us-central1 + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan to delete. The name may be + provided either as a relative name, e.g. + projects//locations//backupPlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. BACKUP_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument backup_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans delete + diff --git a/gcloud/beta/container/backup-restore/backup-plans/describe b/gcloud/beta/container/backup-restore/backup-plans/describe new file mode 100644 index 000000000..e78158dc7 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/describe @@ -0,0 +1,68 @@ +NAME + gcloud beta container backup-restore backup-plans describe - describe a + backup plan + +SYNOPSIS + gcloud beta container backup-restore backup-plans describe + (BACKUP_PLAN : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE backup plan. + +EXAMPLES + To describe a backup plan my-backup-plan in project my-project in location + us-central1, run: + + $ gcloud beta container backup-restore backup-plans describe \ + my-backup-plan --project=my-project --location=us-central1 + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan to describe. The name may + be provided either as a relative name, e.g. + projects//locations//backupPlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. BACKUP_PLAN --project= --location= + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument backup_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans describe + diff --git a/gcloud/beta/container/backup-restore/backup-plans/get-iam-policy b/gcloud/beta/container/backup-restore/backup-plans/get-iam-policy new file mode 100644 index 000000000..e2d75616a --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/get-iam-policy @@ -0,0 +1,96 @@ +NAME + gcloud beta container backup-restore backup-plans get-iam-policy - get the + IAM policy for a backup plan + +SYNOPSIS + gcloud beta container backup-restore backup-plans get-iam-policy + (BACKUP_PLAN : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Display the IAM policy associated with a backup plan. + +EXAMPLES + To display the IAM policy associated with a backup plan my-backup-plan in + project my-project in location us-central1, run: + + $ gcloud beta container backup-restore backup-plans get-iam-policy \ + my-backup-plan --project=my-project --location=us-central1 + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan for which to display IAM + policy. The name may be provided either as a relative name, e.g. + projects//locations//backupPlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. BACKUP_PLAN --project= --location= + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument backup_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans get-iam-policy + diff --git a/gcloud/beta/container/backup-restore/backup-plans/help b/gcloud/beta/container/backup-restore/backup-plans/help new file mode 100644 index 000000000..859602100 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/help @@ -0,0 +1,46 @@ +NAME + gcloud beta container backup-restore backup-plans - backup for GKE Backup + Plans + +SYNOPSIS + gcloud beta container backup-restore backup-plans COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Backup Plans. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a backup plan. + + delete + (BETA) Delete a backup plan. + + describe + (BETA) Describe a backup plan. + + get-iam-policy + (BETA) Get the IAM policy for a backup plan. + + list + (BETA) List backup plans. + + set-iam-policy + (BETA) Set the IAM policy for a backup plan. + + update + (BETA) Update a backup plan. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans + diff --git a/gcloud/beta/container/backup-restore/backup-plans/list b/gcloud/beta/container/backup-restore/backup-plans/list new file mode 100644 index 000000000..3d8fd2fef --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/list @@ -0,0 +1,93 @@ +NAME + gcloud beta container backup-restore backup-plans list - list backup plans + +SYNOPSIS + gcloud beta container backup-restore backup-plans list + [--location=LOCATION] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE backup plans. + +EXAMPLES + To list all backup plans in project my-project in location us-central1, + run: + + $ gcloud beta container backup-restore backup-plans list \ + --project=my-project --location=us-central1 + + To list all backup plans in project my-project across all locations, run: + + $ gcloud beta container backup-restore backup-plans list \ + --project=my-project + +FLAGS + Location resource - Name of the location from which to list backup plans + (provided via options or through properties): --project= + --location=. This represents a Cloud resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument --location on the command line with a fully + specified name; + ◆ set the property gkebackup/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans list + diff --git a/gcloud/beta/container/backup-restore/backup-plans/set-iam-policy b/gcloud/beta/container/backup-restore/backup-plans/set-iam-policy new file mode 100644 index 000000000..e8e58ba52 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/set-iam-policy @@ -0,0 +1,77 @@ +NAME + gcloud beta container backup-restore backup-plans set-iam-policy - set the + IAM policy for a backup plan + +SYNOPSIS + gcloud beta container backup-restore backup-plans set-iam-policy + (BACKUP_PLAN : --location=LOCATION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set the IAM policy for a backup plan. + +EXAMPLES + To set the IAM policy for a backup plan my-backup-plan in project + my-project in location us-central1 with the policy defined in the JSON file + policy.json, run: + + $ gcloud beta container backup-restore backup-plans set-iam-policy \ + my-backup-plan policy.json --project=my-project \ + --location=us-central1 + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan for which to set IAM + policy. The name may be provided either as a relative name, e.g. + projects//locations//backupPlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. BACKUP_PLAN --project= --location= + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument backup_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans set-iam-policy + diff --git a/gcloud/beta/container/backup-restore/backup-plans/update b/gcloud/beta/container/backup-restore/backup-plans/update new file mode 100644 index 000000000..d4a97a38b --- /dev/null +++ b/gcloud/beta/container/backup-restore/backup-plans/update @@ -0,0 +1,189 @@ +NAME + gcloud beta container backup-restore backup-plans update - update a backup + plan + +SYNOPSIS + gcloud beta container backup-restore backup-plans update + (BACKUP_PLAN : --location=LOCATION) [--async] [--deactivated] + [--description=DESCRIPTION] [--etag=ETAG] + [--update-labels=[KEY=VALUE,...]] + [--all-namespaces | --selected-applications=SELECTED_APPLICATIONS + | --selected-namespaces=[SELECTED_NAMESPACES,...]] + [--backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS + --backup-retain-days=BACKUP_RETAIN_DAYS --locked] + [--clear-labels | --remove-labels=[KEY,...]] + [--cron-schedule=CRON_SCHEDULE --paused] + [--encryption-key=ENCRYPTION_KEY + --include-secrets --include-volume-data] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Backup for GKE backup plan. + +EXAMPLES + To update a backup plan my-backup-plan in project my-project in location + us-central1 to add new description, run: + + $ gcloud beta container backup-restore backup-plans update \ + my-backup-plan --project=my-project --location=us-central1 \ + --description="New description" + +POSITIONAL ARGUMENTS + Backup plan resource - Name of the backup plan to update. The name may be + provided either as a relative name, e.g. + projects//locations//backupPlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. BACKUP_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument backup_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup_plan attribute: + ▸ provide the argument backup_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup_plan on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --deactivated + If set, no further changes may be made to this backup plan and no + further backups may be created for this plan. Backup deletion is still + allowed. + + --description=DESCRIPTION + Optional text description for the backup plan. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + + --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: + + --all-namespaces + Scope of the backup includes resources from all namespaces. Mutually + exclusive with --selected-namespaces and --selected-applications. + + --selected-applications=SELECTED_APPLICATIONS + List of ProtectedApplication instances whose resources are included + in the backup. Mutually exclusive with --all-namespaces and + --selected-namespaces. e.g: + --selected-applications=namespace1/foo,namespace2/bar + + --selected-namespaces=[SELECTED_NAMESPACES,...] + List of namespaces whose resources are included in the backup. + Mutually exclusive with --all-namespaces and --selected-applications. + e.g: --selected-namespaces=foo,bar + + --backup-delete-lock-days=BACKUP_DELETE_LOCK_DAYS + Number of days a backup produced via this plan cannot be deleted. + + Must be less than or equal to 90 days. If 0, delete operations are + allowed. + + --backup-retain-days=BACKUP_RETAIN_DAYS + Number of days after which a backup produced via this plan is + automatically deleted. + + If not set (value is 0), backups are not automatically deleted. If set, + must be greater than the value for backup_delete_lock_days. + + --locked + If set, subsequent updates are not allowed to the backup plan's + retention policy and this value cannot be changed. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud beta container backup-restore backup-plans update \ + --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud beta container backup-restore backup-plans update \ + --clear-labels --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + + --cron-schedule=CRON_SCHEDULE + Schedule on which backups will be automatically created. + + Use standard cron (http://en.wikipedia.org/wiki/Cron#Overview) syntax. + For example, "10 3 * * " will automatically create a backup at 0310 + every day. All times are interpreted as UTC. The minimum interval + between scheduled backups is 10 minutes. + + --paused + If set, automatic backup creation is suppressed. When unset, automatic + backup creation resumes with the next scheduled create event. + + --encryption-key=ENCRYPTION_KEY + Encryption key used for encrypting the backup. + + At this time, only the Cloud Key Management Service (Cloud KMS) is + supported. Value must be entered as a relative name, e.g.: + projects//locations//keyRings//cryptoKeys/. + + --include-secrets + If true, secret resources are included in the backup if they fall + within the scope. If unset, the default is false. + + --include-volume-data + If true, snapshots are created for PD volumes corresponding to + PersistentVolumeClaims that fall within the scope. If unset, the + default is false. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backup-plans update + diff --git a/gcloud/beta/container/backup-restore/backups/create b/gcloud/beta/container/backup-restore/backups/create new file mode 100644 index 000000000..ada117cca --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/create @@ -0,0 +1,137 @@ +NAME + gcloud beta container backup-restore backups create - creates a backup + +SYNOPSIS + gcloud beta container backup-restore backups create + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) + [--delete-lock-days=DELETE_LOCK_DAYS] [--description=DESCRIPTION] + [--labels=[KEY=VALUE,...]] [--retain-days=RETAIN_DAYS] + [--async | --wait-for-completion] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Creates a Backup for GKE backup. + +EXAMPLES + To create a backup my-backup in project my-project in location us-central1 + under backup plan my-backup-plan, run: + + $ gcloud beta container backup-restore backups create my-backup \ + --project=my-project --location=us-central1 \ + --backup-plan=my-backup-plan + + To create a backup my-backup in project my-project in location us-central1 + under backup plan my-backup-plan and not wait for the resulting operation + to finish, run: + + $ gcloud beta container backup-restore backups create my-backup \ + --project=my-project --location=us-central1 \ + --backup-plan=my-backup-plan --async + + To create a backup my-backup in project my-project in location us-central1 + under backup plan my-backup-plan and wait for the Backup to complete, run: + + $ gcloud beta container backup-restore backups create my-backup \ + --project=my-project --location=us-central1 \ + --backup-plan=my-backup-plan --wait-for-completion + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup to create. Once the backup is + created, this name can't be changed. This must be 63 or fewer characters + long and must be unique within the project, location, and backup plan. The + name may be provided either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup_plan=. The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument backup 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. + + BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the name attribute: + ▸ provide the argument backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --delete-lock-days=DELETE_LOCK_DAYS + Delete lock days specifies the number of days from the createTime of + this Backup before which deletion will be blocked. Must be >= the value + in the backup plan. If not specified, inherited from the backup plan. + Manual creation of a backup with this field unspecified causes the + service to use the value of + backupPlan.RetentionPolicy.backupDeleteBlockDays. Creation of a backup + with this field set to a value SMALLER than + backupPlan.RetentionPolicy.backupDeleteBlockDays results in an invalid + response from the service. This field MUST be an int value between + 0-90(inclusive). This field may only be INCREASED in an update command, + or an invalid response will be returned by the service. + + --description=DESCRIPTION + Optional text description for the backup being created. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --retain-days=RETAIN_DAYS + Retain days specifies the desired number of days from the createTime of + this backup after which it will be automatically deleted. If not + specified or set to 0, it means the backup will NOT be automatically + deleted. Manual creation of a backup with this field unspecified causes + the service to use the value of + backupPlan.retentionPolicy.backupRetainDays. Creation of a Backup with + this field set to a value SMALLER than delete_lock_days results in an + invalid response from the service. This field may ONLY be increased in + an Update request, or an invalid response will be returned by the + service immediately. Default to 0 if not provided. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --wait-for-completion + Wait for the created backup to complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups create + diff --git a/gcloud/beta/container/backup-restore/backups/delete b/gcloud/beta/container/backup-restore/backups/delete new file mode 100644 index 000000000..6c9552ccd --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/delete @@ -0,0 +1,87 @@ +NAME + gcloud beta container backup-restore backups delete - delete a backup + +SYNOPSIS + gcloud beta container backup-restore backups delete + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) [--async] + [--etag=ETAG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Backup for GKE backup. + +EXAMPLES + To delete a backup my-backup in project my-project in location us-central1 + under backup plan my-backup-plan, run: + + $ gcloud beta container backup-restore backups delete my-backup \ + --backup-plan=my-backup-plan --project=my-project \ + --location=us-central1 + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup to delete. The name may be provided + either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup-plan=. The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument backup on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the backup attribute: + ▸ provide the argument backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups delete + diff --git a/gcloud/beta/container/backup-restore/backups/describe b/gcloud/beta/container/backup-restore/backups/describe new file mode 100644 index 000000000..17dea3a3a --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/describe @@ -0,0 +1,77 @@ +NAME + gcloud beta container backup-restore backups describe - describe a backup + +SYNOPSIS + gcloud beta container backup-restore backups describe + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE backup. + +EXAMPLES + To describe a backup my-backup in project my-project in location + us-central1 under backup plan my-backup-plan, run: + + $ gcloud beta container backup-restore backups describe my-backup \ + --backup-plan=my-backup-plan --project=my-project \ + --location=us-central1 + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup to describe. The name may be provided + either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup-plan=. The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument backup on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the backup attribute: + ▸ provide the argument backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups describe + diff --git a/gcloud/beta/container/backup-restore/backups/get-iam-policy b/gcloud/beta/container/backup-restore/backups/get-iam-policy new file mode 100644 index 000000000..fcf7f92cf --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/get-iam-policy @@ -0,0 +1,105 @@ +NAME + gcloud beta container backup-restore backups get-iam-policy - get the IAM + policy for a backup + +SYNOPSIS + gcloud beta container backup-restore backups get-iam-policy + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Display the IAM policy associated with a backup. + +EXAMPLES + To display the IAM policy associated with a backup my-backup in backup plan + my-backup-plan in project my-project in location us-central1, run: + + $ gcloud beta container backup-restore backups get-iam-policy \ + my-backup --project=my-project --location=us-central1 \ + --backup-plan=my-backup-plan + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup for which to display IAM policy. The + name may be provided either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup-plan= The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument backup on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the backup attribute: + ▸ provide the argument backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups get-iam-policy + diff --git a/gcloud/beta/container/backup-restore/backups/help b/gcloud/beta/container/backup-restore/backups/help new file mode 100644 index 000000000..bbd1a1683 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/help @@ -0,0 +1,44 @@ +NAME + gcloud beta container backup-restore backups - backup for GKE Backups + +SYNOPSIS + gcloud beta container backup-restore backups COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Backups. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Creates a backup. + + delete + (BETA) Delete a backup. + + describe + (BETA) Describe a backup. + + get-iam-policy + (BETA) Get the IAM policy for a backup. + + list + (BETA) List backups. + + set-iam-policy + (BETA) Set the IAM policy for a backup. + + update + (BETA) Update a backup. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups + diff --git a/gcloud/beta/container/backup-restore/backups/list b/gcloud/beta/container/backup-restore/backups/list new file mode 100644 index 000000000..6960c1343 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/list @@ -0,0 +1,105 @@ +NAME + gcloud beta container backup-restore backups list - list backups + +SYNOPSIS + gcloud beta container backup-restore backups list + [--backup-plan=BACKUP_PLAN --location=LOCATION] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE backups. + +EXAMPLES + To list all backups in project my-project in location us-central1 under + backup plan my-backup-plan, run: + + $ gcloud beta container backup-restore backups list \ + --backup-plan=my-backup-plan --project=my-project \ + --location=us-central1 + + To list all backups in project my-project across all locations under all + backup plans, run: + + $ gcloud beta container backup-restore backups list \ + --project=my-project + +FLAGS + Backup plan resource - Name of the backup plan from which to list backups + (provided via options or through properties), e.g. --project= + --location= --backup-plan=. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument --backup-plan on the command line with a fully + specified name; + ◆ set the property gkebackup/backup_plan with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --backup-plan=BACKUP_PLAN + ID of the backup plan or fully qualified identifier for the backup + plan. To set the backup-plan attribute: + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument --backup-plan on the command line with a + fully specified name; + ▸ set the property gkebackup/backup_plan with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups list + diff --git a/gcloud/beta/container/backup-restore/backups/set-iam-policy b/gcloud/beta/container/backup-restore/backups/set-iam-policy new file mode 100644 index 000000000..e6c04b176 --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/set-iam-policy @@ -0,0 +1,86 @@ +NAME + gcloud beta container backup-restore backups set-iam-policy - set the IAM + policy for a backup + +SYNOPSIS + gcloud beta container backup-restore backups set-iam-policy + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set the IAM policy associated with a backup. + +EXAMPLES + To set the IAM policy associated with a backup my-backup in backup plan + my-backup-plan in project my-project in location us-central1 with the + policy defined in the JSON file policy.json, run: + + $ gcloud beta container backup-restore backups set-iam-policy \ + my-backup policy.json --project=my-project \ + --location=us-central1 --backup-plan=my-backup-plan + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup for which to set IAM policy. The name + may be provided either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup-plan= The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument backup on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the backup attribute: + ▸ provide the argument backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups set-iam-policy + diff --git a/gcloud/beta/container/backup-restore/backups/update b/gcloud/beta/container/backup-restore/backups/update new file mode 100644 index 000000000..8a44ad4ea --- /dev/null +++ b/gcloud/beta/container/backup-restore/backups/update @@ -0,0 +1,147 @@ +NAME + gcloud beta container backup-restore backups update - update a backup + +SYNOPSIS + gcloud beta container backup-restore backups update + (BACKUP : --backup-plan=BACKUP_PLAN --location=LOCATION) [--async] + [--delete-lock-days=DELETE_LOCK_DAYS] [--description=DESCRIPTION] + [--etag=ETAG] [--retain-days=RETAIN_DAYS] + [--update-labels=[KEY=VALUE,...]] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Backup for GKE backup. + +EXAMPLES + To update a backup my-backup in project my-project in location us-central1 + under backup plan my-backup-plan to add new description, run: + + $ gcloud beta container backup-restore backups update 'my-backup' \ + --backup-plan=my-backup-plan --project=my-project \ + --location=us-central1 --description="New description" + +POSITIONAL ARGUMENTS + Backup resource - Name of the backup to update. The name may be provided + either as a relative name, e.g. + projects//locations//backupPlans//backups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. BACKUP --project= --location= + --backup-plan=. The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument backup on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the backup attribute: + ▸ provide the argument backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument backup on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --delete-lock-days=DELETE_LOCK_DAYS + Delete lock days specifies the number of days from the createTime of + this Backup before which deletion will be blocked. Must be >= the value + in the backup plan. If not specified, inherited from the backup plan. + Manual creation of a backup with this field unspecified causes the + service to use the value of + backupPlan.RetentionPolicy.backupDeleteBlockDays. Creation of a backup + with this field set to a value SMALLER than + backupPlan.RetentionPolicy.backupDeleteBlockDays results in an invalid + response from the service. This field MUST be an int value between + 0-90(inclusive). This field may only be INCREASED in an update command, + or an invalid response will be returned by the service. + + --description=DESCRIPTION + Optional text description for the backup. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + + --retain-days=RETAIN_DAYS + Retain days specifies the desired number of days from the createTime of + this backup after which it will be automatically deleted. If not + specified or set to 0, it means the backup will NOT be automatically + deleted. Manual creation of a backup with this field unspecified causes + the service to use the value of + backupPlan.retentionPolicy.backupRetainDays. Creation of a backup with + this field set to a value SMALLER than deleteLockDays results in an + invalid response from the service. This field may ONLY be increased in + an Update command, or an invalid response will be returned by the + service immediately. Default to 0. + + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud beta container backup-restore backups update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud beta container backup-restore backups update \ + --clear-labels --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore backups update + diff --git a/gcloud/beta/container/backup-restore/help b/gcloud/beta/container/backup-restore/help new file mode 100644 index 000000000..802fd755a --- /dev/null +++ b/gcloud/beta/container/backup-restore/help @@ -0,0 +1,44 @@ +NAME + gcloud beta container backup-restore - backup for GKE Services + +SYNOPSIS + gcloud beta container backup-restore GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Services. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + backup-plans + (BETA) Backup for GKE Backup Plans. + + backups + (BETA) Backup for GKE Backups. + + locations + (BETA) Backup for GKE Locations. + + restore-plans + (BETA) Backup for GKE Restore Plans. + + restores + (BETA) Backup for GKE Restores. + + volume-backups + (BETA) Backup for GKE Volume Backups. + + volume-restores + (BETA) Backup for GKE Volume Restores. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore + diff --git a/gcloud/beta/container/backup-restore/locations/describe b/gcloud/beta/container/backup-restore/locations/describe new file mode 100644 index 000000000..1f719c918 --- /dev/null +++ b/gcloud/beta/container/backup-restore/locations/describe @@ -0,0 +1,52 @@ +NAME + gcloud beta container backup-restore locations describe - describe a + location + +SYNOPSIS + gcloud beta container backup-restore locations describe LOCATION + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE location. + +EXAMPLES + To describe a location 'us-central1' in project 'my-project', run: + + $ gcloud beta container backup-restore locations describe \ + us-central1 --project=my-project + +POSITIONAL ARGUMENTS + Location resource - Location to describe. This represents a Cloud + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument location on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument location on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore locations describe + diff --git a/gcloud/beta/container/backup-restore/locations/help b/gcloud/beta/container/backup-restore/locations/help new file mode 100644 index 000000000..7837db7b9 --- /dev/null +++ b/gcloud/beta/container/backup-restore/locations/help @@ -0,0 +1,30 @@ +NAME + gcloud beta container backup-restore locations - backup for GKE Locations + +SYNOPSIS + gcloud beta container backup-restore locations COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Locations. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describe a location. + + list + (BETA) List locations. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore locations + diff --git a/gcloud/beta/container/backup-restore/locations/list b/gcloud/beta/container/backup-restore/locations/list new file mode 100644 index 000000000..cd5f48abd --- /dev/null +++ b/gcloud/beta/container/backup-restore/locations/list @@ -0,0 +1,68 @@ +NAME + gcloud beta container backup-restore locations list - list locations + +SYNOPSIS + gcloud beta container backup-restore locations list [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE locations. + +EXAMPLES + To list all locations in project 'my-project', run: + + $ gcloud beta container backup-restore locations list \ + --project=my-project + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore locations list + diff --git a/gcloud/beta/container/backup-restore/restore-plans/create b/gcloud/beta/container/backup-restore/restore-plans/create new file mode 100644 index 000000000..0d4d78f23 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/create @@ -0,0 +1,160 @@ +NAME + gcloud beta container backup-restore restore-plans create - create a + restore plan + +SYNOPSIS + gcloud beta container backup-restore restore-plans create + (RESTORE_PLAN : --location=LOCATION) --backup-plan=BACKUP_PLAN + --cluster=CLUSTER + --namespaced-resource-restore-mode=NAMESPACED_RESOURCE_RESTORE_MODE + (--all-namespaces | --selected-applications=SELECTED_APPLICATIONS + | --selected-namespaces=[SELECTED_NAMESPACES,...]) [--async] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--substitution-rules-file=SUBSTITUTION_RULES_FILE] + [--volume-data-restore-policy=VOLUME_DATA_RESTORE_POLICY] + [--cluster-resource-conflict-policy=CLUSTER_RESOURCE_CONFLICT_POLICY + --cluster-resource-restore-scope=[CLUSTER_RESOURCE_RESTORE_SCOPE, + ...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Backup for GKE restore plan. + +EXAMPLES + To create a restore plan my-restore-plan in project my-project in location + us-central1, run: + + $ gcloud beta container backup-restore restore-plans create \ + my-restore-plan --project=my-project --location=us-central1 \ + --cluster=projects/my-project/locations/us-central1/clusters/\ + my-cluster \ + --backup-plan=projects/my-project/locations/us-central1/\ + backupPlans/my-backup-plan --all-namespaces + +POSITIONAL ARGUMENTS + Restore plan resource - Name of the restore plan to create. Once the plan + is created, this name can't be changed. This must be 63 or fewer + characters long and must be unique within the project and location. The + name may be provided either as a relative name, e.g. + projects//locations//restorePlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. RESTORE_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument restore_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore_plan attribute: + ▸ provide the argument restore_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore_plan on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +REQUIRED FLAGS + --backup-plan=BACKUP_PLAN + The BackupPlan from which Backups may be used as the source for + Restores created via this RestorePlan. + + Value must be entered as a relative name, e.g. + projects//locations//backupPlans/. + + --cluster=CLUSTER + The target cluster into which Restores created via this RestorePlan + will restore data. NOTE: the cluster's region must be the same as the + RestorePlan. + + Value must be entered as a relative name, e.g.: + projects//locations//clusters/ for a + regional cluster or projects//zones//clusters/ + for a zonal cluster. + + --namespaced-resource-restore-mode=NAMESPACED_RESOURCE_RESTORE_MODE + Define how to handle restore-time conflicts for namespaced resources. + NAMESPACED_RESOURCE_RESTORE_MODE must be one of: delete-and-restore, + fail-on-conflict, namespaced-resource-restore-mode-unspecified. + + Exactly one of these must be specified: + + --all-namespaces + If true, restore all namespaced resources in the backup. + + --selected-applications=SELECTED_APPLICATIONS + List of selected applications to restore. Only those namespaced + resources which belong to one of the selected applications are + restored. + + --selected-namespaces=[SELECTED_NAMESPACES,...] + List of selected namespaces to restore. Only those namespaced + resources belonging to a selected namespace are restored. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + The description of the restore plan. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --substitution-rules-file=SUBSTITUTION_RULES_FILE + If provided, defines a set of resource transformations that will be + applied to resources from the source backup before they are created in + the target cluster. + + --volume-data-restore-policy=VOLUME_DATA_RESTORE_POLICY + Define how data is populated for restored volumes. + VOLUME_DATA_RESTORE_POLICY must be one of: no-volume-data-restoration, + restore-volume-data-from-backup, reuse-volume-handle-from-backup, + volume-data-restore-policy-unspecified. + + --cluster-resource-conflict-policy=CLUSTER_RESOURCE_CONFLICT_POLICY + Define how to handle restore-time conflicts for cluster-scoped + resources. CLUSTER_RESOURCE_CONFLICT_POLICY must be one of: + cluster-resource-conflict-policy-unspecified, use-backup-version, + use-existing-version. + + --cluster-resource-restore-scope=[CLUSTER_RESOURCE_RESTORE_SCOPE,...] + List of cluster-scoped resource types to be restored. Not specifying + this means NO cluster resource will be restored. The format of a + resource is "/", e.g. storage.k8s.io/StorageClass for + StorageClass. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans create + diff --git a/gcloud/beta/container/backup-restore/restore-plans/delete b/gcloud/beta/container/backup-restore/restore-plans/delete new file mode 100644 index 000000000..b137296f9 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/delete @@ -0,0 +1,79 @@ +NAME + gcloud beta container backup-restore restore-plans delete - delete a + restore plan + +SYNOPSIS + gcloud beta container backup-restore restore-plans delete + (RESTORE_PLAN : --location=LOCATION) [--async] [--etag=ETAG] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Backup for GKE restore plan. + +EXAMPLES + To delete a restore plan my-restore-plan in project my-project in location + us-central1, run: + + $ gcloud beta container backup-restore restore-plans delete \ + my-restore-plan --project=my-project --location=us-central1 + +POSITIONAL ARGUMENTS + Restore plan resource - Name of the restore plan to delete. The name may + be provided either as a relative name, e.g. + projects//locations//restorePlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. RESTORE_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument restore_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore_plan attribute: + ▸ provide the argument restore_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore_plan on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans delete + diff --git a/gcloud/beta/container/backup-restore/restore-plans/describe b/gcloud/beta/container/backup-restore/restore-plans/describe new file mode 100644 index 000000000..89c48f192 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/describe @@ -0,0 +1,68 @@ +NAME + gcloud beta container backup-restore restore-plans describe - describe a + restore plan + +SYNOPSIS + gcloud beta container backup-restore restore-plans describe + (RESTORE_PLAN : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE restore plan. + +EXAMPLES + To describe a restore plan my-restore-plan in project my-project in + location us-central1, run: + + $ gcloud beta container backup-restore restore-plans describe \ + my-restore-plan --project=my-project --location=us-central1 + +POSITIONAL ARGUMENTS + Restore plan resource - Name of the restore plan to describe. The name may + be provided either as a relative name, e.g. + projects//locations//restorePlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. RESTORE_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument restore_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore_plan attribute: + ▸ provide the argument restore_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore_plan on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans describe + diff --git a/gcloud/beta/container/backup-restore/restore-plans/get-iam-policy b/gcloud/beta/container/backup-restore/restore-plans/get-iam-policy new file mode 100644 index 000000000..80368cfb3 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/get-iam-policy @@ -0,0 +1,97 @@ +NAME + gcloud beta container backup-restore restore-plans get-iam-policy - get the + IAM policy for a restore plan + +SYNOPSIS + gcloud beta container backup-restore restore-plans get-iam-policy + (RESTORE_PLAN : --location=LOCATION) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Display the IAM policy associated with a restore plan. + +EXAMPLES + To display the IAM policy associated with a restore plan my-restore-plan in + project my-project in location us-central1, run: + + $ gcloud beta container backup-restore restore-plans \ + get-iam-policy my-restore-plan --project=my-project \ + --location=us-central1 + +POSITIONAL ARGUMENTS + Restore plan resource - Name of the restore plan for which to display IAM + policy. The name may be provided either as a relative name, e.g. + projects//locations//restorePlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. RESTORE_PLAN --project= --location= + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument restore_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore_plan attribute: + ▸ provide the argument restore_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore_plan on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans get-iam-policy + diff --git a/gcloud/beta/container/backup-restore/restore-plans/help b/gcloud/beta/container/backup-restore/restore-plans/help new file mode 100644 index 000000000..324066e47 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/help @@ -0,0 +1,46 @@ +NAME + gcloud beta container backup-restore restore-plans - backup for GKE Restore + Plans + +SYNOPSIS + gcloud beta container backup-restore restore-plans COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Restore Plans. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Create a restore plan. + + delete + (BETA) Delete a restore plan. + + describe + (BETA) Describe a restore plan. + + get-iam-policy + (BETA) Get the IAM policy for a restore plan. + + list + (BETA) List restore plans. + + set-iam-policy + (BETA) Set the IAM policy for a restore plan. + + update + (BETA) Update a restore plan. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans + diff --git a/gcloud/beta/container/backup-restore/restore-plans/list b/gcloud/beta/container/backup-restore/restore-plans/list new file mode 100644 index 000000000..900406561 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/list @@ -0,0 +1,94 @@ +NAME + gcloud beta container backup-restore restore-plans list - list restore + plans + +SYNOPSIS + gcloud beta container backup-restore restore-plans list + [--location=LOCATION] [--filter=EXPRESSION] [--limit=LIMIT] + [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE restore plans. + +EXAMPLES + To list all restore plans in project my-project in location us-central1, + run: + + $ gcloud beta container backup-restore restore-plans list \ + --project=my-project --location=us-central1 + + To list all restore plans in project my-project across all locations, run: + + $ gcloud beta container backup-restore restore-plans list \ + --project=my-project + +FLAGS + Location resource - Name of the location from which to list restore plans + (provided via options or through properties): --project= + --location=. This represents a Cloud resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument --location on the command line with a fully + specified name; + ◆ set the property gkebackup/location with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + ID of the location or fully qualified identifier for the location. To + set the location attribute: + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans list + diff --git a/gcloud/beta/container/backup-restore/restore-plans/set-iam-policy b/gcloud/beta/container/backup-restore/restore-plans/set-iam-policy new file mode 100644 index 000000000..2afd13981 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/set-iam-policy @@ -0,0 +1,77 @@ +NAME + gcloud beta container backup-restore restore-plans set-iam-policy - set the + IAM policy for a restore plan + +SYNOPSIS + gcloud beta container backup-restore restore-plans set-iam-policy + (RESTORE_PLAN : --location=LOCATION) POLICY_FILE [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set the IAM policy associated with a restore plan. + +EXAMPLES + To set the IAM policy associated with a restore plan my-restore-plan in + project my-project in location us-central1 with the policy defined in the + JSON file policy.json, run: + + $ gcloud beta container backup-restore restore-plans \ + set-iam-policy my-restore-plan policy.json \ + --project=my-project --location=us-central1 + +POSITIONAL ARGUMENTS + Restore plan resource - Name of the restore plan for which to display IAM + policy. The name may be provided either as a relative name, e.g. + projects//locations//restorePlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. RESTORE_PLAN --project= --location= + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument restore_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore_plan attribute: + ▸ provide the argument restore_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore_plan on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + POLICY_FILE + Path to a local JSON or YAML formatted file containing a valid policy. + + The output of the get-iam-policy command is a valid file, as is any + JSON or YAML file conforming to the structure of a Policy + (https://cloud.google.com/iam/reference/rest/v1/Policy). + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans set-iam-policy + diff --git a/gcloud/beta/container/backup-restore/restore-plans/update b/gcloud/beta/container/backup-restore/restore-plans/update new file mode 100644 index 000000000..d2d4d5e50 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restore-plans/update @@ -0,0 +1,165 @@ +NAME + gcloud beta container backup-restore restore-plans update - update a + restore plan + +SYNOPSIS + gcloud beta container backup-restore restore-plans update + (RESTORE_PLAN : --location=LOCATION) [--async] + [--description=DESCRIPTION] [--etag=ETAG] + [--namespaced-resource-restore-mode=NAMESPACED_RESOURCE_RESTORE_MODE] + [--substitution-rules-file=SUBSTITUTION_RULES_FILE] + [--update-labels=[KEY=VALUE,...]] + [--volume-data-restore-policy=VOLUME_DATA_RESTORE_POLICY] + [--all-namespaces | --selected-applications=SELECTED_APPLICATIONS + | --selected-namespaces=[SELECTED_NAMESPACES,...]] + [--clear-labels | --remove-labels=[KEY,...]] + [--cluster-resource-conflict-policy=CLUSTER_RESOURCE_CONFLICT_POLICY + --cluster-resource-restore-scope=[CLUSTER_RESOURCE_RESTORE_SCOPE, + ...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Backup for GKE restore plan. + +EXAMPLES + To update a restore plan my-restore-plan in project my-project in location + us-central1 to add new description, run: + + $ gcloud beta container backup-restore restore-plans update \ + my-restore-plan --project=my-project --location=us-central1 \ + --description="New description" + +POSITIONAL ARGUMENTS + Restore plan resource - Name of the restore plan to update. The name may + be provided either as a relative name, e.g. + projects//locations//restorePlans/ or as a + single ID name (with the parent resources provided via options or through + properties), e.g. RESTORE_PLAN --project= --location=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument restore_plan on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore_plan attribute: + ▸ provide the argument restore_plan on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore_plan on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + The description of the restore plan. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + + --namespaced-resource-restore-mode=NAMESPACED_RESOURCE_RESTORE_MODE + Define how to handle restore-time conflicts for namespaced resources. + NAMESPACED_RESOURCE_RESTORE_MODE must be one of: delete-and-restore, + fail-on-conflict, namespaced-resource-restore-mode-unspecified. + + --substitution-rules-file=SUBSTITUTION_RULES_FILE + If provided, defines a set of resource transformations that will be + applied to resources from the source backup before they are created in + the target cluster. + + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + --volume-data-restore-policy=VOLUME_DATA_RESTORE_POLICY + Define how data is populated for restored volumes. + VOLUME_DATA_RESTORE_POLICY must be one of: no-volume-data-restoration, + restore-volume-data-from-backup, reuse-volume-handle-from-backup, + volume-data-restore-policy-unspecified. + + At most one of these can be specified: + + --all-namespaces + If true, restore all namespaced resources in the backup. + + --selected-applications=SELECTED_APPLICATIONS + List of selected applications to restore. Only those namespaced + resources which belong to one of the selected applications are + restored. + + --selected-namespaces=[SELECTED_NAMESPACES,...] + List of selected namespaces to restore. Only those namespaced + resources belonging to a selected namespace are restored. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud beta container backup-restore restore-plans update \ + --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud beta container backup-restore restore-plans update \ + --clear-labels --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + + --cluster-resource-conflict-policy=CLUSTER_RESOURCE_CONFLICT_POLICY + Define how to handle restore-time conflicts for cluster-scoped + resources. CLUSTER_RESOURCE_CONFLICT_POLICY must be one of: + cluster-resource-conflict-policy-unspecified, use-backup-version, + use-existing-version. + + --cluster-resource-restore-scope=[CLUSTER_RESOURCE_RESTORE_SCOPE,...] + List of cluster-scoped resource types to be restored. Not specifying + this means NO cluster resource will be restored. The format of a + resource is "/", e.g. storage.k8s.io/StorageClass for + StorageClass. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restore-plans update + diff --git a/gcloud/beta/container/backup-restore/restores/create b/gcloud/beta/container/backup-restore/restores/create new file mode 100644 index 000000000..fbf22d64c --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/create @@ -0,0 +1,102 @@ +NAME + gcloud beta container backup-restore restores create - creates a restore + +SYNOPSIS + gcloud beta container backup-restore restores create + (RESTORE : --location=LOCATION --restore-plan=RESTORE_PLAN) + --backup=BACKUP [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--async | --wait-for-completion] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Creates a Backup for GKE restore. + +EXAMPLES + To create a restore my-restore in location us-central1 under restore plan + my-restore-plan, run: + + $ gcloud beta container backup-restore restores create my-restore \ + --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan + +POSITIONAL ARGUMENTS + Restore resource - Name of the restore to create. Once the restore is + created, this name can't be changed. This must be 63 or fewer characters + long and must be unique within the project and location. The name may be + provided either as a relative name, e.g. + projects//locations//restorePlans//restores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. --project= + --location= --restore-plan=. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument restore 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. + + RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the name attribute: + ▸ provide the argument restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +REQUIRED FLAGS + --backup=BACKUP + Name of the backup from which to restore under the backup plan + specified in restore plan. Format: + projects//locations//backupPlans//backups/. + +OPTIONAL FLAGS + --description=DESCRIPTION + Optional text description for the restore. + + --labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to add. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + At most one of these can be specified: + + --async + Return immediately, without waiting for the operation in progress to + complete. + + --wait-for-completion + Wait for the created restore to complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores create + diff --git a/gcloud/beta/container/backup-restore/restores/delete b/gcloud/beta/container/backup-restore/restores/delete new file mode 100644 index 000000000..35028fb83 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/delete @@ -0,0 +1,87 @@ +NAME + gcloud beta container backup-restore restores delete - delete a restore + +SYNOPSIS + gcloud beta container backup-restore restores delete + (RESTORE : --location=LOCATION --restore-plan=RESTORE_PLAN) [--async] + [--etag=ETAG] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Delete a Backup for GKE restore. + +EXAMPLES + To delete a restore 'my-restore' in project 'my-project' in location + 'us-central1' under restore plan my-restore-plan, run: + + $ gcloud beta container backup-restore restores delete my-restore \ + --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan + +POSITIONAL ARGUMENTS + Restore resource - Name of the restore to delete. The name may be provided + either as a relative name, e.g. + projects//locations//restorePlans//restores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. RESTORE --project= + --location= --restore-plan=. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument restore on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the restore attribute: + ▸ provide the argument restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores delete + diff --git a/gcloud/beta/container/backup-restore/restores/describe b/gcloud/beta/container/backup-restore/restores/describe new file mode 100644 index 000000000..d9c371d46 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/describe @@ -0,0 +1,77 @@ +NAME + gcloud beta container backup-restore restores describe - describe a restore + +SYNOPSIS + gcloud beta container backup-restore restores describe + (RESTORE : --location=LOCATION --restore-plan=RESTORE_PLAN) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE restore. + +EXAMPLES + To describe a restore 'my-restore' in project 'my-project' in location + 'us-central1' under restore plan my-restore-plan, run: + + $ gcloud beta container backup-restore restores describe \ + my-restore --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan + +POSITIONAL ARGUMENTS + Restore resource - Name of the restore to describe. The name may be + provided either as a relative name, e.g. + projects//locations//restorePlans//restores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. RESTORE --project= + --location= --restore-plan=. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument restore on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the restore attribute: + ▸ provide the argument restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores describe + diff --git a/gcloud/beta/container/backup-restore/restores/get-iam-policy b/gcloud/beta/container/backup-restore/restores/get-iam-policy new file mode 100644 index 000000000..669ffd8ea --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/get-iam-policy @@ -0,0 +1,105 @@ +NAME + gcloud beta container backup-restore restores get-iam-policy - get the IAM + policy for a restore + +SYNOPSIS + gcloud beta container backup-restore restores get-iam-policy + (RESTORE : --location=LOCATION --restore-plan=RESTORE_PLAN) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Display the IAM policy associated with a restore. + +EXAMPLES + To display the IAM policy associated with a restore my-restore in project + my-project in location us-central1 under restore plan my-restore-plan, run: + + $ gcloud beta container backup-restore restores get-iam-policy \ + my-restore --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan + +POSITIONAL ARGUMENTS + Restore resource - Name of the restore for which to display IAM policy. + The name may be provided either as a relative name, e.g. + projects//locations//restorePlans//restores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. RESTORE --project= + --location= --restore-plan= The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument restore on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the restore attribute: + ▸ provide the argument restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores get-iam-policy + diff --git a/gcloud/beta/container/backup-restore/restores/help b/gcloud/beta/container/backup-restore/restores/help new file mode 100644 index 000000000..376a07403 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/help @@ -0,0 +1,45 @@ +NAME + gcloud beta container backup-restore restores - backup for GKE Restores + +SYNOPSIS + gcloud beta container backup-restore restores COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Restores. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (BETA) Creates a restore. + + delete + (BETA) Delete a restore. + + describe + (BETA) Describe a restore. + + get-iam-policy + (BETA) Get the IAM policy for a restore. + + list + (BETA) List restores. + + set-iam-policy + (BETA) Set the IAM policy for a restore. + + update + (BETA) Update a restore. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores + diff --git a/gcloud/beta/container/backup-restore/restores/list b/gcloud/beta/container/backup-restore/restores/list new file mode 100644 index 000000000..b991f9925 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/list @@ -0,0 +1,103 @@ +NAME + gcloud beta container backup-restore restores list - list restores + +SYNOPSIS + gcloud beta container backup-restore restores list + [--location=LOCATION --restore-plan=RESTORE_PLAN] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE restores. + +EXAMPLES + To list all restores in project 'my-project' in location 'us-central1', + run: + + $ gcloud beta container backup-restore restores list \ + --project=my-project --location=us-central1 + + To list all restores in project 'my-project' across all locations, run: + + $ gcloud beta container backup-restore restores list \ + --project=my-project + +FLAGS + Restore plan resource - Name of the location from which to list restores + (provided via options or through properties): --project= + --location= --restore-plan=. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument --restore-plan on the command line with a fully + specified name; + ◆ set the property gkebackup/restore_plan with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument --restore-plan on the command line with a + fully specified name; + ▸ set the property gkebackup/restore_plan with a fully specified + name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + ID of the restore plan or fully qualified identifier for the restore + plan. To set the restore-plan attribute: + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores list + diff --git a/gcloud/beta/container/backup-restore/restores/set-iam-policy b/gcloud/beta/container/backup-restore/restores/set-iam-policy new file mode 100644 index 000000000..4ef22d169 --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/set-iam-policy @@ -0,0 +1,86 @@ +NAME + gcloud beta container backup-restore restores set-iam-policy - set the IAM + policy for a restore + +SYNOPSIS + gcloud beta container backup-restore restores set-iam-policy + (RESTORE : --location=LOCATION --restore-plan=RESTORE_PLAN) POLICY_FILE + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Set the IAM policy associated with a restore. + +EXAMPLES + To set the IAM policy associated with a restore my-restore in project + my-project in location us-central1 under restore plan my-restore-plan with + the policy defined in the JSON file policy.json, run: + + $ gcloud beta container backup-restore restores set-iam-policy \ + my-restore policy.json --project=my-project \ + --location=us-central1 --restore-plan=my-restore-plan + +POSITIONAL ARGUMENTS + Restore resource - Name of the restore for which to display IAM policy. + The name may be provided either as a relative name, e.g. + projects//locations//restorePlans//restores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. RESTORE --project= + --location= --restore-plan= The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument restore on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the restore attribute: + ▸ provide the argument restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + + 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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores set-iam-policy + diff --git a/gcloud/beta/container/backup-restore/restores/update b/gcloud/beta/container/backup-restore/restores/update new file mode 100644 index 000000000..1100df72e --- /dev/null +++ b/gcloud/beta/container/backup-restore/restores/update @@ -0,0 +1,121 @@ +NAME + gcloud beta container backup-restore restores update - update a restore + +SYNOPSIS + gcloud beta container backup-restore restores update + (RESTORE : --location=LOCATION --restore-plan=RESTORE_PLAN) [--async] + [--description=DESCRIPTION] [--etag=ETAG] + [--update-labels=[KEY=VALUE,...]] + [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Backup for GKE restore. + +EXAMPLES + To update a restore my-restore in project my-project in location + us-central1 under restore plan my-restore-plan to add new description, run: + + $ gcloud beta container backup-restore restores update my-restore \ + --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan --description="New description" + +POSITIONAL ARGUMENTS + Restore resource - Name of the restore to update. The name may be provided + either as a relative name, e.g. + projects//locations//restorePlans//restores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. RESTORE --project= + --location= --restore-plan=. The arguments in this + group can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. To set the project attribute: + ◆ provide the argument restore on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the restore attribute: + ▸ provide the argument restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument restore on the command line with a fully + specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --description=DESCRIPTION + Optional text description for the restore. + + --etag=ETAG + The etag is used for optimistic concurrency control as a way to help + prevent simultaneous updates or deletes of a resource from overwriting + each other. + + --update-labels=[KEY=VALUE,...] + List of label KEY=VALUE pairs to update. If a label exists, its value + is modified. Otherwise, a new label is created. + + Keys must start with a lowercase character and contain only hyphens + (-), underscores (_), lowercase characters, and numbers. Values must + contain only hyphens (-), underscores (_), lowercase characters, and + numbers. + + At most one of these can be specified: + + --clear-labels + Remove all labels. If --update-labels is also specified then + --clear-labels is applied first. + + For example, to remove all labels: + + $ gcloud beta container backup-restore restores update --clear-labels + + To remove all existing labels and create two new labels, foo and baz: + + $ gcloud beta container backup-restore restores update \ + --clear-labels --update-labels foo=bar,baz=qux + + --remove-labels=[KEY,...] + List of label keys to remove. If a label does not exist it is + silently ignored. If --update-labels is also specified then + --update-labels is applied first. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore restores update + diff --git a/gcloud/beta/container/backup-restore/volume-backups/describe b/gcloud/beta/container/backup-restore/volume-backups/describe new file mode 100644 index 000000000..e16869ca8 --- /dev/null +++ b/gcloud/beta/container/backup-restore/volume-backups/describe @@ -0,0 +1,87 @@ +NAME + gcloud beta container backup-restore volume-backups describe - describe a + volume backup + +SYNOPSIS + gcloud beta container backup-restore volume-backups describe + (VOLUME_BACKUP + : --backup=BACKUP --backup-plan=BACKUP_PLAN --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE volume backup. + +EXAMPLES + To describe a volume backup my-volume-backup in project my-project in + location us-central1 under backup plan my-backup-plan under backup + my-backup, run: + + $ gcloud beta container backup-restore volume-backups describe \ + my-volume-backup --project=my-project --location=us-central1 \ + --backup-plan=my-backup-plan --backup=my-backup + +POSITIONAL ARGUMENTS + Volume backup resource - Name of the volume backup to describe. The name + may be provided either as a relative name, e.g. + projects//locations//backupPlans//backups//volumeBackups/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. VOLUME_BACKUPS --project=PROJECT + --location=LOCATION --backup-plan=BACKUP_PLAN --backup=BACKUP. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument volume_backup on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + VOLUME_BACKUP + ID of the volume backup or fully qualified identifier for the volume + backup. To set the volume_backup attribute: + ▸ provide the argument volume_backup on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --backup=BACKUP + Backup name. To set the backup attribute: + ▸ provide the argument volume_backup on the command line with a + fully specified name; + ▸ provide the argument --backup on the command line; + ▸ set the property gkebackup/backup. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument volume_backup on the command line with a + fully specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument volume_backup on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore volume-backups describe + diff --git a/gcloud/beta/container/backup-restore/volume-backups/help b/gcloud/beta/container/backup-restore/volume-backups/help new file mode 100644 index 000000000..cf52dc514 --- /dev/null +++ b/gcloud/beta/container/backup-restore/volume-backups/help @@ -0,0 +1,31 @@ +NAME + gcloud beta container backup-restore volume-backups - backup for GKE Volume + Backups + +SYNOPSIS + gcloud beta container backup-restore volume-backups COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Volume Backups. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describe a volume backup. + + list + (BETA) List volume backups. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore volume-backups + diff --git a/gcloud/beta/container/backup-restore/volume-backups/list b/gcloud/beta/container/backup-restore/volume-backups/list new file mode 100644 index 000000000..5c447a2b6 --- /dev/null +++ b/gcloud/beta/container/backup-restore/volume-backups/list @@ -0,0 +1,119 @@ +NAME + gcloud beta container backup-restore volume-backups list - list volume + backups + +SYNOPSIS + gcloud beta container backup-restore volume-backups list + [--backup=BACKUP --backup-plan=BACKUP_PLAN --location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE volume backups. + +EXAMPLES + To list all volume backups in project my-project in location us-central1 + under backup plan my-backup-plan under backup my-backup, run: + + $ gcloud beta container backup-restore volume-backups list \ + --backup-plan=my-backup-plan --backup=my-backup \ + --project=my-project --location=us-central1 + + To list all volume backups in project 'my-project' in location + 'us-central1' under all backup plans under all backups, run: + + $ gcloud beta container backup-restore volume-backups list \ + --project=my-project --location=us-central1 + + To list all volume backups in project 'my-project' across all locations + under all backup plans under all backups, run: + + $ gcloud beta container backup-restore volume-backups list \ + --project=my-project + +FLAGS + Backup resource - Name of the backup from which to list volume backups + (provided via options or through properties), e.g. --project= + --location= --backup-plan= --backup=. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument --backup on the command line with a fully + specified name; + ◆ set the property gkebackup/backup with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --backup=BACKUP + ID of the backup or fully qualified identifier for the backup. To set + the backup attribute: + ▸ provide the argument --backup on the command line; + ▸ set the property gkebackup/backup. + + --backup-plan=BACKUP_PLAN + Backup Plan name. To set the backup-plan attribute: + ▸ provide the argument --backup on the command line with a fully + specified name; + ▸ set the property gkebackup/backup with a fully specified name; + ▸ provide the argument --backup-plan on the command line; + ▸ set the property gkebackup/backup_plan. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument --backup on the command line with a fully + specified name; + ▸ set the property gkebackup/backup with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore volume-backups list + diff --git a/gcloud/beta/container/backup-restore/volume-restores/describe b/gcloud/beta/container/backup-restore/volume-restores/describe new file mode 100644 index 000000000..fd22e158f --- /dev/null +++ b/gcloud/beta/container/backup-restore/volume-restores/describe @@ -0,0 +1,87 @@ +NAME + gcloud beta container backup-restore volume-restores describe - describe a + volume restore + +SYNOPSIS + gcloud beta container backup-restore volume-restores describe + (VOLUME_RESTORE + : --location=LOCATION --restore=RESTORE --restore-plan=RESTORE_PLAN) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Describe a Backup for GKE volume restore. + +EXAMPLES + To describe a volume restore my-volume-restore in project my-project in + location us-central1 under restore plan my-restore-plan under restore + my-restore, run: + + $ gcloud beta container backup-restore volume-restores describe \ + my-volume-restore --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan --restore=my-restore + +POSITIONAL ARGUMENTS + Volume restore resource - Name of the volume restore to describe. The name + may be provided either as a relative name, e.g. + projects//locations//restorePlans//restores//volumeRestores/ + or as a single ID name (with the parent resources provided via options or + through properties), e.g. VOLUME_RESTORE --project= + --location= --restore-plan= --restore=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument volume_restore on the command line with a fully + specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + This must be specified. + + VOLUME_RESTORE + ID of the volume restore or fully qualified identifier for the volume + restore. To set the volume_restore attribute: + ▸ provide the argument volume_restore on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument volume_restore on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore=RESTORE + Restore name. To set the restore attribute: + ▸ provide the argument volume_restore on the command line with a + fully specified name; + ▸ provide the argument --restore on the command line; + ▸ set the property gkebackup/restore. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument volume_restore on the command line with a + fully specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore volume-restores describe + diff --git a/gcloud/beta/container/backup-restore/volume-restores/help b/gcloud/beta/container/backup-restore/volume-restores/help new file mode 100644 index 000000000..9718046fc --- /dev/null +++ b/gcloud/beta/container/backup-restore/volume-restores/help @@ -0,0 +1,31 @@ +NAME + gcloud beta container backup-restore volume-restores - backup for GKE + Volume Restores + +SYNOPSIS + gcloud beta container backup-restore volume-restores COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Backup for GKE Volume Restores. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (BETA) Describe a volume restore. + + list + (BETA) List volume restores. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore volume-restores + diff --git a/gcloud/beta/container/backup-restore/volume-restores/list b/gcloud/beta/container/backup-restore/volume-restores/list new file mode 100644 index 000000000..dc31a1603 --- /dev/null +++ b/gcloud/beta/container/backup-restore/volume-restores/list @@ -0,0 +1,113 @@ +NAME + gcloud beta container backup-restore volume-restores list - list volume + restores + +SYNOPSIS + gcloud beta container backup-restore volume-restores list + [--location=LOCATION --restore=RESTORE --restore-plan=RESTORE_PLAN] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List Backup for GKE volume restores. + +EXAMPLES + To list all volume restores in project my-project in location us-central1 + under restore plan my-restore-plan under restores my-restore, run: + + $ gcloud beta container backup-restore volume-restores list \ + --project=my-project --location=us-central1 \ + --restore-plan=my-restore-plan --restore=my-restore + + To list all volume restores in project my-project across all locations + under all restore plans and restores, run: + + $ gcloud beta container backup-restore volume-restores list \ + --project=my-project + +FLAGS + Restore resource - Name of the restore from which to list volume restores + (provided via options or through properties), e.g. --project= + --location= --restore-plan= --restore=. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: + ◆ provide the argument --restore on the command line with a fully + specified name; + ◆ set the property gkebackup/restore with a fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. + + --location=LOCATION + Google Cloud location. To set the location attribute: + ▸ provide the argument --restore on the command line with a fully + specified name; + ▸ set the property gkebackup/restore with a fully specified name; + ▸ provide the argument --location on the command line; + ▸ set the property gkebackup/location. + + --restore=RESTORE + ID of the restore or fully qualified identifier for the restore. To + set the restore attribute: + ▸ provide the argument --restore on the command line; + ▸ set the property gkebackup/restore. + + --restore-plan=RESTORE_PLAN + Restore Plan name. To set the restore-plan attribute: + ▸ provide the argument --restore on the command line with a fully + specified name; + ▸ set the property gkebackup/restore with a fully specified name; + ▸ provide the argument --restore-plan on the command line; + ▸ set the property gkebackup/restore_plan. + +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 gkebackup/v1 API. The full documentation for this API + can be found at: + https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha container backup-restore volume-restores list + diff --git a/gcloud/beta/container/help b/gcloud/beta/container/help index 8a5f86be4..7ba8c5bb7 100644 --- a/gcloud/beta/container/help +++ b/gcloud/beta/container/help @@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS GROUPS GROUP is one of the following: + backup-restore + (BETA) Backup for GKE Services. + binauthz (BETA) Manage attestations for Binary Authorization on Google Cloud Platform. diff --git a/gcloud/beta/filestore/instances/restore b/gcloud/beta/filestore/instances/restore index 900dc0984..f90d5b61e 100644 --- a/gcloud/beta/filestore/instances/restore +++ b/gcloud/beta/filestore/instances/restore @@ -48,6 +48,7 @@ POSITIONAL ARGUMENTS ▸ provide the argument instance on the command line with a fully specified name; ▸ provide the argument --zone on the command line; + ▸ provide the argument --location on the command line; ▸ set the property filestore/zone. REQUIRED FLAGS diff --git a/gcloud/beta/firebase/test/android/run b/gcloud/beta/firebase/test/android/run index 3cd4f6b87..c9d2805a7 100644 --- a/gcloud/beta/firebase/test/android/run +++ b/gcloud/beta/firebase/test/android/run @@ -266,13 +266,13 @@ FLAGS Enable code coverage and provide a directory to store the coverage results when using Android Test Orchestrator (--use-orchestrator): - --environment-variables clearPackageData=true,coverage=true,coverageFilePath=/sdcard/ + --environment-variables clearPackageData=true,coverage=true,coverageFilePath=/sdcard/Download/ Enable code coverage and provide a file path to store the coverage results when not using Android Test Orchestrator (--no-use-orchestrator): - --environment-variables coverage=true,coverageFile=/sdcard/coverage.ec + --environment-variables coverage=true,coverageFile=/sdcard/Download/coverage.ec Note: If you need to embed a comma into a VALUE string, please refer to gcloud topic escaping for ways to change the default list delimiter. diff --git a/gcloud/beta/firestore/fields/help b/gcloud/beta/firestore/fields/help new file mode 100644 index 000000000..33116c912 --- /dev/null +++ b/gcloud/beta/firestore/fields/help @@ -0,0 +1,26 @@ +NAME + gcloud beta firestore fields - manage field metadata for Cloud Firestore + +SYNOPSIS + gcloud beta firestore fields GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage field metadata for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + ttls + (BETA) Manage Time-to-live metadata for Cloud Firestore. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha firestore fields + diff --git a/gcloud/beta/firestore/fields/ttls/help b/gcloud/beta/firestore/fields/ttls/help new file mode 100644 index 000000000..9a2dc06e5 --- /dev/null +++ b/gcloud/beta/firestore/fields/ttls/help @@ -0,0 +1,30 @@ +NAME + gcloud beta firestore fields ttls - manage Time-to-live metadata for Cloud + Firestore + +SYNOPSIS + gcloud beta firestore fields ttls COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Manage Time-to-live metadata for Cloud Firestore. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + list + (BETA) List all fields used as a Time To Live expiration setting. + + update + (BETA) Update the TTL configuration of the given field. + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha firestore fields ttls + diff --git a/gcloud/beta/firestore/fields/ttls/list b/gcloud/beta/firestore/fields/ttls/list new file mode 100644 index 000000000..ce035f860 --- /dev/null +++ b/gcloud/beta/firestore/fields/ttls/list @@ -0,0 +1,96 @@ +NAME + gcloud beta firestore fields ttls list - list all fields used as a Time To + Live expiration setting + +SYNOPSIS + gcloud beta firestore fields ttls list + [--collection-group=COLLECTION_GROUP] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) List fields that give an expiration timestamp for documents in a + collection group or kind. + +EXAMPLES + The following command lists all TTL fields for the whole database: + + $ gcloud beta firestore fields ttls list + +FLAGS + Collection group resource - Collection group of the ttl. + + This can be omitted to include fields across all collection groups + (kinds). This represents a Cloud resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. To set the + project attribute: + ◆ provide the argument --collection-group on the command line with a + fully specified name; + ◆ provide the argument [--collection-group] on the command line with a + fully specified name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. To set the + database attribute: + ◆ provide the argument --collection-group on the command line with a + fully specified name; + ◆ provide the argument [--collection-group] on the command line with a + fully specified name; + ◆ provide the argument [--database] on the command line (currently + '(default)' is the only supported value). + + --collection-group=COLLECTION_GROUP + ID of the collection group or fully qualified identifier for the + collection group. To set the collection-group attribute: + ▸ provide the argument --collection-group on the command line; + ▸ provide the argument [--collection-group] on the command line. + +LIST COMMAND FLAGS + --filter=EXPRESSION + Apply a Boolean filter EXPRESSION to each resource item to be listed. + If the expression evaluates True, then that item is listed. For more + details and examples of filter expressions, run $ gcloud topic filters. + This flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --limit=LIMIT + Maximum number of resources to list. The default is unlimited. This + flag interacts with other flags that are applied in this order: + --flatten, --sort-by, --filter, --limit. + + --page-size=PAGE_SIZE + Some services group resource list output into pages. This flag + specifies the maximum number of resources per page. The default is + determined by the service if it supports paging, otherwise it is + unlimited (no paging). Paging may be applied before or after --filter + and --limit depending on the service. + + --sort-by=[FIELD,...] + Comma-separated list of resource field key names to sort by. The + default order is ascending. Prefix a field with ``~'' for descending + order on that field. This flag interacts with other flags that are + applied in this order: --flatten, --sort-by, --filter, --limit. + + --uri + Print a list of resource URIs instead of the default output, and change + the command output to a list of URIs. If this flag is used with + --format, the formatting is applied on this URI list. To display URIs + alongside other keys instead, use the uri() transform. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the firestore/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/firestore + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha firestore fields ttls list + diff --git a/gcloud/beta/firestore/fields/ttls/update b/gcloud/beta/firestore/fields/ttls/update new file mode 100644 index 000000000..0f706dac6 --- /dev/null +++ b/gcloud/beta/firestore/fields/ttls/update @@ -0,0 +1,94 @@ +NAME + gcloud beta firestore fields ttls update - update the TTL configuration of + the given field + +SYNOPSIS + gcloud beta firestore fields ttls update + (FIELD : --collection-group=COLLECTION_GROUP) + (--disable-ttl | --enable-ttl) [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update the TTL configuration of the given field. + + This enables or disables using a field as the TTL field for its collection + group or kind. Note that only one field can be the TTL field for a + collection group. + +EXAMPLES + The following command sets the expiry field of the Events collection group + (kind) to be the TTL field: + + $ gcloud beta firestore fields ttls update expiry \ + --collection-group=Events --enable-ttl + + The following command disables the expiry field so it is no longer the TTL + for the Events collection group (kind): + + $ gcloud beta firestore fields ttls update expiry \ + --collection-group=Events --disable-ttl + +POSITIONAL ARGUMENTS + Field resource - Field 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 field on the command line with a fully specified + name; + ◆ set the property core/project; + ◆ provide the argument --project on the command line. To set the + database attribute: + ◆ provide the argument field on the command line with a fully specified + name; + ◆ provide the argument [--database] on the command line (currently + '(default)' is the only supported value). + + This must be specified. + + FIELD + ID of the field or fully qualified identifier for the field. To set + the field attribute: + ▸ provide the argument field on the command line. + + This positional must be specified if any of the other arguments in + this group are specified. + + --collection-group=COLLECTION_GROUP + Collection group of the field. + + To set the collection-group attribute: + ▸ provide the argument field on the command line with a fully + specified name; + ▸ provide the argument --collection-group on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --disable-ttl + Set to make this field no longer the TTL for its collection group. + + --enable-ttl + Set to enable this field as the TTL for its collection group. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the firestore/v1 API. The full documentation for this API + can be found at: https://cloud.google.com/firestore + +NOTES + This command is currently in beta and might change without notice. This + variant is also available: + + $ gcloud alpha firestore fields ttls update + diff --git a/gcloud/beta/firestore/help b/gcloud/beta/firestore/help index 906fceaa0..2806eb6da 100644 --- a/gcloud/beta/firestore/help +++ b/gcloud/beta/firestore/help @@ -24,6 +24,9 @@ GROUPS databases (BETA) Manage Creation of Cloud Firestore in Native mode Database. + fields + (BETA) Manage field metadata for Cloud Firestore. + indexes (BETA) Manage indexes for Cloud Firestore. diff --git a/gcloud/beta/run/deploy b/gcloud/beta/run/deploy index 17eed14aa..27d92c421 100644 --- a/gcloud/beta/run/deploy +++ b/gcloud/beta/run/deploy @@ -22,7 +22,7 @@ SYNOPSIS --update-config-maps=[KEY=VALUE,...]] [--image=IMAGE | --source=SOURCE] [--[no-]allow-unauthenticated --breakglass=JUSTIFICATION - --clear-vpc-connector --[no-]cpu-throttling + --clear-vpc-connector --[no-]cpu-throttling --description=DESCRIPTION --execution-environment=EXECUTION_ENVIRONMENT --revision-suffix=REVISION_SUFFIX --[no-]session-affinity --vpc-connector=VPC_CONNECTOR --vpc-egress=VPC_EGRESS @@ -378,6 +378,9 @@ FLAGS serving requests. Use --cpu-throttling to enable and --no-cpu-throttling to disable. + --description=DESCRIPTION + Provides an optional, human-readable description of the service. + --execution-environment=EXECUTION_ENVIRONMENT Selects the execution environment where the application will run. EXECUTION_ENVIRONMENT must be one of: diff --git a/gcloud/container/clusters/create b/gcloud/container/clusters/create index c594d5a34..10d34dee4 100644 --- a/gcloud/container/clusters/create +++ b/gcloud/container/clusters/create @@ -19,16 +19,16 @@ SYNOPSIS [--disk-type=DISK_TYPE] [--enable-autorepair] [--no-enable-autoupgrade] [--enable-binauthz] [--enable-cloud-logging] [--enable-cloud-monitoring] [--enable-cloud-run-alpha] - [--enable-dataplane-v2] [--enable-gvnic] [--enable-identity-service] - [--enable-image-streaming] [--enable-intra-node-visibility] - [--enable-ip-alias] [--enable-kubernetes-alpha] - [--enable-l4-ilb-subsetting] [--enable-legacy-authorization] - [--enable-master-global-access] [--enable-network-policy] - [--enable-service-externalips] [--enable-shielded-nodes] - [--enable-stackdriver-kubernetes] [--enable-vertical-pod-autoscaling] - [--image-type=IMAGE_TYPE] [--issue-client-certificate] - [--labels=[KEY=VALUE,...]] [--local-ssd-count=LOCAL_SSD_COUNT] - [--logging=[COMPONENT,...]] + [--enable-confidential-nodes] [--enable-dataplane-v2] [--enable-gvnic] + [--enable-identity-service] [--enable-image-streaming] + [--enable-intra-node-visibility] [--enable-ip-alias] + [--enable-kubernetes-alpha] [--enable-l4-ilb-subsetting] + [--enable-legacy-authorization] [--enable-master-global-access] + [--enable-network-policy] [--enable-service-externalips] + [--enable-shielded-nodes] [--enable-stackdriver-kubernetes] + [--enable-vertical-pod-autoscaling] [--image-type=IMAGE_TYPE] + [--issue-client-certificate] [--labels=[KEY=VALUE,...]] + [--local-ssd-count=LOCAL_SSD_COUNT] [--logging=[COMPONENT,...]] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-nodes-per-pool=MAX_NODES_PER_POOL] [--max-pods-per-node=MAX_PODS_PER_NODE] @@ -363,6 +363,11 @@ FLAGS Cloud Run alpha clusters are not covered by the Cloud Run SLA and should not be used for production workloads. + --enable-confidential-nodes + Enable confidential nodes for the cluster. Enabling Confidential Nodes + will create nodes using Confidential VM + https://cloud.google.com/compute/confidential-vm/docs/about-cvm. + --enable-dataplane-v2 Enables the new eBPF dataplane for GKE clusters that is required for network security, scalability and visibility features. diff --git a/gcloud/container/node-pools/create b/gcloud/container/node-pools/create index 66ee96ffb..cc1a1d520 100644 --- a/gcloud/container/node-pools/create +++ b/gcloud/container/node-pools/create @@ -8,8 +8,9 @@ SYNOPSIS [--boot-disk-kms-key=BOOT_DISK_KMS_KEY] [--cluster=CLUSTER] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autoprovisioning] [--enable-autorepair] - [--no-enable-autoupgrade] [--enable-gvnic] [--enable-image-streaming] - [--image-type=IMAGE_TYPE] [--local-ssd-count=LOCAL_SSD_COUNT] + [--no-enable-autoupgrade] [--enable-confidential-nodes] + [--enable-gvnic] [--enable-image-streaming] [--image-type=IMAGE_TYPE] + [--local-ssd-count=LOCAL_SSD_COUNT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] [--max-surge-upgrade=MAX_SURGE_UPGRADE; default=1] @@ -124,6 +125,11 @@ FLAGS Enabled by default, use --no-enable-autoupgrade to disable. + --enable-confidential-nodes + Enable confidential nodes for the node pool. Enabling Confidential + Nodes will create nodes using Confidential VM + https://cloud.google.com/compute/confidential-vm/docs/about-cvm. + --enable-gvnic Enable the use of GVNIC for this cluster. Requires re-creation of nodes using either a node-pool upgrade or node-pool creation. diff --git a/gcloud/container/node-pools/update b/gcloud/container/node-pools/update index 8d59722f8..f3910e29a 100644 --- a/gcloud/container/node-pools/update +++ b/gcloud/container/node-pools/update @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud container node-pools update NAME - (--enable-gvnic | --enable-image-streaming + (--enable-confidential-nodes | --enable-gvnic + | --enable-image-streaming | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] @@ -36,6 +37,10 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS Exactly one of these must be specified: + --enable-confidential-nodes + Recreate all the nodes in the node pool to be confidential VM + https://cloud.google.com/compute/confidential-vm/docs/about-cvm. + --enable-gvnic Enable the use of GVNIC for this cluster. Requires re-creation of nodes using either a node-pool upgrade or node-pool creation. diff --git a/gcloud/database-migration/migration-jobs/create b/gcloud/database-migration/migration-jobs/create index 6d4fa3282..66ce3b9ff 100644 --- a/gcloud/database-migration/migration-jobs/create +++ b/gcloud/database-migration/migration-jobs/create @@ -12,14 +12,34 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Create a Database Migration Service migration job. + Create a Database Migration Service migration job. Recommended steps before + creating the migration job: + ▪ Create a source connection profile. See prerequisites here + (https://cloud.google.com/database-migration/docs/mysql/configure-source-database). + ▪ Create a destination connection profile. + ▪ Configure the connectivity method. See prerequisites here + (https://cloud.google.com/database-migration/docs/mysql/configure-connectivity). EXAMPLES - To create a migration job with vpc peering connectivity: + To create a continuous migration job with IP allowlist connectivity: - $ gcloud database-migration migration-jobs create MIGRATION_JOB \ - --region=us-central1 --display-name=my-job --source=cp1 \ - --destination=cp2 --peer-vpc=network1 + $ gcloud database-migration migration-jobs create my-migration-job \ + --region=us-central1 --type=CONTINUOUS --source=cp1 \ + --destination=cp2 + + To create a continuous migration job with VPC peering connectivity: + + $ gcloud database-migration migration-jobs create my-migration-job \ + --region=us-central1 --type=CONTINUOUS --source=cp1 \ + --destination=cp2 \ + --peer-vpc=projects/my-project/global/networks/my-network + + To create a one-time migration job with reverse-SSH tunnel connectivity: + + $ gcloud database-migration migration-jobs create my-migration-job \ + --region=us-central1 --type=ONE_TIME --source=cp1 \ + --destination=cp2 --vm=vm1 --vm-ip=1.1.1.1 --vm-port=1111 \ + --vpc=projects/my-project/global/networks/my-network POSITIONAL ARGUMENTS Migration job resource - The migration job to create. The arguments in @@ -48,10 +68,10 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line. REQUIRED FLAGS - Connection profile resource - Resource ID of the destination connection - profile. 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: + Connection profile resource - ID of the destination connection profile, + representing thedestination database. This represents a Cloud resource. + (NOTE) Some attributes are not given arguments in this group but can be + set in other ways. To set the project attribute: ◆ provide the argument --destination on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -67,10 +87,10 @@ REQUIRED FLAGS connection_profile. To set the connection_profile attribute: ▸ provide the argument --destination on the command line. - Connection profile resource - Resource ID of the source connection - profile. 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: + Connection profile resource - ID of the source connection profile, + representing the source database. This represents a Cloud resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: ◆ provide the argument --source on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -87,15 +107,16 @@ REQUIRED FLAGS ▸ provide the argument --source on the command line. --type=TYPE - Type of the migration job (ONE_TIME or CONTINUOUS). TYPE must be one - of: ONE_TIME, CONTINUOUS. + Type of the migration job. TYPE must be one of: ONE_TIME, CONTINUOUS. OPTIONAL FLAGS --no-async Waits for the operation in progress to complete before returning. --display-name=DISPLAY_NAME - Friendly name for the migration job. + A user-friendly name for the migration job. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. --dump-path=DUMP_PATH Path to the dump file in Google Cloud Storage, in the format: diff --git a/gcloud/database-migration/migration-jobs/generate-ssh-script b/gcloud/database-migration/migration-jobs/generate-ssh-script index ff7badd7d..eb56d201e 100644 --- a/gcloud/database-migration/migration-jobs/generate-ssh-script +++ b/gcloud/database-migration/migration-jobs/generate-ssh-script @@ -10,29 +10,42 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - Generate a SSH script for a Database Migration Service migration job. + Generate a script for a Database Migration Service migration job, to + configure Reverse SSH tunnel connectivity with a bastion host on a Compute + Engine VM instance. You can use an existing VM instance or create a new VM + for this purpose. + + Copy the generated script and run it in bash from a machine that has: + ▪ The gcloud command-line tool installed. + ▪ Access to your source database. + ▪ Access to the existing bastion VM, or permissions and access to the + Cloud Compute API if creating a new bastion VM. Make sure this machine + is available during the entire migration. + + Running the script will set up the SSH tunnel on the VM you selected and + will establish connectivity between the source database and the Cloud SQL + instance. Find additional information here + (https://cloud.google.com/database-migration/docs/mysql/configure-connectivity-reverse-ssh-tunnel). EXAMPLES - To generate a SSH script for a Database Migration Service migration job - with vm creation config, run: + To generate an SSH script with bastion VM instance creation: $ gcloud database-migration migration-jobs generate-ssh-script \ - my-migration-job --vm=sample-vm --vm-port=1111 \ + my-migration-job --vm=vm1 --vm-port=1111 \ --vm-machine-type=n1-standard-1 --vm-zone-create=us-central1-a \ --subnet=sample-subnet --region=us-central1 - To generate a SSH script for a Database Migration Service migration job - with vm selection config, run: + To generate an SSH script with an existing bastion VM instance: $ gcloud database-migration migration-jobs generate-ssh-script \ - my-migration-job --vm=sample-vm --vm-port=1111 \ + my-migration-job --vm=vm1 --vm-port=1111 \ --vm-zone=us-central1-a --region=us-central1 POSITIONAL ARGUMENTS - Migration job resource - The migration job you want to generate SSH script - 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: + Migration job resource - The migration job to generate the SSH script 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 migration_job on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -56,27 +69,28 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --vm=VM - Bastion VM Instance name to use or to create (if machineType is given). + Bastion Compute Engine VM instance name to use or to create. Exactly one of these must be specified: --vm-zone=VM_ZONE - Google Cloud Platform zone the VM is located in. + Zone the existing bastion VM instance is located in. --subnet=SUBNET - Subnet name the VM needs to be created in. + Subnet to create the VM instance in. This flag must be specified if any of the other arguments in this group are specified. --vm-machine-type=VM_MACHINE_TYPE - VM instance machine type to create. + Machine type for a new VM instance. To get a list of available + machine types, run 'gcloud compute machine-types list'. This flag must be specified if any of the other arguments in this group are specified. --vm-zone-create=VM_ZONE_CREATE - Google Cloud Platform zone to create the VM in. + Zone to create the VM instance in. OPTIONAL FLAGS --vm-port=VM_PORT diff --git a/gcloud/database-migration/migration-jobs/update b/gcloud/database-migration/migration-jobs/update index 88c90b06d..1e31f864b 100644 --- a/gcloud/database-migration/migration-jobs/update +++ b/gcloud/database-migration/migration-jobs/update @@ -14,14 +14,21 @@ SYNOPSIS DESCRIPTION Update a Database Migration Service migration job. + ▪ Draft migration job: user can update all available flags. + ▪ Any other state can only update flags: --display-name, --dump-path, + and connectivity method flags. EXAMPLES - To update a migration job in draft with new display name, source and - destination connection profiles: + To update the source and destination connection profiles of a draft + migration job: - $ gcloud database-migration migration-jobs update MIGRATION_JOB \ - --region=us-central1 --display-name=new-name --source=new-src \ - --destination=new-dest + $ gcloud database-migration migration-jobs update my-migration-job \ + --region=us-central1 --source=new-src --destination=new-dest + + To update the display name of a running migration job: + + $ gcloud database-migration migration-jobs update my-migration-job \ + --region=us-central1 --display-name=new-name POSITIONAL ARGUMENTS Migration job resource - The migration job to update. The arguments in @@ -50,10 +57,10 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line. FLAGS - Connection profile resource - Resource ID of the destination connection - profile. 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: + Connection profile resource - ID of the destination connection profile, + representing thedestination database. This represents a Cloud resource. + (NOTE) Some attributes are not given arguments in this group but can be + set in other ways. To set the project attribute: ◆ provide the argument --destination on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -67,10 +74,10 @@ FLAGS connection_profile. To set the connection_profile attribute: ▸ provide the argument --destination on the command line. - Connection profile resource - Resource ID of the source connection - profile. 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: + Connection profile resource - ID of the source connection profile, + representing the source database. This represents a Cloud resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. To set the project attribute: ◆ provide the argument --source on the command line with a fully specified name; ◆ provide the argument --project on the command line; @@ -88,15 +95,16 @@ FLAGS Waits for the operation in progress to complete before returning. --display-name=DISPLAY_NAME - Friendly name for the migration job. + A user-friendly name for the migration job. The display name can + include letters, numbers, spaces, and hyphens, and must start with a + letter. --dump-path=DUMP_PATH Path to the dump file in Google Cloud Storage, in the format: gs://[BUCKET_NAME]/[OBJECT_NAME]. --type=TYPE - Type of the migration job (ONE_TIME or CONTINUOUS). TYPE must be one - of: ONE_TIME, CONTINUOUS. + Type of the migration job. TYPE must be one of: ONE_TIME, CONTINUOUS. --update-labels=[KEY=VALUE,...] List of label KEY=VALUE pairs to update. If a label exists, its value diff --git a/gcloud/dataproc/clusters/create b/gcloud/dataproc/clusters/create index d2cc3e24d..1657e5670 100644 --- a/gcloud/dataproc/clusters/create +++ b/gcloud/dataproc/clusters/create @@ -51,6 +51,9 @@ SYNOPSIS --tags=TAG,[TAG,...] --network=NETWORK | --subnet=SUBNET --reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; default="any"] + [[--metric-sources=[METRIC_SOURCES,...] + : --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] + | --metric-overrides-file=METRIC_OVERRIDES_FILE]] [--single-node | --num-secondary-workers=NUM_SECONDARY_WORKERS --num-workers=NUM_WORKERS --secondary-worker-type=TYPE; default="preemptible"] @@ -713,6 +716,22 @@ FLAGS The type of reservation for the instance. RESERVATION_AFFINITY must be one of: any, none, specific. + --metric-sources=[METRIC_SOURCES,...] + Specifies a list of Metric Sources to collect custom metrics from the + cluster. METRIC_SOURCES must be one of: HDFS, HIVESERVER2, + MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, YARN. + + At most one of these can be specified: + + --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] + List of Metrics that override the default metrics enabled for the + metric source + + --metric-overrides-file=METRIC_OVERRIDES_FILE + Path to a file containing list of Metrics that override the default + metrics enabled for the metric source. The path can be a Cloud + Storage URL (example: gs://path/to/file) or a local file system path. + At most one of these can be specified: --single-node diff --git a/gcloud/dataproc/workflow-templates/set-managed-cluster b/gcloud/dataproc/workflow-templates/set-managed-cluster index dd32723ae..b61bb7ac2 100644 --- a/gcloud/dataproc/workflow-templates/set-managed-cluster +++ b/gcloud/dataproc/workflow-templates/set-managed-cluster @@ -46,6 +46,9 @@ SYNOPSIS --tags=TAG,[TAG,...] --network=NETWORK | --subnet=SUBNET --reservation=RESERVATION --reservation-affinity=RESERVATION_AFFINITY; default="any"] + [[--metric-sources=[METRIC_SOURCES,...] + : --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] + | --metric-overrides-file=METRIC_OVERRIDES_FILE]] [--single-node | --num-secondary-workers=NUM_SECONDARY_WORKERS --num-workers=NUM_WORKERS --secondary-worker-type=TYPE; default="preemptible"] @@ -647,6 +650,22 @@ FLAGS The type of reservation for the instance. RESERVATION_AFFINITY must be one of: any, none, specific. + --metric-sources=[METRIC_SOURCES,...] + Specifies a list of Metric Sources to collect custom metrics from the + cluster. METRIC_SOURCES must be one of: HDFS, HIVESERVER2, + MONITORING_AGENT_DEFAULTS, SPARK, SPARK_HISTORY_SERVER, YARN. + + At most one of these can be specified: + + --metric-overrides=[METRIC_SOURCE:INSTANCE:GROUP:METRIC,...] + List of Metrics that override the default metrics enabled for the + metric source + + --metric-overrides-file=METRIC_OVERRIDES_FILE + Path to a file containing list of Metrics that override the default + metrics enabled for the metric source. The path can be a Cloud + Storage URL (example: gs://path/to/file) or a local file system path. + At most one of these can be specified: --single-node diff --git a/gcloud/firebase/test/android/run b/gcloud/firebase/test/android/run index bca868e8c..fe41f3f55 100644 --- a/gcloud/firebase/test/android/run +++ b/gcloud/firebase/test/android/run @@ -249,13 +249,13 @@ FLAGS Enable code coverage and provide a directory to store the coverage results when using Android Test Orchestrator (--use-orchestrator): - --environment-variables clearPackageData=true,coverage=true,coverageFilePath=/sdcard/ + --environment-variables clearPackageData=true,coverage=true,coverageFilePath=/sdcard/Download/ Enable code coverage and provide a file path to store the coverage results when not using Android Test Orchestrator (--no-use-orchestrator): - --environment-variables coverage=true,coverageFile=/sdcard/coverage.ec + --environment-variables coverage=true,coverageFile=/sdcard/Download/coverage.ec Note: If you need to embed a comma into a VALUE string, please refer to gcloud topic escaping for ways to change the default list delimiter. diff --git a/gcloud/transfer/jobs/create b/gcloud/transfer/jobs/create index c93d3a6b8..b0c6cd1a8 100644 --- a/gcloud/transfer/jobs/create +++ b/gcloud/transfer/jobs/create @@ -66,20 +66,15 @@ POSITIONAL ARGUMENTS SOURCE The source of your data. Available sources and formatting information: - Public clouds - For Google Cloud Storage and Amazon S3, specify the - scheme of the source type; name of the resource; and, if transferring - from a folder, the path to the folder. For Azure Storage, note the - Azure-specific formatting below. For example: - ◆ [Google Cloud Storage] gs://example-bucket/example-folder + Public clouds - + ◆ [Google Cloud Storage] gs://example-bucket/example-folder/ ◆ [Amazon S3] s3://examplebucket/example-folder ◆ [Azure Blob Storage or Data Lake Storage] http://examplestorageaccount.blob.core.windows.net/examplecontainer/examplefolder - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the posix:// - scheme followed by the absolute path to the desired directory, starting - from the root of the host machine (denoted by a leading slash). For - example: + POSIX filesystem - Specify the posix:// scheme followed by the absolute + path to the desired directory, starting from the root of the host + machine (denoted by a leading slash). For example: ◆ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and @@ -95,13 +90,11 @@ POSITIONAL ARGUMENTS Google Cloud Storage - Specify the gs:// scheme; name of the bucket; and, if transferring to a folder, the path to the folder. For example: - ◆ gs://example-bucket/example-folder + ◆ gs://example-bucket/example-folder/ - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the posix:// - scheme followed by the absolute path to the desired directory, starting - from the root of the host machine (denoted by a leading slash). For - example: + POSIX filesystem - Specify the posix:// scheme followed by the absolute + path to the desired directory, starting from the root of the host + machine (denoted by a leading slash). For example: ◆ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and diff --git a/gcloud/transfer/jobs/update b/gcloud/transfer/jobs/update index 87642b70a..6edaa2ca7 100644 --- a/gcloud/transfer/jobs/update +++ b/gcloud/transfer/jobs/update @@ -71,20 +71,15 @@ FLAGS The source of your data. Available sources and formatting information: - Public clouds - For Google Cloud Storage and Amazon S3, specify the - scheme of the source type; name of the resource; and, if transferring - from a folder, the path to the folder. For Azure Storage, note the - Azure-specific formatting below. For example: - ▸ [Google Cloud Storage] gs://example-bucket/example-folder + Public clouds - + ▸ [Google Cloud Storage] gs://example-bucket/example-folder/ ▸ [Amazon S3] s3://examplebucket/example-folder ▸ [Azure Blob Storage or Data Lake Storage] http://examplestorageaccount.blob.core.windows.net/examplecontainer/examplefolder - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the - posix:// scheme followed by the absolute path to the desired - directory, starting from the root of the host machine (denoted by a - leading slash). For example: + POSIX filesystem - Specify the posix:// scheme followed by the + absolute path to the desired directory, starting from the root of the + host machine (denoted by a leading slash). For example: ▸ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and @@ -103,13 +98,11 @@ FLAGS Google Cloud Storage - Specify the gs:// scheme; name of the bucket; and, if transferring to a folder, the path to the folder. For example: - ▸ gs://example-bucket/example-folder + ▸ gs://example-bucket/example-folder/ - POSIX filesystem - Specify the posix:// scheme followed by the full - path to the desired directory. POSIX filesystem - Specify the - posix:// scheme followed by the absolute path to the desired - directory, starting from the root of the host machine (denoted by a - leading slash). For example: + POSIX filesystem - Specify the posix:// scheme followed by the + absolute path to the desired directory, starting from the root of the + host machine (denoted by a leading slash). For example: ▸ posix:///path/directory/ A file transfer agent must be installed on the POSIX filesystem, and