From 8778dcbd7e80f3f663fc7dabfee6d4aef1411f89 Mon Sep 17 00:00:00 2001 From: Automated Date: Thu, 22 Feb 2024 10:25:44 +0000 Subject: [PATCH] gcloud: Thu Feb 22 10:25:44 UTC 2024 --- gcloud/_version | 8 +- gcloud/ai/indexes/upsert-datapoints | 14 +- gcloud/alpha/ai/indexes/upsert-datapoints | 14 +- gcloud/alpha/apphub/discovered-services/help | 4 - gcloud/alpha/apphub/discovered-workloads/help | 4 - .../audit-manager/audit-reports/generate | 60 ++++ gcloud/alpha/audit-manager/audit-reports/help | 27 ++ .../alpha/audit-manager/audit-scopes/generate | 64 +++++ gcloud/alpha/audit-manager/audit-scopes/help | 27 ++ gcloud/alpha/audit-manager/enrollments/add | 49 ++++ gcloud/alpha/audit-manager/enrollments/help | 27 ++ gcloud/alpha/audit-manager/help | 36 +++ .../alpha/audit-manager/operations/describe | 74 +++++ gcloud/alpha/audit-manager/operations/help | 26 ++ .../builds/connections/create/bitbucket-cloud | 111 ++++++++ .../connections/create/bitbucket-data-center | 142 ++++++++++ gcloud/alpha/builds/connections/create/help | 6 + .../builds/connections/update/bitbucket-cloud | 106 ++++++++ .../connections/update/bitbucket-data-center | 107 ++++++++ gcloud/alpha/builds/connections/update/help | 6 + .../builds/triggers/create/bitbucket-cloud | 225 +++++++++++++++ .../triggers/create/bitbucket-data-center | 226 +++++++++++++++ gcloud/alpha/builds/triggers/create/help | 8 + .../builds/triggers/update/bitbucket-cloud | 255 +++++++++++++++++ .../triggers/update/bitbucket-data-center | 257 ++++++++++++++++++ gcloud/alpha/builds/triggers/update/help | 6 + .../dns-authorizations/create | 6 +- gcloud/alpha/composer/environments/create | 6 +- gcloud/alpha/composer/environments/update | 6 +- gcloud/alpha/compute/commitments/create | 2 +- gcloud/alpha/compute/images/export | 20 +- gcloud/alpha/compute/images/import | 20 +- .../compute/instance-groups/managed/create | 12 +- gcloud/alpha/compute/instances/import | 20 +- gcloud/alpha/compute/machine-images/import | 20 +- .../alpha/container/binauthz/policy/evaluate | 80 ++++++ gcloud/alpha/container/binauthz/policy/help | 3 + gcloud/alpha/container/clusters/create | 31 ++- gcloud/alpha/container/clusters/create-auto | 19 +- gcloud/alpha/container/clusters/update | 6 + .../container/fleet/memberships/bindings/list | 3 +- gcloud/alpha/container/fleet/scopes/help | 2 +- gcloud/alpha/container/fleet/scopes/list | 17 +- .../container/hub/memberships/bindings/list | 3 +- gcloud/alpha/container/hub/scopes/help | 2 +- gcloud/alpha/container/hub/scopes/list | 17 +- gcloud/alpha/container/node-pools/create | 7 +- gcloud/alpha/container/node-pools/update | 12 +- .../alpha/deploy/delivery-pipelines/describe | 4 +- gcloud/alpha/deploy/delivery-pipelines/help | 3 +- gcloud/alpha/emulators/firestore/start | 16 +- gcloud/alpha/functions/describe | 14 +- gcloud/alpha/functions/list | 13 +- .../alpha/migration/vms/image-imports/create | 9 +- gcloud/alpha/netapp/volumes/create | 10 + gcloud/alpha/recommender/insights/help | 2 +- gcloud/alpha/recommender/insights/list | 17 +- gcloud/alpha/recommender/recommendations/list | 14 +- gcloud/alpha/run/deploy | 7 +- gcloud/alpha/run/jobs/create | 8 +- gcloud/alpha/run/jobs/deploy | 5 +- gcloud/alpha/run/jobs/update | 5 +- gcloud/alpha/run/services/update | 7 +- gcloud/alpha/scc/help | 3 + .../scc/manage/custom-modules/etd/create | 74 +++++ .../scc/manage/custom-modules/etd/delete | 91 +++++++ .../scc/manage/custom-modules/etd/describe | 88 ++++++ .../custom-modules/etd/describe-effective | 85 ++++++ .../alpha/scc/manage/custom-modules/etd/help | 56 ++++ .../alpha/scc/manage/custom-modules/etd/list | 97 +++++++ .../manage/custom-modules/etd/list-descendant | 98 +++++++ .../manage/custom-modules/etd/list-effective | 95 +++++++ .../scc/manage/custom-modules/etd/update | 74 +++++ .../scc/manage/custom-modules/etd/validate | 66 +++++ gcloud/alpha/scc/manage/custom-modules/help | 32 +++ .../scc/manage/custom-modules/sha/create | 69 +++++ .../scc/manage/custom-modules/sha/delete | 91 +++++++ .../scc/manage/custom-modules/sha/describe | 88 ++++++ .../custom-modules/sha/describe-effective | 86 ++++++ .../alpha/scc/manage/custom-modules/sha/help | 56 ++++ .../alpha/scc/manage/custom-modules/sha/list | 108 ++++++++ .../manage/custom-modules/sha/list-descendant | 98 +++++++ .../manage/custom-modules/sha/list-effective | 95 +++++++ .../scc/manage/custom-modules/sha/simulate | 87 ++++++ .../scc/manage/custom-modules/sha/update | 74 +++++ gcloud/alpha/scc/manage/help | 29 ++ gcloud/alpha/service-extensions/help | 4 +- .../lb-route-extensions/delete | 4 +- .../lb-route-extensions/describe | 4 +- .../lb-route-extensions/help | 4 +- .../lb-route-extensions/import | 4 +- .../lb-route-extensions/list | 4 +- .../lb-traffic-extensions/delete | 4 +- .../lb-traffic-extensions/describe | 4 +- .../lb-traffic-extensions/help | 4 +- .../lb-traffic-extensions/import | 4 +- .../lb-traffic-extensions/list | 4 +- gcloud/alpha/sql/operations/list | 4 +- gcloud/alpha/storage/restore | 20 +- gcloud/beta/ai/indexes/upsert-datapoints | 14 +- .../builds/connections/create/bitbucket-cloud | 109 ++++++++ .../connections/create/bitbucket-data-center | 140 ++++++++++ gcloud/beta/builds/connections/create/help | 6 + .../builds/connections/update/bitbucket-cloud | 104 +++++++ .../connections/update/bitbucket-data-center | 105 +++++++ gcloud/beta/builds/connections/update/help | 6 + .../builds/triggers/create/bitbucket-cloud | 223 +++++++++++++++ .../triggers/create/bitbucket-data-center | 224 +++++++++++++++ gcloud/beta/builds/triggers/create/help | 7 + .../builds/triggers/update/bitbucket-cloud | 253 +++++++++++++++++ .../triggers/update/bitbucket-data-center | 255 +++++++++++++++++ gcloud/beta/builds/triggers/update/help | 6 + .../dns-authorizations/create | 6 +- gcloud/beta/composer/environments/create | 6 +- gcloud/beta/composer/environments/update | 6 +- gcloud/beta/compute/commitments/create | 2 +- gcloud/beta/compute/images/export | 20 +- gcloud/beta/compute/images/import | 20 +- gcloud/beta/compute/instances/import | 20 +- gcloud/beta/compute/machine-images/import | 20 +- .../beta/container/binauthz/policy/evaluate | 78 ++++++ gcloud/beta/container/binauthz/policy/help | 3 + gcloud/beta/container/clusters/create | 31 ++- gcloud/beta/container/clusters/create-auto | 19 +- gcloud/beta/container/clusters/update | 6 + .../container/fleet/memberships/bindings/list | 3 +- gcloud/beta/container/fleet/scopes/help | 2 +- gcloud/beta/container/fleet/scopes/list | 17 +- .../container/hub/memberships/bindings/list | 2 +- gcloud/beta/container/hub/scopes/help | 2 +- gcloud/beta/container/hub/scopes/list | 17 +- gcloud/beta/container/node-pools/create | 7 +- gcloud/beta/container/node-pools/update | 12 +- .../beta/deploy/delivery-pipelines/describe | 4 +- gcloud/beta/deploy/delivery-pipelines/help | 3 +- gcloud/beta/emulators/firestore/start | 16 +- gcloud/beta/functions/describe | 14 +- gcloud/beta/functions/list | 13 +- gcloud/beta/netapp/volumes/create | 10 + gcloud/beta/recommender/insights/help | 2 +- gcloud/beta/recommender/insights/list | 31 ++- gcloud/beta/recommender/recommendations/list | 26 +- gcloud/beta/service-extensions/help | 6 +- .../lb-route-extensions/delete | 6 +- .../lb-route-extensions/describe | 6 +- .../lb-route-extensions/help | 6 +- .../lb-route-extensions/import | 6 +- .../lb-route-extensions/list | 6 +- .../lb-traffic-extensions/delete | 6 +- .../lb-traffic-extensions/describe | 6 +- .../lb-traffic-extensions/help | 6 +- .../lb-traffic-extensions/import | 6 +- .../lb-traffic-extensions/list | 6 +- gcloud/beta/sql/operations/list | 4 +- .../builds/connections/create/bitbucket-cloud | 108 ++++++++ .../connections/create/bitbucket-data-center | 139 ++++++++++ gcloud/builds/connections/create/help | 6 + .../builds/connections/update/bitbucket-cloud | 103 +++++++ .../connections/update/bitbucket-data-center | 104 +++++++ gcloud/builds/connections/update/help | 6 + gcloud/builds/triggers/create/bitbucket-cloud | 222 +++++++++++++++ .../triggers/create/bitbucket-data-center | 222 +++++++++++++++ gcloud/builds/triggers/create/help | 6 + gcloud/builds/triggers/update/bitbucket-cloud | 251 +++++++++++++++++ .../triggers/update/bitbucket-data-center | 252 +++++++++++++++++ gcloud/builds/triggers/update/help | 6 + .../dns-authorizations/create | 6 +- gcloud/composer/environments/create | 12 + gcloud/composer/environments/update | 15 + gcloud/compute/commitments/create | 2 +- gcloud/compute/firewall-policies/rules/create | 23 +- gcloud/compute/firewall-policies/rules/update | 23 +- gcloud/compute/images/export | 20 +- gcloud/compute/images/import | 20 +- gcloud/compute/instances/import | 20 +- gcloud/compute/machine-images/import | 20 +- .../network-firewall-policies/rules/create | 14 +- .../network-firewall-policies/rules/update | 14 +- gcloud/container/clusters/create | 30 +- gcloud/container/clusters/create-auto | 19 +- gcloud/container/clusters/update | 6 + .../container/fleet/memberships/bindings/list | 2 +- gcloud/container/fleet/scopes/help | 2 +- gcloud/container/fleet/scopes/list | 17 +- .../container/hub/memberships/bindings/list | 2 +- gcloud/container/hub/scopes/help | 2 +- gcloud/container/hub/scopes/list | 17 +- gcloud/container/node-pools/create | 14 +- gcloud/container/node-pools/update | 12 +- .../database-migration/migration-jobs/update | 16 +- gcloud/deploy/delivery-pipelines/describe | 4 +- gcloud/deploy/delivery-pipelines/help | 3 +- gcloud/emulators/firestore/start | 15 +- gcloud/functions/describe | 15 +- gcloud/functions/list | 13 +- gcloud/infra-manager/previews/export | 9 +- gcloud/recommender/insights/help | 2 +- gcloud/recommender/insights/list | 10 +- gcloud/recommender/recommendations/list | 8 +- gcloud/scc/help | 3 + gcloud/scc/manage/custom-modules/etd/create | 71 +++++ gcloud/scc/manage/custom-modules/etd/delete | 85 ++++++ gcloud/scc/manage/custom-modules/etd/describe | 83 ++++++ .../custom-modules/etd/describe-effective | 80 ++++++ gcloud/scc/manage/custom-modules/etd/help | 52 ++++ gcloud/scc/manage/custom-modules/etd/list | 92 +++++++ .../manage/custom-modules/etd/list-descendant | 94 +++++++ .../manage/custom-modules/etd/list-effective | 92 +++++++ gcloud/scc/manage/custom-modules/etd/update | 71 +++++ gcloud/scc/manage/custom-modules/etd/validate | 63 +++++ gcloud/scc/manage/custom-modules/help | 29 ++ gcloud/scc/manage/custom-modules/sha/create | 66 +++++ gcloud/scc/manage/custom-modules/sha/delete | 85 ++++++ gcloud/scc/manage/custom-modules/sha/describe | 83 ++++++ .../custom-modules/sha/describe-effective | 80 ++++++ gcloud/scc/manage/custom-modules/sha/help | 53 ++++ gcloud/scc/manage/custom-modules/sha/list | 103 +++++++ .../manage/custom-modules/sha/list-descendant | 94 +++++++ .../manage/custom-modules/sha/list-effective | 92 +++++++ gcloud/scc/manage/custom-modules/sha/simulate | 84 ++++++ gcloud/scc/manage/custom-modules/sha/update | 71 +++++ gcloud/scc/manage/help | 25 ++ gcloud/service-extensions/help | 30 ++ .../lb-route-extensions/delete | 75 +++++ .../lb-route-extensions/describe | 69 +++++ .../lb-route-extensions/help | 38 +++ .../lb-route-extensions/import | 86 ++++++ .../lb-route-extensions/list} | 42 +-- .../lb-traffic-extensions/delete | 75 +++++ .../lb-traffic-extensions/describe | 69 +++++ .../lb-traffic-extensions/help | 38 +++ .../lb-traffic-extensions/import | 86 ++++++ .../lb-traffic-extensions/list} | 42 +-- gcloud/sql/operations/list | 4 +- gcloud/storage/restore | 20 +- gcloud/vmware/network-peerings/create | 29 +- gcloud/vmware/network-peerings/delete | 22 +- gcloud/vmware/network-peerings/describe | 23 +- gcloud/vmware/network-peerings/list | 5 +- gcloud/vmware/network-peerings/routes/list | 25 +- gcloud/vmware/network-peerings/update | 22 +- .../private-clouds/logging-servers/create | 2 +- .../private-clouds/logging-servers/update | 2 +- gcloud/workbench/instances/help | 3 + gcloud/workbench/instances/resize-disk | 84 ++++++ 245 files changed, 9946 insertions(+), 513 deletions(-) create mode 100644 gcloud/alpha/audit-manager/audit-reports/generate create mode 100644 gcloud/alpha/audit-manager/audit-reports/help create mode 100644 gcloud/alpha/audit-manager/audit-scopes/generate create mode 100644 gcloud/alpha/audit-manager/audit-scopes/help create mode 100644 gcloud/alpha/audit-manager/enrollments/add create mode 100644 gcloud/alpha/audit-manager/enrollments/help create mode 100644 gcloud/alpha/audit-manager/help create mode 100644 gcloud/alpha/audit-manager/operations/describe create mode 100644 gcloud/alpha/audit-manager/operations/help create mode 100644 gcloud/alpha/builds/connections/create/bitbucket-cloud create mode 100644 gcloud/alpha/builds/connections/create/bitbucket-data-center create mode 100644 gcloud/alpha/builds/connections/update/bitbucket-cloud create mode 100644 gcloud/alpha/builds/connections/update/bitbucket-data-center create mode 100644 gcloud/alpha/builds/triggers/create/bitbucket-cloud create mode 100644 gcloud/alpha/builds/triggers/create/bitbucket-data-center create mode 100644 gcloud/alpha/builds/triggers/update/bitbucket-cloud create mode 100644 gcloud/alpha/builds/triggers/update/bitbucket-data-center create mode 100644 gcloud/alpha/container/binauthz/policy/evaluate create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/create create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/delete create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/describe create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/describe-effective create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/help create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/list create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/list-descendant create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/list-effective create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/update create mode 100644 gcloud/alpha/scc/manage/custom-modules/etd/validate create mode 100644 gcloud/alpha/scc/manage/custom-modules/help create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/create create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/delete create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/describe create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/describe-effective create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/help create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/list create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/list-descendant create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/list-effective create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/simulate create mode 100644 gcloud/alpha/scc/manage/custom-modules/sha/update create mode 100644 gcloud/alpha/scc/manage/help create mode 100644 gcloud/beta/builds/connections/create/bitbucket-cloud create mode 100644 gcloud/beta/builds/connections/create/bitbucket-data-center create mode 100644 gcloud/beta/builds/connections/update/bitbucket-cloud create mode 100644 gcloud/beta/builds/connections/update/bitbucket-data-center create mode 100644 gcloud/beta/builds/triggers/create/bitbucket-cloud create mode 100644 gcloud/beta/builds/triggers/create/bitbucket-data-center create mode 100644 gcloud/beta/builds/triggers/update/bitbucket-cloud create mode 100644 gcloud/beta/builds/triggers/update/bitbucket-data-center create mode 100644 gcloud/beta/container/binauthz/policy/evaluate create mode 100644 gcloud/builds/connections/create/bitbucket-cloud create mode 100644 gcloud/builds/connections/create/bitbucket-data-center create mode 100644 gcloud/builds/connections/update/bitbucket-cloud create mode 100644 gcloud/builds/connections/update/bitbucket-data-center create mode 100644 gcloud/builds/triggers/create/bitbucket-cloud create mode 100644 gcloud/builds/triggers/create/bitbucket-data-center create mode 100644 gcloud/builds/triggers/update/bitbucket-cloud create mode 100644 gcloud/builds/triggers/update/bitbucket-data-center create mode 100644 gcloud/scc/manage/custom-modules/etd/create create mode 100644 gcloud/scc/manage/custom-modules/etd/delete create mode 100644 gcloud/scc/manage/custom-modules/etd/describe create mode 100644 gcloud/scc/manage/custom-modules/etd/describe-effective create mode 100644 gcloud/scc/manage/custom-modules/etd/help create mode 100644 gcloud/scc/manage/custom-modules/etd/list create mode 100644 gcloud/scc/manage/custom-modules/etd/list-descendant create mode 100644 gcloud/scc/manage/custom-modules/etd/list-effective create mode 100644 gcloud/scc/manage/custom-modules/etd/update create mode 100644 gcloud/scc/manage/custom-modules/etd/validate create mode 100644 gcloud/scc/manage/custom-modules/help create mode 100644 gcloud/scc/manage/custom-modules/sha/create create mode 100644 gcloud/scc/manage/custom-modules/sha/delete create mode 100644 gcloud/scc/manage/custom-modules/sha/describe create mode 100644 gcloud/scc/manage/custom-modules/sha/describe-effective create mode 100644 gcloud/scc/manage/custom-modules/sha/help create mode 100644 gcloud/scc/manage/custom-modules/sha/list create mode 100644 gcloud/scc/manage/custom-modules/sha/list-descendant create mode 100644 gcloud/scc/manage/custom-modules/sha/list-effective create mode 100644 gcloud/scc/manage/custom-modules/sha/simulate create mode 100644 gcloud/scc/manage/custom-modules/sha/update create mode 100644 gcloud/scc/manage/help create mode 100644 gcloud/service-extensions/help create mode 100644 gcloud/service-extensions/lb-route-extensions/delete create mode 100644 gcloud/service-extensions/lb-route-extensions/describe create mode 100644 gcloud/service-extensions/lb-route-extensions/help create mode 100644 gcloud/service-extensions/lb-route-extensions/import rename gcloud/{alpha/apphub/discovered-services/find => service-extensions/lb-route-extensions/list} (70%) create mode 100644 gcloud/service-extensions/lb-traffic-extensions/delete create mode 100644 gcloud/service-extensions/lb-traffic-extensions/describe create mode 100644 gcloud/service-extensions/lb-traffic-extensions/help create mode 100644 gcloud/service-extensions/lb-traffic-extensions/import rename gcloud/{alpha/apphub/discovered-workloads/find => service-extensions/lb-traffic-extensions/list} (69%) create mode 100644 gcloud/workbench/instances/resize-disk diff --git a/gcloud/_version b/gcloud/_version index b701fcb7a..12721b15b 100644 --- a/gcloud/_version +++ b/gcloud/_version @@ -1,8 +1,8 @@ -Google Cloud SDK 464.0.0 -alpha 2024.02.09 -beta 2024.02.09 +Google Cloud SDK 465.0.0 +alpha 2024.02.16 +beta 2024.02.16 bq 2.0.101 bundled-python3-unix 3.11.7 -core 2024.02.09 +core 2024.02.16 gcloud-crc32c 1.0.0 gsutil 5.27 diff --git a/gcloud/ai/indexes/upsert-datapoints b/gcloud/ai/indexes/upsert-datapoints index 65ba3e65a..fa0229008 100644 --- a/gcloud/ai/indexes/upsert-datapoints +++ b/gcloud/ai/indexes/upsert-datapoints @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud ai indexes upsert-datapoints (INDEX : --region=REGION) - --datapoints-from-file=DATAPOINTS_FROM_FILE [GCLOUD_WIDE_FLAG ...] + --datapoints-from-file=DATAPOINTS_FROM_FILE + [--update-mask=[UPDATE_MASK_PATH,...]] [GCLOUD_WIDE_FLAG ...] EXAMPLES To upsert datapoints into an index '123', run: @@ -51,6 +52,17 @@ REQUIRED FLAGS Path to a local JSON file that contains the data points that need to be added to the index. +OPTIONAL FLAGS + --update-mask=[UPDATE_MASK_PATH,...] + Update mask is used to specify the fields to be overwritten in the + datapoints by the update. The fields specified in the update_mask are + relative to each IndexDatapoint inside datapoints, not the full + request. + + Updatable fields: + ◆ Use --update-mask=all_restricts to update both restricts and + numeric_restricts. + 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/ai/indexes/upsert-datapoints b/gcloud/alpha/ai/indexes/upsert-datapoints index 8666f019d..3e31c11ad 100644 --- a/gcloud/alpha/ai/indexes/upsert-datapoints +++ b/gcloud/alpha/ai/indexes/upsert-datapoints @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud alpha ai indexes upsert-datapoints (INDEX : --region=REGION) - --datapoints-from-file=DATAPOINTS_FROM_FILE [GCLOUD_WIDE_FLAG ...] + --datapoints-from-file=DATAPOINTS_FROM_FILE + [--update-mask=[UPDATE_MASK_PATH,...]] [GCLOUD_WIDE_FLAG ...] EXAMPLES To upsert datapoints into an index 123, run: @@ -51,6 +52,17 @@ REQUIRED FLAGS Path to a local JSON file that contains the data points that need to be added to the index. +OPTIONAL FLAGS + --update-mask=[UPDATE_MASK_PATH,...] + Update mask is used to specify the fields to be overwritten in the + datapoints by the update. The fields specified in the update_mask are + relative to each IndexDatapoint inside datapoints, not the full + request. + + Updatable fields: + ◆ Use --update-mask=all_restricts to update both restricts and + numeric_restricts. + 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/apphub/discovered-services/help b/gcloud/alpha/apphub/discovered-services/help index 553477367..a1315a5ff 100644 --- a/gcloud/alpha/apphub/discovered-services/help +++ b/gcloud/alpha/apphub/discovered-services/help @@ -19,10 +19,6 @@ COMMANDS describe (ALPHA) Describe an Apphub discovered service. - find - (ALPHA) Find Apphub discovered services that could be added to an - application. - find-unregistered (ALPHA) List unregistered Apphub discovered services. diff --git a/gcloud/alpha/apphub/discovered-workloads/help b/gcloud/alpha/apphub/discovered-workloads/help index 658210684..48370a266 100644 --- a/gcloud/alpha/apphub/discovered-workloads/help +++ b/gcloud/alpha/apphub/discovered-workloads/help @@ -19,10 +19,6 @@ COMMANDS describe (ALPHA) Describe an Apphub discovered workload. - find - (ALPHA) Find discovered Apphub workloads that could be added to an - application. - find-unregistered (ALPHA) List unregistered Apphub discovered workloads. diff --git a/gcloud/alpha/audit-manager/audit-reports/generate b/gcloud/alpha/audit-manager/audit-reports/generate new file mode 100644 index 000000000..23d5c460d --- /dev/null +++ b/gcloud/alpha/audit-manager/audit-reports/generate @@ -0,0 +1,60 @@ +NAME + gcloud alpha audit-manager audit-reports generate - generate Audit Report + +SYNOPSIS + gcloud alpha audit-manager audit-reports generate + --compliance-standard=COMPLIANCE_STANDARD --gcs-uri=GCS_URI + --location=LOCATION --report-format=REPORT_FORMAT + (--folder=FOLDER | --project=PROJECT) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Generate a new Audit Report. + +EXAMPLES + To generate an Audit Report in the us-central1 region, for a project with + ID 123 for compliance standard fedramp_moderate in odf format and store it + in gs://testbucketauditmanager bucket, run: + + $ gcloud alpha audit-manager audit-reports generate --project=123 \ + --location=us-central1 --compliance-standard=fedramp_moderate \ + --report-format=odf --gcs-uri=gs://testbucketauditmanager + +REQUIRED FLAGS + --compliance-standard=COMPLIANCE_STANDARD + Compliance Standard against which the Report must be generated. Eg: + FEDRAMP_MODERATE + + --gcs-uri=GCS_URI + Destination Cloud storage bucket where report and evidence must be + uploaded. The Cloud storage bucket provided here must be selected among + the buckets entered during the enrollment process. + + --location=LOCATION + The location where the report should be generated. + + --report-format=REPORT_FORMAT + The format in which the audit report should be created. REPORT_FORMAT + must be (only one value is supported): odf. + + Exactly one of these must be specified: + + --folder=FOLDER + Folder Id for which to generate audit report + + --project=PROJECT + Project Id for which to generate audit report + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/audit-manager/audit-reports/help b/gcloud/alpha/audit-manager/audit-reports/help new file mode 100644 index 000000000..d00b36f07 --- /dev/null +++ b/gcloud/alpha/audit-manager/audit-reports/help @@ -0,0 +1,27 @@ +NAME + gcloud alpha audit-manager audit-reports - command group for Audit Manager + Audit Reports + +SYNOPSIS + gcloud alpha audit-manager audit-reports COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Command group for Audit Manager Audit Reports. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + generate + (ALPHA) Generate Audit Report. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/audit-manager/audit-scopes/generate b/gcloud/alpha/audit-manager/audit-scopes/generate new file mode 100644 index 000000000..4a8673658 --- /dev/null +++ b/gcloud/alpha/audit-manager/audit-scopes/generate @@ -0,0 +1,64 @@ +NAME + gcloud alpha audit-manager audit-scopes generate - generate Audit Scope + +SYNOPSIS + gcloud alpha audit-manager audit-scopes generate + --compliance-standard=COMPLIANCE_STANDARD --location=LOCATION + --output-file-name=OUTPUT_FILE_NAME --report-format=REPORT_FORMAT + (--folder=FOLDER | --project=PROJECT) + [--output-directory=OUTPUT_DIRECTORY] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Generate a new Audit Scope. + +EXAMPLES + To generate an Audit Scope in the us-central1 region, for a project with ID + 123 for compliance standard fedramp_moderate in odf format, run: + + $ gcloud alpha audit-manager audit-scopes generate --project="123" \ + --location="us-central1" \ + --compliance-standard="fedramp_moderate" --report-format="odf" \ + --output-directory="scopes/currentyear" \ + --output-file-name="auditreport" + +REQUIRED FLAGS + --compliance-standard=COMPLIANCE_STANDARD + Compliance Standard against which the Report must be generated. Eg: + FEDRAMP_MODERATE + + --location=LOCATION + The location where the scope should be generated. + + --output-file-name=OUTPUT_FILE_NAME + The name by while scope report should be created . + + --report-format=REPORT_FORMAT + The format in which the audit scope report should be created. + REPORT_FORMAT must be (only one value is supported): odf. + + Exactly one of these must be specified: + + --folder=FOLDER + Folder Id for which to generate audit scope + + --project=PROJECT + Project Id for which to generate audit scope + +OPTIONAL FLAGS + --output-directory=OUTPUT_DIRECTORY + The directory path where the scope report should be created . + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/audit-manager/audit-scopes/help b/gcloud/alpha/audit-manager/audit-scopes/help new file mode 100644 index 000000000..69b30219d --- /dev/null +++ b/gcloud/alpha/audit-manager/audit-scopes/help @@ -0,0 +1,27 @@ +NAME + gcloud alpha audit-manager audit-scopes - command group for Audit Manager + Audit Scopes + +SYNOPSIS + gcloud alpha audit-manager audit-scopes COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Command group for Audit Manager Audit Scopes. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + generate + (ALPHA) Generate Audit Scope. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/audit-manager/enrollments/add b/gcloud/alpha/audit-manager/enrollments/add new file mode 100644 index 000000000..d1d31576f --- /dev/null +++ b/gcloud/alpha/audit-manager/enrollments/add @@ -0,0 +1,49 @@ +NAME + gcloud alpha audit-manager enrollments add - enroll a new scope + +SYNOPSIS + gcloud alpha audit-manager enrollments add --eligible-gcs-buckets=BUCKET + URI,[BUCKET URI,...] --location=LOCATION + (--folder=FOLDER | --project=PROJECT) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Enroll a new scope. + +EXAMPLES + To enroll a project with ID 123 in the us-central1 region with + gs://test-bucket-1 and gs://my-bucket-2 as eligible storage buckets, run: + + $ gcloud alpha audit-manager enrollments add --project=123 \ + --location=us-central1 \ + --eligible-gcs-buckets="gs://test-bucket-1,gs://my-bucket-2" + +REQUIRED FLAGS + --eligible-gcs-buckets=BUCKET URI,[BUCKET URI,...] + Eligible cloud storage buckets where report and evidence can be + uploaded. + + --location=LOCATION + The location where to enroll. + + Exactly one of these must be specified: + + --folder=FOLDER + Folder Id to enroll + + --project=PROJECT + Project Id to enroll + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/audit-manager/enrollments/help b/gcloud/alpha/audit-manager/enrollments/help new file mode 100644 index 000000000..a7fa6e0d0 --- /dev/null +++ b/gcloud/alpha/audit-manager/enrollments/help @@ -0,0 +1,27 @@ +NAME + gcloud alpha audit-manager enrollments - command group for Audit Manager + Enrollments + +SYNOPSIS + gcloud alpha audit-manager enrollments COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Command group for Audit Manager Enrollments. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + add + (ALPHA) Enroll a new scope. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/audit-manager/help b/gcloud/alpha/audit-manager/help new file mode 100644 index 000000000..6d1e82a47 --- /dev/null +++ b/gcloud/alpha/audit-manager/help @@ -0,0 +1,36 @@ +NAME + gcloud alpha audit-manager - enroll resources, audit workloads and generate + reports + +SYNOPSIS + gcloud alpha audit-manager GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Enroll resources, audit workloads and generate reports. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + audit-reports + (ALPHA) Command group for Audit Manager Audit Reports. + + audit-scopes + (ALPHA) Command group for Audit Manager Audit Scopes. + + enrollments + (ALPHA) Command group for Audit Manager Enrollments. + + operations + (ALPHA) Check audit operation status. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/audit-manager/operations/describe b/gcloud/alpha/audit-manager/operations/describe new file mode 100644 index 000000000..62336b95a --- /dev/null +++ b/gcloud/alpha/audit-manager/operations/describe @@ -0,0 +1,74 @@ +NAME + gcloud alpha audit-manager operations describe - describe Audit operation + +SYNOPSIS + gcloud alpha audit-manager operations describe + (OPERATION : --folder=FOLDER --location=LOCATION) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Obtain details about an audit operation. + +EXAMPLES + To describe an Audit operation in the us-central1 region, belonging to a + project with ID 123, with operation ID operation-456, run: + + $ gcloud alpha audit-manager operations describe operation-456 \ + --project=123 --location=us-central1 + +POSITIONAL ARGUMENTS + Operation resource - The arguments in this group can be used to specify + the attributes of this resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument operation on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. This resource can be one of the + following types: [auditmanager.folders.locations.operationIds, + auditmanager.projects.locations.operationIds]. + + This must be specified. + + OPERATION + ID of the operation or fully qualified identifier for the operation. + + To set the operation attribute: + ▸ provide the argument operation on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --folder=FOLDER + The folder for the operation. + + To set the folder attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --folder on the command line. Must be + specified for resource of type + [auditmanager.folders.locations.operationIds]. + + --location=LOCATION + The location for the operation. + + To set the location attribute: + ▸ provide the argument operation on the command line with a fully + specified name; + ▸ provide the argument --location on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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/audit-manager/operations/help b/gcloud/alpha/audit-manager/operations/help new file mode 100644 index 000000000..a24634162 --- /dev/null +++ b/gcloud/alpha/audit-manager/operations/help @@ -0,0 +1,26 @@ +NAME + gcloud alpha audit-manager operations - check audit operation status + +SYNOPSIS + gcloud alpha audit-manager operations COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Check audit operation status. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + describe + (ALPHA) Describe Audit operation. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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/builds/connections/create/bitbucket-cloud b/gcloud/alpha/builds/connections/create/bitbucket-cloud new file mode 100644 index 000000000..85f9d1a1c --- /dev/null +++ b/gcloud/alpha/builds/connections/create/bitbucket-cloud @@ -0,0 +1,111 @@ +NAME + gcloud alpha builds connections create bitbucket-cloud - create a Cloud + Build Connection for Bitbucket Cloud + +SYNOPSIS + gcloud alpha builds connections create bitbucket-cloud + (CONNECTION : --region=REGION) + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + --workspace=WORKSPACE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Build Connection for Bitbucket Cloud. + + A Bitbucket Cloud Connection can be created by using a + repository/project/workspace access token with + repository_read,repository_admin, pullrequest_read, webhook scope + permission and a repository/project/workspace access token with + repository_read scope permission. + +EXAMPLES + To create a Bitbucket Cloud connection, provide all the required + parameters: + + $ gcloud alpha builds connections create bitbucket-cloud \ + my-bitbucket-conn --project=myproj --region=us-central1 \ + --workspace=my-workspace \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection to create. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read,repository_admin, + pullrequest_read, webhook repository/project/workspace access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read repository/project/workspace + access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Cloud. + + --workspace=WORKSPACE + Workspace of the Bitbucket Cloud instance. + +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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud builds connections create bitbucket-cloud + + $ gcloud beta builds connections create bitbucket-cloud + diff --git a/gcloud/alpha/builds/connections/create/bitbucket-data-center b/gcloud/alpha/builds/connections/create/bitbucket-data-center new file mode 100644 index 000000000..206917e69 --- /dev/null +++ b/gcloud/alpha/builds/connections/create/bitbucket-data-center @@ -0,0 +1,142 @@ +NAME + gcloud alpha builds connections create bitbucket-data-center - create a + Cloud Build Connection for Bitbucket Data Center + +SYNOPSIS + gcloud alpha builds connections create bitbucket-data-center + (CONNECTION : --region=REGION) + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION [--async] + [--host-uri=HOST_URI] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE + : --ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a Cloud Build Connection for Bitbucket Data Center. + + A Bitbucket Data Center Connection can be created by using a personal + access token with REPO_ADMIN scope permission. A REPO_READ scoped personal + access token will also be required. + + If the Bitbucket Data Center can only be accessed within a VPC, a Service + Directory service resource can be provided for connecting to it. + +EXAMPLES + To create a Bitbucket Data Center connection, provide all the required + parameters: + + $ gcloud alpha builds connections create bitbucket-data-center \ + my-bitbucket-conn --project=myproj --region=us-central1 \ + --host-uri=https://bitbucket-server.net \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + + To create a Bitbucket Data Center connection for a private Bitbucket Data + Center server. Provide the service-directory-service and ssl-ca-file as + well: + + $ gcloud alpha builds connections create bitbucket-data-center \ + my-private-bitbucket-conn \ + --host-uri=https://my.private-bitbucket-server.net \ + --project=myproj --region=us-central1 \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds --ssl-ca-file=mycertificate.crt \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection to create. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_ADMIN personal access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_READ personal access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Data Center. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --host-uri=HOST_URI + URI of the Bitbucket Data Center instance. + + Group of arguments for configuring access through Service Directory. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the Bitbucket + Data Center. Necessary only if the server has no public access from + the internet. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --ssl-ca-file=SSL_CA_FILE + File containing the SSL_CA to be used. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud builds connections create bitbucket-data-center + + $ gcloud beta builds connections create bitbucket-data-center + diff --git a/gcloud/alpha/builds/connections/create/help b/gcloud/alpha/builds/connections/create/help index c5827bdbc..f7a765aa7 100644 --- a/gcloud/alpha/builds/connections/create/help +++ b/gcloud/alpha/builds/connections/create/help @@ -16,6 +16,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (ALPHA) Create a Cloud Build Connection for Bitbucket Cloud. + + bitbucket-data-center + (ALPHA) Create a Cloud Build Connection for Bitbucket Data Center. + github (ALPHA) Create a Cloud Build Connection of type GitHub. diff --git a/gcloud/alpha/builds/connections/update/bitbucket-cloud b/gcloud/alpha/builds/connections/update/bitbucket-cloud new file mode 100644 index 000000000..53493e57a --- /dev/null +++ b/gcloud/alpha/builds/connections/update/bitbucket-cloud @@ -0,0 +1,106 @@ +NAME + gcloud alpha builds connections update bitbucket-cloud - update a Cloud + Build Connection of type Bitbucket Cloud + +SYNOPSIS + gcloud alpha builds connections update bitbucket-cloud + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [--read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION] + [--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION] + [--workspace=WORKSPACE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud Build Connection of type Bitbucket Cloud. + +EXAMPLES + To update the workspace, provide the connection name and the workspace + name: + + $ gcloud alpha builds connections update bitbucket-cloud \ + my-bbc-conn --region=us-west1 --workspace=my-workspace + + To update the authorization token, provide the connection name and the new + authorization token secret version. + + $ gcloud alpha builds connections update bitbucket-cloud \ + my-bbc-conn --region=us-west1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection 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 connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read,repository_admin, + pullrequest_read, webhook access token. It can be a repository, project + or workspace access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read access token. It can be a + repository, project or workspace access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Cloud. + + --workspace=WORKSPACE + Workspace of the Bitbucket Cloud instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud builds connections update bitbucket-cloud + + $ gcloud beta builds connections update bitbucket-cloud + diff --git a/gcloud/alpha/builds/connections/update/bitbucket-data-center b/gcloud/alpha/builds/connections/update/bitbucket-data-center new file mode 100644 index 000000000..e6290af47 --- /dev/null +++ b/gcloud/alpha/builds/connections/update/bitbucket-data-center @@ -0,0 +1,107 @@ +NAME + gcloud alpha builds connections update bitbucket-data-center - update a + Cloud Build Connection of type Bitbucket Data Center + +SYNOPSIS + gcloud alpha builds connections update bitbucket-data-center + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [--host-uri=HOST_URI] + [--read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE] + [--ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Update a Cloud Build Connection of type Bitbucket Data Center. + +EXAMPLES + To update the ssl_ca, provide the connection name and the ssl_ca file: + + $ gcloud alpha builds connections update bitbucket-data-center \ + my-gle-conn --region=us-west1 --ssl-ca-file=mycertificate.crt + + To update the authorization token, provide the connection name and the new + authorization token secret version name. + + $ gcloud alpha builds connections update bitbucket-data-center \ + my-gle-conn --region=us-west1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection 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 connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_ADMIN personal access token. + + --host-uri=HOST_URI + URI of the Bitbucket Data Center instance. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_READ personal access token. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the Bitbucket + Data Center. Necessary only if the server has no public access from the + internet. + + --ssl-ca-file=SSL_CA_FILE + File containing the SSL_CA to be used. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. These variants are also available: + + $ gcloud builds connections update bitbucket-data-center + + $ gcloud beta builds connections update bitbucket-data-center + diff --git a/gcloud/alpha/builds/connections/update/help b/gcloud/alpha/builds/connections/update/help index e9d72fc2f..11dce4625 100644 --- a/gcloud/alpha/builds/connections/update/help +++ b/gcloud/alpha/builds/connections/update/help @@ -16,6 +16,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (ALPHA) Update a Cloud Build Connection of type Bitbucket Cloud. + + bitbucket-data-center + (ALPHA) Update a Cloud Build Connection of type Bitbucket Data Center. + github (ALPHA) Update a Cloud Build Connection of type GitHub. diff --git a/gcloud/alpha/builds/triggers/create/bitbucket-cloud b/gcloud/alpha/builds/triggers/create/bitbucket-cloud new file mode 100644 index 000000000..39e926bcf --- /dev/null +++ b/gcloud/alpha/builds/triggers/create/bitbucket-cloud @@ -0,0 +1,225 @@ +NAME + gcloud alpha builds triggers create bitbucket-cloud - create a build + trigger for a 2nd-gen Bitbucket Cloud repository + +SYNOPSIS + gcloud alpha builds triggers create bitbucket-cloud + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR; default="/"]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a build trigger for a 2nd-gen Bitbucket Cloud repository. + +EXAMPLES + To create a push trigger with a 2nd-gen repository for all branches: + + $ gcloud alpha builds triggers create bitbucket-cloud \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" --region=us-central1 + + To create a pull request trigger with a 2nd-gen repository for main: + + $ gcloud alpha builds triggers create bitbucket-cloud \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --build-config="cloudbuild.yaml" \ + --pull-request-pattern="^main$" --region=us-central1 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. Note: Region must be specified in 2nd gen repo; global is + not supported. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. For + example: + + $ gcloud alpha builds triggers create bitbucket-cloud ... \ + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Substitutions can be applied to user-defined variables (starting + with an underscore) and to the following built-in variables: + REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, + SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers create bitbucket-cloud + + $ gcloud beta builds triggers create bitbucket-cloud + diff --git a/gcloud/alpha/builds/triggers/create/bitbucket-data-center b/gcloud/alpha/builds/triggers/create/bitbucket-data-center new file mode 100644 index 000000000..c9893eebc --- /dev/null +++ b/gcloud/alpha/builds/triggers/create/bitbucket-data-center @@ -0,0 +1,226 @@ +NAME + gcloud alpha builds triggers create bitbucket-data-center - create a build + trigger for a 2nd-gen Bitbucket Data Center repository + +SYNOPSIS + gcloud alpha builds triggers create bitbucket-data-center + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR; default="/"]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Create a build trigger for a 2nd-gen Bitbucket Data Center + repository. + +EXAMPLES + To create a push trigger with a 2nd-gen repository for all branches: + + $ gcloud alpha builds triggers create bitbucket-data-center \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" --region=us-central1 + + To create a pull request trigger with a 2nd-gen repository for main: + + $ gcloud alpha builds triggers create bitbucket-data-center \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --build-config="cloudbuild.yaml" \ + --pull-request-pattern="^main$" --region=us-central1 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. Note: Region must be specified in 2nd gen repo; global is + not supported. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. For + example: + + $ gcloud alpha builds triggers create bitbucket-data-center ... \ + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Substitutions can be applied to user-defined variables (starting + with an underscore) and to the following built-in variables: + REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, + SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers create bitbucket-data-center + + $ gcloud beta builds triggers create bitbucket-data-center + diff --git a/gcloud/alpha/builds/triggers/create/help b/gcloud/alpha/builds/triggers/create/help index 3de891bc8..c3b35f643 100644 --- a/gcloud/alpha/builds/triggers/create/help +++ b/gcloud/alpha/builds/triggers/create/help @@ -16,6 +16,14 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (ALPHA) Create a build trigger for a 2nd-gen Bitbucket Cloud + repository. + + bitbucket-data-center + (ALPHA) Create a build trigger for a 2nd-gen Bitbucket Data Center + repository. + bitbucketserver (ALPHA) Create a build trigger for a Bitbucket Server repository. diff --git a/gcloud/alpha/builds/triggers/update/bitbucket-cloud b/gcloud/alpha/builds/triggers/update/bitbucket-cloud new file mode 100644 index 000000000..7e16fbff1 --- /dev/null +++ b/gcloud/alpha/builds/triggers/update/bitbucket-cloud @@ -0,0 +1,255 @@ +NAME + gcloud alpha builds triggers update bitbucket-cloud - updates Bitbucket + Cloud trigger used by Cloud Build + +SYNOPSIS + gcloud alpha builds triggers update bitbucket-cloud + (TRIGGER : --region=REGION) + (--trigger-config=PATH | --description=DESCRIPTION + --ignored-files=[GLOB,...] --included-files=[GLOB,...] + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --branch-pattern=REGEX + | --tag-pattern=REGEX | --comment-control=COMMENT_CONTROL + --pull-request-pattern=REGEX --build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR] --clear-substitutions + | --remove-substitutions=[KEY,...] + | --update-substitutions=[KEY=VALUE,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Updates Bitbucket Cloud trigger used by Cloud Build. + +EXAMPLES + To update the branch pattern of the trigger: + + $ gcloud alpha builds triggers update bitbucket-cloud my-trigger \ + --branch-pattern=".*" + + To update the build config of the trigger: + + $ gcloud alpha builds triggers update bitbucket-cloud my-trigger \ + --build-config="cloudbuild.yaml" + + To update the substitutions of the trigger: + + $ gcloud alpha builds triggers update bitbucket-cloud my-trigger \ + --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master + + To update the 2nd-gen repository resource of the trigger: + + $ gcloud alpha builds triggers update bitbucket-cloud my-trigger \ + --repository=projects/my-project/locations/us-west1/\ + connections/my-conn/repositories/my-repo + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument TRIGGER on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. + + To set the trigger attribute: + ▸ provide the argument TRIGGER on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Cloud location for the trigger. + + To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + At most one of these can be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --comment-control=COMMENT_CONTROL + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regular expression search for the + base branch (the branch you are trying to merge into) for pull + request updates. For example, --pull-request-pattern=foo will + match "foo", "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + At most one of these can be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + At most one of these can be specified: + + --clear-substitutions + Clear existing substitutions. + + --remove-substitutions=[KEY,...] + Remove existing substitutions if present. + + --update-substitutions=[KEY=VALUE,...] + Update or add to existing substitutions. Substitutions are + parameters to be substituted or add in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers update ... + --update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will add the provided substitutions to the existing + substitutions and results in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/build-config-file-schema#substitutions + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers update bitbucket-cloud + + $ gcloud beta builds triggers update bitbucket-cloud + diff --git a/gcloud/alpha/builds/triggers/update/bitbucket-data-center b/gcloud/alpha/builds/triggers/update/bitbucket-data-center new file mode 100644 index 000000000..e4ceee977 --- /dev/null +++ b/gcloud/alpha/builds/triggers/update/bitbucket-data-center @@ -0,0 +1,257 @@ +NAME + gcloud alpha builds triggers update bitbucket-data-center - updates + Bitbucket Data Center trigger used by Cloud Build + +SYNOPSIS + gcloud alpha builds triggers update bitbucket-data-center + (TRIGGER : --region=REGION) + (--trigger-config=PATH | --description=DESCRIPTION + --ignored-files=[GLOB,...] --included-files=[GLOB,...] + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --branch-pattern=REGEX + | --tag-pattern=REGEX | --comment-control=COMMENT_CONTROL + --pull-request-pattern=REGEX --build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR] --clear-substitutions + | --remove-substitutions=[KEY,...] + | --update-substitutions=[KEY=VALUE,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Updates Bitbucket Data Center trigger used by Cloud Build. + +EXAMPLES + To update the branch pattern of the trigger: + + $ gcloud alpha builds triggers update bitbucket-data-center \ + my-trigger --branch-pattern=".*" + + To update the build config of the trigger: + + $ gcloud alpha builds triggers update bitbucket-data-center \ + my-trigger --build-config="cloudbuild.yaml" + + To update the substitutions of the trigger: + + $ gcloud alpha builds triggers update bitbucket-data-center \ + my-trigger \ + --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master + + To update the 2nd-gen repository resource of the trigger: + + $ gcloud alpha builds triggers update bitbucket-data-center \ + my-trigger \ + --repository=projects/my-project/locations/us-west1/\ + connections/my-conn/repositories/my-repo + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument TRIGGER on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. + + To set the trigger attribute: + ▸ provide the argument TRIGGER on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Cloud location for the trigger. + + To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + At most one of these can be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --comment-control=COMMENT_CONTROL + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regular expression search for the + base branch (the branch you are trying to merge into) for pull + request updates. For example, --pull-request-pattern=foo will + match "foo", "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + At most one of these can be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + At most one of these can be specified: + + --clear-substitutions + Clear existing substitutions. + + --remove-substitutions=[KEY,...] + Remove existing substitutions if present. + + --update-substitutions=[KEY=VALUE,...] + Update or add to existing substitutions. Substitutions are + parameters to be substituted or add in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers update ... + --update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will add the provided substitutions to the existing + substitutions and results in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/build-config-file-schema#substitutions + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers update bitbucket-data-center + + $ gcloud beta builds triggers update bitbucket-data-center + diff --git a/gcloud/alpha/builds/triggers/update/help b/gcloud/alpha/builds/triggers/update/help index d44c7b85b..02d1fb39f 100644 --- a/gcloud/alpha/builds/triggers/update/help +++ b/gcloud/alpha/builds/triggers/update/help @@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (ALPHA) Updates Bitbucket Cloud trigger used by Cloud Build. + + bitbucket-data-center + (ALPHA) Updates Bitbucket Data Center trigger used by Cloud Build. + bitbucketserver (ALPHA) Updates Bitbucket Server trigger used by Cloud Build. diff --git a/gcloud/alpha/certificate-manager/dns-authorizations/create b/gcloud/alpha/certificate-manager/dns-authorizations/create index a4f3ea3c5..1f4d08841 100644 --- a/gcloud/alpha/certificate-manager/dns-authorizations/create +++ b/gcloud/alpha/certificate-manager/dns-authorizations/create @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud alpha certificate-manager dns-authorizations create (DNS_AUTHORIZATION : --location=LOCATION) --domain=DOMAIN [--async] - [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--type=TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -70,6 +70,10 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. + --type=TYPE + Type of the DNS authorization. TYPE must be one of: fixed-record, + per-project-record, type-unspecified. + 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/composer/environments/create b/gcloud/alpha/composer/environments/create index c1d459b52..f8e9454ba 100644 --- a/gcloud/alpha/composer/environments/create +++ b/gcloud/alpha/composer/environments/create @@ -388,10 +388,12 @@ FLAGS At most one of these can be specified: --disable-cloud-data-lineage-integration - Disable Cloud Data Lineage integration. + Disable Cloud Data Lineage integration, supported for Composer 2 + Environments. --enable-cloud-data-lineage-integration - Enable Cloud Data Lineage integration. + Enable Cloud Data Lineage integration, supported for Composer 2 + Environments. Master Authorized Networks configuration diff --git a/gcloud/alpha/composer/environments/update b/gcloud/alpha/composer/environments/update index 71db57847..b1fbd7a42 100644 --- a/gcloud/alpha/composer/environments/update +++ b/gcloud/alpha/composer/environments/update @@ -170,10 +170,12 @@ REQUIRED FLAGS At most one of these can be specified: --disable-cloud-data-lineage-integration - Disable Cloud Data Lineage integration. + Disable Cloud Data Lineage integration, supported for Composer 2 + Environments. --enable-cloud-data-lineage-integration - Enable Cloud Data Lineage integration. + Enable Cloud Data Lineage integration, supported for Composer 2 + Environments. Group of arguments for setting master authorized networks configuration. diff --git a/gcloud/alpha/compute/commitments/create b/gcloud/alpha/compute/commitments/create index ae6c874d1..9af9b8f83 100644 --- a/gcloud/alpha/compute/commitments/create +++ b/gcloud/alpha/compute/commitments/create @@ -104,7 +104,7 @@ OPTIONAL FLAGS compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, general-purpose-e2, general-purpose-n2, general-purpose-n2d, general-purpose-t2d, graphics-optimized, - memory-optimized, memory-optimized-m3. + memory-optimized, memory-optimized-m3, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/alpha/compute/images/export b/gcloud/alpha/compute/images/export index 40bb443df..ac2483c59 100644 --- a/gcloud/alpha/compute/images/export +++ b/gcloud/alpha/compute/images/export @@ -53,22 +53,22 @@ OPTIONAL FLAGS complete. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/alpha/compute/images/import b/gcloud/alpha/compute/images/import index 429df1551..fe9fb71ad 100644 --- a/gcloud/alpha/compute/images/import +++ b/gcloud/alpha/compute/images/import @@ -147,22 +147,22 @@ OPTIONAL FLAGS complete. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/alpha/compute/instance-groups/managed/create b/gcloud/alpha/compute/instance-groups/managed/create index 93f0cf9cc..76eb0427d 100644 --- a/gcloud/alpha/compute/instance-groups/managed/create +++ b/gcloud/alpha/compute/instance-groups/managed/create @@ -8,8 +8,9 @@ SYNOPSIS [--default-action-on-vm-failure=ACTION_ON_VM_FAILURE] [--description=DESCRIPTION] [--[no-]force-update-on-repair] [--initial-delay=INITIAL_DELAY] [--instance-redistribution-type=TYPE] + [--instance-selection=name=NAME, + machine-type=MACHINE_TYPE[,machine-type=MACHINE_TYPE...][,rank=RANK]] [--instance-selection-machine-types=[MACHINE_TYPE,...]] - [--instance-selection-secondary-machine-types=[MACHINE_TYPE,...]] [--list-managed-instances-results=MODE] [--resource-manager-tags=[KEY=VALUE,...]] [--standby-policy-initial-delay=STANDBY_POLICY_INITIAL_DELAY] @@ -133,16 +134,15 @@ OPTIONAL FLAGS The managed instance group proactively redistributes instances to meet its target distribution. + --instance-selection=name=NAME,machine-type=MACHINE_TYPE[,machine-type=MACHINE_TYPE...][,rank=RANK] + Named selection of machine types with an optional rank. eg. + --instance-selection="name=instance-selection-1,machine-type=e2-standard-8,machine-type=t2d-standard-8,rank=0" + --instance-selection-machine-types=[MACHINE_TYPE,...] Primary machine types to use for the Compute Engine instances that will be created with the managed instance group. If not provided, machine type specified in the instance template will be used. - --instance-selection-secondary-machine-types=[MACHINE_TYPE,...] - Secondary machine types to use for the Compute Engine instances that - will be created with the managed instance group. If not provided, - machine type specified in the instance template will be used. - --list-managed-instances-results=MODE Pagination behavior for the group's listManagedInstances API method. This flag does not affect the group's gcloud or console list-instances diff --git a/gcloud/alpha/compute/instances/import b/gcloud/alpha/compute/instances/import index b72de0623..5faf4fe53 100644 --- a/gcloud/alpha/compute/instances/import +++ b/gcloud/alpha/compute/instances/import @@ -91,22 +91,22 @@ OPTIONAL FLAGS non-matching destination or source IP addresses. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/alpha/compute/machine-images/import b/gcloud/alpha/compute/machine-images/import index aa3c3554d..2d3a302f4 100644 --- a/gcloud/alpha/compute/machine-images/import +++ b/gcloud/alpha/compute/machine-images/import @@ -90,22 +90,22 @@ OPTIONAL FLAGS addresses. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/alpha/container/binauthz/policy/evaluate b/gcloud/alpha/container/binauthz/policy/evaluate new file mode 100644 index 000000000..211813e8f --- /dev/null +++ b/gcloud/alpha/container/binauthz/policy/evaluate @@ -0,0 +1,80 @@ +NAME + gcloud alpha container binauthz policy evaluate - evaluate a Binary + Authorization platform policy + +SYNOPSIS + gcloud alpha container binauthz policy evaluate + (POLICY_RESOURCE_NAME : --platform=PLATFORM) + (--image=IMAGE | --resource=RESOURCE) [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To evaluate a policy using its resource name: + + $ gcloud alpha container binauthz policy evaluate \ + projects/my-proj/platforms/gke/policies/my-policy \ + --resource=$KUBERNETES_RESOURCE + + To evaluate the same policy using flags against an image: + + $ gcloud alpha container binauthz policy evaluate my-policy \ + --platform=gke --project=my-proj --image=$IMAGE + +POSITIONAL ARGUMENTS + Policy resource - The resource name of the policy to evaluate. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument policy_resource_name on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + POLICY_RESOURCE_NAME + ID of the policy or fully qualified identifier for the policy. + + To set the policy attribute: + ▸ provide the argument policy_resource_name on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --platform=PLATFORM + The platform that the policy belongs to. PLATFORM must be one of the + following: cloudRun, gke. + + To set the platform attribute: + ▸ provide the argument policy_resource_name on the command line + with a fully specified name; + ▸ provide the argument --platform on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --image=IMAGE + The image to evaluate. If the policy being evaluated has scoped + checksets, this mode of evaluation will always use the default + (unscoped) checkset. + + --resource=RESOURCE + The JSON or YAML file containing the Kubernetes resource to evaluate. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud beta container binauthz policy evaluate + diff --git a/gcloud/alpha/container/binauthz/policy/help b/gcloud/alpha/container/binauthz/policy/help index d34b4ac77..ba4cbc536 100644 --- a/gcloud/alpha/container/binauthz/policy/help +++ b/gcloud/alpha/container/binauthz/policy/help @@ -28,6 +28,9 @@ COMMANDS describe (ALPHA) Describe a Binary Authorization platform policy. + evaluate + (ALPHA) Evaluate a Binary Authorization platform policy. + export (ALPHA) Export the Binary Authorization policy for the current project. diff --git a/gcloud/alpha/container/clusters/create b/gcloud/alpha/container/clusters/create index d16753421..646158801 100644 --- a/gcloud/alpha/container/clusters/create +++ b/gcloud/alpha/container/clusters/create @@ -23,12 +23,12 @@ SYNOPSIS [--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE] [--disable-default-snat] [--disable-pod-cidr-overprovision] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autorepair] - [--no-enable-autoupgrade] [--enable-cloud-logging] - [--enable-cloud-monitoring] [--enable-cloud-run-alpha] - [--enable-confidential-nodes] [--enable-confidential-storage] - [--enable-cost-allocation] [--enable-dataplane-v2] [--enable-fleet] - [--enable-fqdn-network-policy] [--enable-gke-oidc] - [--enable-google-cloud-access] [--enable-gvnic] + [--no-enable-autoupgrade] [--enable-cilium-clusterwide-network-policy] + [--enable-cloud-logging] [--enable-cloud-monitoring] + [--enable-cloud-run-alpha] [--enable-confidential-nodes] + [--enable-confidential-storage] [--enable-cost-allocation] + [--enable-dataplane-v2] [--enable-fleet] [--enable-fqdn-network-policy] + [--enable-gke-oidc] [--enable-google-cloud-access] [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] @@ -301,8 +301,8 @@ FLAGS ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used with '--create-subnetwork' option. --cluster-version=CLUSTER_VERSION The Kubernetes version to use for the master and nodes. Defaults to @@ -347,8 +347,8 @@ FLAGS $ gcloud alpha container clusters create \ --create-subnetwork name=my-subnet - Can not be specified unless '--enable-ip-alias' is also specified. Can - not be used in conjunction with the '--subnetwork' option. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used in conjunction with '--subnetwork' option. --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. @@ -427,6 +427,10 @@ FLAGS Enabled by default, use --no-enable-autoupgrade to disable. + --enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Disabled by + default. + --enable-cloud-logging (DEPRECATED) Automatically send logs from the cluster to the Google Cloud Logging API. @@ -1139,15 +1143,16 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Can not be specified unless '--enable-ip-alias' is also specified. + Cannot be specified unless '--enable-ip-alias' option is also + specified. --services-secondary-range-name=NAME Set the secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used with '--create-subnetwork' option. --shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the diff --git a/gcloud/alpha/container/clusters/create-auto b/gcloud/alpha/container/clusters/create-auto index 629820aa0..f960292da 100644 --- a/gcloud/alpha/container/clusters/create-auto +++ b/gcloud/alpha/container/clusters/create-auto @@ -12,8 +12,8 @@ SYNOPSIS [--cluster-version=CLUSTER_VERSION] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] - [--enable-backup-restore] [--enable-fleet] - [--enable-google-cloud-access] + [--enable-backup-restore] [--enable-cilium-clusterwide-network-policy] + [--enable-fleet] [--enable-google-cloud-access] [--enable-kubernetes-unstable-apis=API,[API,...]] [--enable-master-global-access] [--enable-secret-manager] [--fleet-project=PROJECT_ID_OR_NUMBER] [--labels=[KEY=VALUE,...]] @@ -127,8 +127,7 @@ FLAGS ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be used with '--create-subnetwork' option. --cluster-version=CLUSTER_VERSION The Kubernetes version to use for the master and nodes. Defaults to @@ -173,8 +172,7 @@ FLAGS $ gcloud alpha container clusters create-auto \ --create-subnetwork name=my-subnet - Can not be specified unless '--enable-ip-alias' is also specified. Can - not be used in conjunction with the '--subnetwork' option. + Cannot be used in conjunction with '--subnetwork' option. --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. @@ -191,6 +189,10 @@ FLAGS To learn more, see the Backup for GKE overview: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/concepts/backup-for-gke. + --enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Disabled by + default. + --enable-fleet Set cluster project as the fleet host project. This will register the cluster to the same project. To register the cluster to a fleet in a @@ -345,15 +347,12 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Can not be specified unless '--enable-ip-alias' is also specified. - --services-secondary-range-name=NAME Set the secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be used with '--create-subnetwork' option. --subnetwork=SUBNETWORK The Google Compute Engine subnetwork diff --git a/gcloud/alpha/container/clusters/update b/gcloud/alpha/container/clusters/update index 0f6c143f5..f4334db3c 100644 --- a/gcloud/alpha/container/clusters/update +++ b/gcloud/alpha/container/clusters/update @@ -11,6 +11,7 @@ SYNOPSIS | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling + | --[no-]enable-cilium-clusterwide-network-policy | --enable-cost-allocation | --enable-fleet | --enable-fqdn-network-policy | --enable-gke-oidc | --enable-google-cloud-access | --enable-identity-service @@ -246,6 +247,11 @@ REQUIRED FLAGS default node pool if --node-pool is not provided. If not already, --max-nodes or --total-max-nodes must also be set. + --[no-]enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Use + --enable-cilium-clusterwide-network-policy to enable and + --no-enable-cilium-clusterwide-network-policy to disable. + --enable-cost-allocation Enable the cost management feature. diff --git a/gcloud/alpha/container/fleet/memberships/bindings/list b/gcloud/alpha/container/fleet/memberships/bindings/list index 0a4febe1c..3085b3d2c 100644 --- a/gcloud/alpha/container/fleet/memberships/bindings/list +++ b/gcloud/alpha/container/fleet/memberships/bindings/list @@ -26,8 +26,7 @@ EXAMPLES where the Binding belongs along with membership name. $ gcloud alpha container fleet memberships bindings list \ - BINDING_NAME --membership=MEMBERSHIP_NAME \ - --location=LOCATION_NAME + --membership=MEMBERSHIP_NAME --location=LOCATION_NAME REQUIRED FLAGS --membership=MEMBERSHIP diff --git a/gcloud/alpha/container/fleet/scopes/help b/gcloud/alpha/container/fleet/scopes/help index 9c5339793..ef75155c4 100644 --- a/gcloud/alpha/container/fleet/scopes/help +++ b/gcloud/alpha/container/fleet/scopes/help @@ -41,7 +41,7 @@ COMMANDS (ALPHA) Get the IAM policy for a Fleet Scope. list - (ALPHA) List fleet scopes. + (ALPHA) List fleet scopes in a project. remove-iam-policy-binding (ALPHA) Remove IAM policy binding of a Fleet Scope. diff --git a/gcloud/alpha/container/fleet/scopes/list b/gcloud/alpha/container/fleet/scopes/list index c598de3f7..b08148175 100644 --- a/gcloud/alpha/container/fleet/scopes/list +++ b/gcloud/alpha/container/fleet/scopes/list @@ -1,5 +1,5 @@ NAME - gcloud alpha container fleet scopes list - list fleet scopes + gcloud alpha container fleet scopes list - list fleet scopes in a project SYNOPSIS gcloud alpha container fleet scopes list [--filter=EXPRESSION] @@ -7,13 +7,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List scopes in a fleet. + (ALPHA) This command can fail for the following reasons: + ▪ The project specified does not exist. + ▪ The user does not have access to the project specified. EXAMPLES - List scopes in the active project's fleet: + The following command lists scopes in the active project: $ gcloud alpha container fleet scopes list + The following command lists scopes in project PROJECT_ID: + + $ gcloud alpha container fleet scopes list --project=PROJECT_ID + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. @@ -54,11 +60,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the gkehub/v1alpha API. The full documentation for this - API can be found at: - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/container/hub/memberships/bindings/list b/gcloud/alpha/container/hub/memberships/bindings/list index 467b7a742..ceccad510 100644 --- a/gcloud/alpha/container/hub/memberships/bindings/list +++ b/gcloud/alpha/container/hub/memberships/bindings/list @@ -26,8 +26,7 @@ EXAMPLES where the Binding belongs along with membership name. $ gcloud alpha container hub memberships bindings list \ - BINDING_NAME --membership=MEMBERSHIP_NAME \ - --location=LOCATION_NAME + --membership=MEMBERSHIP_NAME --location=LOCATION_NAME REQUIRED FLAGS --membership=MEMBERSHIP diff --git a/gcloud/alpha/container/hub/scopes/help b/gcloud/alpha/container/hub/scopes/help index b655b759c..b728612fc 100644 --- a/gcloud/alpha/container/hub/scopes/help +++ b/gcloud/alpha/container/hub/scopes/help @@ -41,7 +41,7 @@ COMMANDS (ALPHA) Get the IAM policy for a Fleet Scope. list - (ALPHA) List fleet scopes. + (ALPHA) List fleet scopes in a project. remove-iam-policy-binding (ALPHA) Remove IAM policy binding of a Fleet Scope. diff --git a/gcloud/alpha/container/hub/scopes/list b/gcloud/alpha/container/hub/scopes/list index 634786bb8..301e180e7 100644 --- a/gcloud/alpha/container/hub/scopes/list +++ b/gcloud/alpha/container/hub/scopes/list @@ -1,5 +1,5 @@ NAME - gcloud alpha container hub scopes list - list fleet scopes + gcloud alpha container hub scopes list - list fleet scopes in a project SYNOPSIS gcloud alpha container hub scopes list [--filter=EXPRESSION] @@ -7,13 +7,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) List scopes in a fleet. + (ALPHA) This command can fail for the following reasons: + ▪ The project specified does not exist. + ▪ The user does not have access to the project specified. EXAMPLES - List scopes in the active project's fleet: + The following command lists scopes in the active project: $ gcloud alpha container hub scopes list + The following command lists scopes in project PROJECT_ID: + + $ gcloud alpha container hub scopes list --project=PROJECT_ID + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. @@ -54,11 +60,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the gkehub/v1alpha API. The full documentation for this - API can be found at: - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct diff --git a/gcloud/alpha/container/node-pools/create b/gcloud/alpha/container/node-pools/create index 0edfd76d8..eeb2dde16 100644 --- a/gcloud/alpha/container/node-pools/create +++ b/gcloud/alpha/container/node-pools/create @@ -257,12 +257,13 @@ FLAGS disabled. --enable-queued-provisioning - Mark the newly created nodepool as Queued only. This means that all new - nodes can be obtained only through queuing via Cluster Autoscaler - ProvisioningRequest API. + Mark the nodepool as Queued only. This means that all new nodes can be + obtained only through queuing via ProvisioningRequest API. $ gcloud alpha container node-pools create node-pool-1 \ --cluster=example-cluster --enable-queued-provisioning + ... and other required parameters, for more details see: + https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest --enable-surge-upgrade Changes node pool upgrade strategy to surge upgrade. diff --git a/gcloud/alpha/container/node-pools/update b/gcloud/alpha/container/node-pools/update index b195c7ac6..d87f55f36 100644 --- a/gcloud/alpha/container/node-pools/update +++ b/gcloud/alpha/container/node-pools/update @@ -6,7 +6,8 @@ SYNOPSIS gcloud alpha container node-pools update NAME (--enable-confidential-nodes | --enable-gvnic | --enable-image-streaming | --enable-private-nodes - | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT + | --enable-queued-provisioning | --labels=[KEY=VALUE,...] + | --logging-variant=LOGGING_VARIANT | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] @@ -66,6 +67,15 @@ REQUIRED FLAGS IP addresses only, regardless of whether private nodes are enabled or disabled. + --enable-queued-provisioning + Mark the nodepool as Queued only. This means that all new nodes can + be obtained only through queuing via ProvisioningRequest API. + + $ gcloud alpha container node-pools update node-pool-1 \ + --cluster=example-cluster --enable-queued-provisioning + ... and other required parameters, for more details see: + https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest + --labels=[KEY=VALUE,...] Labels to apply to the Google Cloud resources of node pools in the Kubernetes Engine cluster. These are unrelated to Kubernetes labels. diff --git a/gcloud/alpha/deploy/delivery-pipelines/describe b/gcloud/alpha/deploy/delivery-pipelines/describe index b2bbf1936..3897102bc 100644 --- a/gcloud/alpha/deploy/delivery-pipelines/describe +++ b/gcloud/alpha/deploy/delivery-pipelines/describe @@ -1,6 +1,6 @@ NAME - gcloud alpha deploy delivery-pipelines describe - describes details - specific to the individual target, delivery pipeline qualified + gcloud alpha deploy delivery-pipelines describe - show details about a + delivery pipeline SYNOPSIS gcloud alpha deploy delivery-pipelines describe diff --git a/gcloud/alpha/deploy/delivery-pipelines/help b/gcloud/alpha/deploy/delivery-pipelines/help index 90e4bad7f..cf2e55d9f 100644 --- a/gcloud/alpha/deploy/delivery-pipelines/help +++ b/gcloud/alpha/deploy/delivery-pipelines/help @@ -23,8 +23,7 @@ COMMANDS (ALPHA) Delete a delivery pipeline. describe - (ALPHA) Describes details specific to the individual target, delivery - pipeline qualified. + (ALPHA) Show details about a delivery pipeline. export (ALPHA) Returns the .yaml definition of the specified delivery diff --git a/gcloud/alpha/emulators/firestore/start b/gcloud/alpha/emulators/firestore/start index b23d58aa9..32eb5c044 100644 --- a/gcloud/alpha/emulators/firestore/start +++ b/gcloud/alpha/emulators/firestore/start @@ -2,8 +2,8 @@ NAME gcloud alpha emulators firestore start - start a local Firestore emulator SYNOPSIS - gcloud alpha emulators firestore start [--host-port=HOST_PORT] - [--rules=RULES] [GCLOUD_WIDE_FLAG ...] + gcloud alpha emulators firestore start [--database-mode=DATABASE_MODE] + [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (ALPHA) This command starts a local Firestore emulator. @@ -21,7 +21,19 @@ EXAMPLES $ gcloud alpha emulators firestore start --rules=firestore.rules + To run the local Firestore emulator in Datastore Mode, run: + + $ gcloud alpha emulators firestore start \ + --database-mode=datastore-mode + FLAGS + --database-mode=DATABASE_MODE + The database mode to start the Firestore Emulator in. The valid options + are: + + `firestore-native` (default): start the emulator in Firestore Native + `datastore-mode`: start the emulator in Datastore Mode + --host-port=HOST_PORT The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port: diff --git a/gcloud/alpha/functions/describe b/gcloud/alpha/functions/describe index b33903ecf..fd0010c12 100644 --- a/gcloud/alpha/functions/describe +++ b/gcloud/alpha/functions/describe @@ -3,7 +3,7 @@ NAME Function SYNOPSIS - gcloud alpha functions describe (NAME : --region=REGION) + gcloud alpha functions describe (NAME : --region=REGION) [--v2] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -42,6 +42,18 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property functions/region. +FLAGS + --v2 + If specified, this command will use Cloud Functions v2 APIs and return + the result in the v2 format (See + https://cloud.google.com/functions/docs/reference/rest/v2/projects.locations.functions#Function). + If not specified, 1st gen and 2nd gen functions will use v1 and v2 APIs + respectively and return the result in the corresponding format (For v1 + format, see + https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions#resource:-cloudfunction). + This command conflicts with --no-gen2. If specified with this + combination, v2 APIs will be used. + 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/functions/list b/gcloud/alpha/functions/list index ad437ab10..fc37833ea 100644 --- a/gcloud/alpha/functions/list +++ b/gcloud/alpha/functions/list @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud alpha functions list [--regions=REGION,[REGION,...]; default="-"] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--v2] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -14,6 +14,17 @@ FLAGS Regions containing functions to list. By default, functions from the region configured in [functions/region] property are listed. + --v2 + If specified, this command will use Cloud Functions v2 APIs and return + the result in the v2 format (See + https://cloud.google.com/functions/docs/reference/rest/v2/projects.locations.functions#Function). + If not specified, 1st gen and 2nd gen functions will use v1 and v2 APIs + respectively and return the result in the corresponding format (For v1 + format, see + https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions#resource:-cloudfunction). + This command conflicts with --no-gen2. If specified with this + combination, v2 APIs will be used. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/alpha/migration/vms/image-imports/create b/gcloud/alpha/migration/vms/image-imports/create index 1f37d479d..a2a4826d5 100644 --- a/gcloud/alpha/migration/vms/image-imports/create +++ b/gcloud/alpha/migration/vms/image-imports/create @@ -7,8 +7,9 @@ SYNOPSIS (IMAGE_IMPORT_NAME : --location=LOCATION) --source-file=SOURCE_FILE [--additional-licenses=[ADDITIONAL_LICENSES,...]] [--description=DESCRIPTION] [--family-name=FAMILY_NAME] - [--image-name=IMAGE_NAME] [--labels=[KEY=VALUE,...]] - [--single-region-storage] [--target-project=TARGET_PROJECT] + [--image-name=IMAGE_NAME] [--kms-key=KMS_KEY] + [--labels=[KEY=VALUE,...]] [--single-region-storage] + [--target-project=TARGET_PROJECT] [--skip-os-adaptation | --generalize --license-type=LICENSE_TYPE] [GCLOUD_WIDE_FLAG ...] @@ -83,6 +84,10 @@ OPTIONAL FLAGS The name of the image that will be imported to Google Compute Engine. Default is the Image Import name. + --kms-key=KMS_KEY + Fully qualified identifier for the Cloud KMS (Key Management Service) + cryptokey that will be used to protect the image. + --labels=[KEY=VALUE,...] A map of labels to associate with the image. diff --git a/gcloud/alpha/netapp/volumes/create b/gcloud/alpha/netapp/volumes/create index 5d2c4e6f8..d6b3efec3 100644 --- a/gcloud/alpha/netapp/volumes/create +++ b/gcloud/alpha/netapp/volumes/create @@ -15,6 +15,8 @@ SYNOPSIS [kerberos-5p-read-only=KERBEROS-5P-READ-ONLY], [kerberos-5p-read-write=KERBEROS-5P-READ-WRITE], [nfsv3=NFSV3],[nfsv4=NFSV4]] [--labels=[KEY=VALUE,...]] + [--large-capacity=LARGE_CAPACITY] + [--multiple-endpoints=MULTIPLE_ENDPOINTS] [--restricted-actions=RESTRICTED_ACTION,[...]] [--security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED"] [--smb-settings=SMB_SETTING,[SMB_SETTING,...]] @@ -151,6 +153,14 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. + --large-capacity=LARGE_CAPACITY + Boolean flag indicating whether Volume is a large capacity Volume or + not + + --multiple-endpoints=MULTIPLE_ENDPOINTS + Boolean flag indicating whether Volume is a multiple endpoints Volume + or not + --restricted-actions=RESTRICTED_ACTION,[...] Actions to be restricted for a volume. Valid restricted action options are: 'DELETE'. diff --git a/gcloud/alpha/recommender/insights/help b/gcloud/alpha/recommender/insights/help index f1c7b2752..4c989f040 100644 --- a/gcloud/alpha/recommender/insights/help +++ b/gcloud/alpha/recommender/insights/help @@ -19,7 +19,7 @@ COMMANDS (ALPHA) Describe an insight. list - (ALPHA) List insights for a cloud entity. + (ALPHA) List insights for a Google Cloud entity. mark-accepted (ALPHA) Mark an insight's state as ACCEPTED. diff --git a/gcloud/alpha/recommender/insights/list b/gcloud/alpha/recommender/insights/list index 688221f4b..84fbca853 100644 --- a/gcloud/alpha/recommender/insights/list +++ b/gcloud/alpha/recommender/insights/list @@ -1,5 +1,6 @@ NAME - gcloud alpha recommender insights list - list insights for a cloud entity + gcloud alpha recommender insights list - list insights for a Google Cloud + entity SYNOPSIS gcloud alpha recommender insights list @@ -10,13 +11,13 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) This command lists all insights for a given cloud entity, location - and insight type. If insight-type or location is not specified, insights - for all supported insight-types and locations are listed. Supported - insight-types can be found here: - https://cloud.google.com/recommender/docs/insights/insight-types. Currently - the following cloud_entity_types are supported: project, billing_account, - folder and organization. + (ALPHA) This command lists all insights for a given Google Cloud entity, + location, and insight type. If insight-type or location is not specified, + insights for all supported insight-types and locations are listed. + Supported insight-types can be found here: + https://cloud.google.com/recommender/docs/insights/insight-types. The + following Google Cloud entity types are supported: project, + billing_account, folder, and organization. EXAMPLES To list all insights for a billing account: diff --git a/gcloud/alpha/recommender/recommendations/list b/gcloud/alpha/recommender/recommendations/list index d7db2c77a..7f4dce2ee 100644 --- a/gcloud/alpha/recommender/recommendations/list +++ b/gcloud/alpha/recommender/recommendations/list @@ -11,13 +11,13 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) This command lists all recommendations for a given cloud_entity_id, - location, and recommender. If recommender or location is not specified, - recommendations for all supported recommenders and locations are listed. - Supported recommenders can be found here: - https://cloud.google.com/recommender/docs/recommenders. Currently the - following cloud_entity_types are supported: project, billing_account, - folder and organization. + (ALPHA) This command lists all recommendations for a given Google Cloud + entity ID, location, and recommender. If recommender or location is not + specified, recommendations for all supported recommenders and locations are + listed. Supported recommenders can be found here: + https://cloud.google.com/recommender/docs/recommenders. The following + Google Cloud entity types are supported: project, billing_account, folder + and organization. EXAMPLES Lists recommendations for a Cloud project. $ gcloud alpha recommender recommendations list \ diff --git a/gcloud/alpha/run/deploy b/gcloud/alpha/run/deploy index 1b7a15133..f506bcc29 100644 --- a/gcloud/alpha/run/deploy +++ b/gcloud/alpha/run/deploy @@ -461,10 +461,9 @@ FLAGS --[no-]invoker-iam-check Indicates whether an IAM check should occur when invoking the - container. This is Enabled by default. It can only be disabled on - services with internal, and internal+load-balancer ingress settings. - Use --invoker-iam-check to enable and --no-invoker-iam-check to - disable. + container. This is Enabled by default. Disabling this flag is not + available in all projects. Use --invoker-iam-check to enable and + --no-invoker-iam-check to disable. --remove-containers=[CONTAINER,...] List of containers to remove. diff --git a/gcloud/alpha/run/jobs/create b/gcloud/alpha/run/jobs/create index 40595cba3..8e027c751 100644 --- a/gcloud/alpha/run/jobs/create +++ b/gcloud/alpha/run/jobs/create @@ -10,8 +10,9 @@ SYNOPSIS [--set-cloudsql-instances=[CLOUDSQL-INSTANCES,...]] [--task-timeout=TASK_TIMEOUT] [--tasks=TASKS; default=1] [--vpc-connector=VPC_CONNECTOR] [--vpc-egress=VPC_EGRESS] - [--args=[ARG,...] --command=[COMMAND,...] - --cpu=CPU --image=IMAGE --memory=MEMORY --clear-env-vars + [--args=[ARG,...] --command=[COMMAND,...] --cpu=CPU + --depends-on=[CONTAINER,...] + --image=IMAGE --memory=MEMORY --clear-env-vars | --env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...] | --remove-env-vars=[KEY,...] --update-env-vars=[KEY=VALUE,...] --clear-secrets @@ -166,6 +167,9 @@ FLAGS Cloud Run for Anthos and Knative-compatible Kubernetes clusters support fractional values. Examples .5, 500m, 2 + --depends-on=[CONTAINER,...] + List of container dependencies to add to the current container. + --image=IMAGE Name of the container image to deploy (e.g. us-docker.pkg.dev/cloudrun/container/job:latest). diff --git a/gcloud/alpha/run/jobs/deploy b/gcloud/alpha/run/jobs/deploy index 87310edcb..4e7e95d41 100644 --- a/gcloud/alpha/run/jobs/deploy +++ b/gcloud/alpha/run/jobs/deploy @@ -15,7 +15,7 @@ SYNOPSIS --clear-volumes --remove-volume=[VOLUME,...]] [--add-volume-mount=[volume=NAME,mount-path=MOUNT_PATH,...] --args=[ARG,...] --clear-volume-mounts --command=[COMMAND,...] - --cpu=CPU --memory=MEMORY + --cpu=CPU --depends-on=[CONTAINER,...] --memory=MEMORY --remove-volume-mount=[MOUNT_PATH,...] --clear-env-vars | --env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...] | --remove-env-vars=[KEY,...] @@ -234,6 +234,9 @@ FLAGS Cloud Run for Anthos and Knative-compatible Kubernetes clusters support fractional values. Examples .5, 500m, 2 + --depends-on=[CONTAINER,...] + List of container dependencies to add to the current container. + --memory=MEMORY Set a memory limit. Ex: 1024Mi, 4Gi. diff --git a/gcloud/alpha/run/jobs/update b/gcloud/alpha/run/jobs/update index 014d006a6..df1c14ef3 100644 --- a/gcloud/alpha/run/jobs/update +++ b/gcloud/alpha/run/jobs/update @@ -17,7 +17,7 @@ SYNOPSIS --clear-volumes --remove-volume=[VOLUME,...]] [--add-volume-mount=[volume=NAME,mount-path=MOUNT_PATH,...] --args=[ARG,...] --clear-volume-mounts --command=[COMMAND,...] - --cpu=CPU --image=IMAGE --memory=MEMORY + --cpu=CPU --depends-on=[CONTAINER,...] --image=IMAGE --memory=MEMORY --remove-volume-mount=[MOUNT_PATH,...] --clear-env-vars | --env-vars-file=FILE_PATH | --set-env-vars=[KEY=VALUE,...] | --remove-env-vars=[KEY,...] @@ -244,6 +244,9 @@ FLAGS Cloud Run for Anthos and Knative-compatible Kubernetes clusters support fractional values. Examples .5, 500m, 2 + --depends-on=[CONTAINER,...] + List of container dependencies to add to the current container. + --image=IMAGE Name of the container image to deploy (e.g. us-docker.pkg.dev/cloudrun/container/job:latest). diff --git a/gcloud/alpha/run/services/update b/gcloud/alpha/run/services/update index 395e28dcf..5a72e4fc5 100644 --- a/gcloud/alpha/run/services/update +++ b/gcloud/alpha/run/services/update @@ -347,10 +347,9 @@ FLAGS --[no-]invoker-iam-check Indicates whether an IAM check should occur when invoking the - container. This is Enabled by default. It can only be disabled on - services with internal, and internal+load-balancer ingress settings. - Use --invoker-iam-check to enable and --no-invoker-iam-check to - disable. + container. This is Enabled by default. Disabling this flag is not + available in all projects. Use --invoker-iam-check to enable and + --no-invoker-iam-check to disable. --remove-containers=[CONTAINER,...] List of containers to remove. diff --git a/gcloud/alpha/scc/help b/gcloud/alpha/scc/help index d16e846f3..29cc03b72 100644 --- a/gcloud/alpha/scc/help +++ b/gcloud/alpha/scc/help @@ -25,6 +25,9 @@ GROUPS findings (ALPHA) Manage Cloud SCC (Security Command Center) findings. + manage + (ALPHA) Manage Cloud SCC (Security Command Center) settings. + muteconfigs (ALPHA) Manage Cloud SCC (Security Command Center) mute configs. diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/create b/gcloud/alpha/scc/manage/custom-modules/etd/create new file mode 100644 index 000000000..6ee2dc4ae --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/create @@ -0,0 +1,74 @@ +NAME + gcloud alpha scc manage custom-modules etd create - create an Event Threat + Detection custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd create + --custom-config-file=CUSTOM_CONFIG --display-name=DISPLAY-NAME + --enablement-state=ENABLEMENT_STATE --module-type=MODULE_TYPE + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To create an Event Threat Detection custom module for organization 123, + run: + + $ gcloud alpha scc manage custom-modules etd create \ + --organization=organizations/123 \ + --display-name="test_display_name" \ + --module-type="CONFIGURABLE_BAD_IP" \ + --enablement-state="ENABLED" --custom-config-file=config.json + +REQUIRED FLAGS + --custom-config-file=CUSTOM_CONFIG + Path to a JSON custom configuration file of the ETD custom module. + + --display-name=DISPLAY-NAME + The display name of the custom module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Event Threat Detection custom module. + Valid options are ENABLED, DISABLED, OR INHERITED. + + --module-type=MODULE_TYPE + Type of the custom module. For a list of valid module types please + visit + https://cloud.google.com/security-command-center/docs/custom-modules-etd-overview#custom_modules_and_templates. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules etd create + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/delete b/gcloud/alpha/scc/manage/custom-modules/etd/delete new file mode 100644 index 000000000..a0bee3efc --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/delete @@ -0,0 +1,91 @@ +NAME + gcloud alpha scc manage custom-modules etd delete - delete an Event Threat + Detection custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd delete MODULE_ID_OR_NAME + [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Event Threat Detection custom module. User specifies the + custom module as well as the parent of the module to delete. A + validation_only flag is optional. When set to true only validations + (including IAM checks) will done for the request (module will not be + deleted). + +EXAMPLES + To delete an Event Threat Detection custom module with ID 123456 for + organization 123, run: + + $ gcloud alpha scc manage custom-modules etd delete 123456 \ + --organization=123 + + To delete a Event Threat Detection custom module with ID 123456 for folder + 456, run: + + $ gcloud alpha scc manage custom-modules etd delete 123456 \ + --folder=456 + + To delete a Event Threat Detection custom module with ID 123456 for project + 789, run: + + $ gcloud alpha scc manage custom-modules etd delete 123456 \ + --project=789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules etd delete 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules etd delete \ + organizations/123/locations/global/\ + eventThreatDetectionCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/eventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules etd delete + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/describe b/gcloud/alpha/scc/manage/custom-modules/etd/describe new file mode 100644 index 000000000..7acebfba4 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/describe @@ -0,0 +1,88 @@ +NAME + gcloud alpha scc manage custom-modules etd describe - get the details of a + Event Threat Detection custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd describe MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get the details of a Event Threat Detection custom module. It does + not resolve INHERITED enablement states to ENABLED or DISABLED for modules + created at ancestor levels. For example, if the module is enabled at the + ancestor level, modules for all child resources will have the enablement + state set to INHERITED. Use gcloud scc manage custom-modules etd + get-effective to retrieve a custom module with its effective enablement + state. + +EXAMPLES + To get the details of a Event Threat Detection custom module with ID 123456 + for organization 123, run: + + $ gcloud alpha scc manage custom-modules etd describe 123456 \ + --organization=123 + + To get the details of a Event Threat Detection custom module with ID 123456 + for folder 456, run: + + $ gcloud alpha scc manage custom-modules etd describe 123456 \ + --folder=456 + + To get the details of a Event Threat Detection custom module with ID 123456 + for project 789, run: + + $ gcloud alpha scc manage custom-modules etd describe 123456 \ + --project=789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules etd describe 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules etd describe \ + organizations/123/locations/global/\ + eventThreatDetectionCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/eventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules etd describe + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/describe-effective b/gcloud/alpha/scc/manage/custom-modules/etd/describe-effective new file mode 100644 index 000000000..4a772236a --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/describe-effective @@ -0,0 +1,85 @@ +NAME + gcloud alpha scc manage custom-modules etd describe-effective - get the + effective details of a Event Threat Detection effective custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd describe-effective + MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get the effective details of a Event Threat Detection effective + custom module. It retrieves a custom module with its effective enablement + state. + +EXAMPLES + To get the effective details of a Event Threat Detection custom module with + ID 123456 for organization 123, run: + + $ gcloud alpha scc manage custom-modules etd describe-effective \ + 123456 --organization=123 + + To get the effective details of a Event Threat Detection custom module with + ID 123456 for folder 456, run: + + $ gcloud alpha scc manage custom-modules etd describe-effective \ + 123456 --folder=456 + + To get the effective details of a Event Threat Detection custom module with + ID 123456 for project 789, run: + + $ gcloud alpha scc manage custom-modules etd describe-effective \ + 123456 --project=789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules etd describe-effective \ + 123456 --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules etd describe-effective \ + organizations/123/locations/global/\ + effectiveEventThreatDetectionCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/effectiveEventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules etd describe-effective + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/help b/gcloud/alpha/scc/manage/custom-modules/etd/help new file mode 100644 index 000000000..a84a7219d --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/help @@ -0,0 +1,56 @@ +NAME + gcloud alpha scc manage custom-modules etd - manage custom modules + +SYNOPSIS + gcloud alpha scc manage custom-modules etd COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an Event Threat Detection custom module. + + delete + (ALPHA) Delete an Event Threat Detection custom module. + + describe + (ALPHA) Get the details of a Event Threat Detection custom module. + + describe-effective + (ALPHA) Get the effective details of a Event Threat Detection effective + custom module. + + list + (ALPHA) List details of resident and inherited Event Threat Detection + Custom Modules. + + list-descendant + (ALPHA) List the details of the resident and descendant Event Threat + Detection custom modules. + + list-effective + (ALPHA) List the details of an Event Threat Detection effective custom + module. + + update + (ALPHA) Update an Event Threat Detection custom module. + + validate + (ALPHA) Command to validate an ETD custom module. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 scc manage custom-modules etd + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/list b/gcloud/alpha/scc/manage/custom-modules/etd/list new file mode 100644 index 000000000..055e86c63 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/list @@ -0,0 +1,97 @@ +NAME + gcloud alpha scc manage custom-modules etd list - list details of resident + and inherited Event Threat Detection Custom Modules + +SYNOPSIS + gcloud alpha scc manage custom-modules etd list + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the details of the resident and inherited Event Threat + Detection custom modules for the specified folder or project. For an + organization, this command lists only the custom modules that are created + at the organization level. Custom modules created in child folders or + projects are not included in the list. To list the resident custom modules + and the modules that are created in child folders or projects, use gcloud + scc manage custom-modules etd list-descendant. + +EXAMPLES + To list resident and inherited Event Threat Detection custom modules for + organization 123, run: + + $ gcloud alpha scc manage custom-modules etd list \ + --organization=organizations/123 + + To list resident and inherited Event Threat Detection custom modules for + folder 456, run: + + $ gcloud alpha scc manage custom-modules etd list \ + --folder=folders/456 + + To list resident and inherited Event Threat Detection custom modules for + project 789, run: + + $ gcloud alpha scc manage custom-modules etd list \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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. This variant is also available: + + $ gcloud scc manage custom-modules etd list + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/list-descendant b/gcloud/alpha/scc/manage/custom-modules/etd/list-descendant new file mode 100644 index 000000000..a916a93c3 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/list-descendant @@ -0,0 +1,98 @@ +NAME + gcloud alpha scc manage custom-modules etd list-descendant - list the + details of the resident and descendant Event Threat Detection custom + modules + +SYNOPSIS + gcloud alpha scc manage custom-modules etd list-descendant + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the details of the resident and descendant Event Threat + Detection custom modules for a specified organization or folder. For a + project, this command lists only the custom modules that are created in the + project. Modules created in a parent organization or folder are excluded + from the list. To list the resident custom modules and the modules that are + inherited from a parent organization and folder, use gcloud scc manage + custom-modules etd list. + +EXAMPLES + To list resident and descendant Event Threat Detection custom modules for + organization 123, run: + + $ gcloud alpha scc manage custom-modules etd list-descendant \ + --organization=organizations/123 + + To list resident and descendant Event Threat Detection custom modules for + folder 456, run: + + $ gcloud alpha scc manage custom-modules etd list-descendant \ + --folder=folders/456 + + To list resident and descendant Event Threat Detection custom modules for + project 789, run: + + $ gcloud alpha scc manage custom-modules etd list-descendant \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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. This variant is also available: + + $ gcloud scc manage custom-modules etd list-descendant + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/list-effective b/gcloud/alpha/scc/manage/custom-modules/etd/list-effective new file mode 100644 index 000000000..2d77a9d90 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/list-effective @@ -0,0 +1,95 @@ +NAME + gcloud alpha scc manage custom-modules etd list-effective - list the + details of an Event Threat Detection effective custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd list-effective + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the details of resident and inherited Event Threat Detection + custom modules for the specified folder or project with their effective + enablement states. For an organization, this command lists only the custom + modules that are created at the organization level. Custom modules created + in child folders or projects are not included in the list. + +EXAMPLES + To list resident and inherited Event Threat Detection custom modules with + effective enablement states for organization 123, run: + + $ gcloud alpha scc manage custom-modules etd list-effective \ + --organization=organizations/123 + + To list resident and inherited effective Event Threat Detection custom + modules with effective enablement states for folder 456, run: + + $ gcloud alpha scc manage custom-modules etd list-effective \ + --folder=folders/456 + + To list resident and inherited effective Event Threat Detection custom + modules with effective enablement states for project 789, run: + + $ gcloud alpha scc manage custom-modules etd list-effective \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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. This variant is also available: + + $ gcloud scc manage custom-modules etd list-effective + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/update b/gcloud/alpha/scc/manage/custom-modules/etd/update new file mode 100644 index 000000000..ebf1f7693 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/update @@ -0,0 +1,74 @@ +NAME + gcloud alpha scc manage custom-modules etd update - update an Event Threat + Detection custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd update MODULE_ID_OR_NAME + (--custom-config-file=CUSTOM_CONFIG_FILE + --enablement-state=ENABLEMENT_STATE) [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To update an Event Threat Detection custom module with ID 123456 for + organization 123, run: + + $ gcloud alpha scc manage custom-modules etd update 123456 \ + --organization=organizations/123 --enablement-state="ENABLED" \ + --custom-config-file=custom_config.json + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/eventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +REQUIRED FLAGS + At least one of these must be specified: + + --custom-config-file=CUSTOM_CONFIG_FILE + Path to a JSON file that contains the custom config to set for the + module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Event Threat Detection custom + module. Valid options are ENABLED, DISABLED, OR INHERITED. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules etd update + diff --git a/gcloud/alpha/scc/manage/custom-modules/etd/validate b/gcloud/alpha/scc/manage/custom-modules/etd/validate new file mode 100644 index 000000000..732efdc25 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/etd/validate @@ -0,0 +1,66 @@ +NAME + gcloud alpha scc manage custom-modules etd validate - command to validate + an ETD custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules etd validate + --custom-config-file=CUSTOM_CONFIG --module-type=MODULE_TYPE + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To validate an Event Threat Detection custom module 'config.json' with a + module type 'CONFIGURABLE_BAD_IP', run: + + $ gcloud alpha scc manage custom-modules etd validate \ + --organization=organizations/252600681248 \ + --custom-config-file=config.json \ + --module-type=CONFIGURABLE_BAD_IP + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules etd validate \ + --parent=organizations/252600681248 \ + --custom-config-file=config.json \ + --module-type=CONFIGURABLE_BAD_IP + +REQUIRED FLAGS + --custom-config-file=CUSTOM_CONFIG + Path to a JSON custom configuration file of the ETD custom module. + + --module-type=MODULE_TYPE + Type of the custom module. For a list of valid module types please + visit + https://cloud.google.com/security-command-center/docs/custom-modules-etd-overview#custom_modules_and_templates. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules etd validate + diff --git a/gcloud/alpha/scc/manage/custom-modules/help b/gcloud/alpha/scc/manage/custom-modules/help new file mode 100644 index 000000000..7fbc1f8f0 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/help @@ -0,0 +1,32 @@ +NAME + gcloud alpha scc manage custom-modules - manage Cloud SCC + (Security Command Center) custom modules + +SYNOPSIS + gcloud alpha scc manage custom-modules GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Cloud SCC (Security Command Center) custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + etd + (ALPHA) Manage custom modules. + + sha + (ALPHA) Manage Security Health Analytics custom modules. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 scc manage custom-modules + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/create b/gcloud/alpha/scc/manage/custom-modules/sha/create new file mode 100644 index 000000000..a8365eee4 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/create @@ -0,0 +1,69 @@ +NAME + gcloud alpha scc manage custom-modules sha create - create an Security + Health Analytics custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha create + --custom-config-from-file=CUSTOM_CONFIG --display-name=DISPLAY-NAME + --enablement-state=ENABLEMENT_STATE + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To create a Security Health Analytics custom module for organization 123, + run: + + $ gcloud alpha scc manage custom-modules sha create \ + --organization=organizations/123 \ + --display-name="test_display_name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + +REQUIRED FLAGS + --custom-config-from-file=CUSTOM_CONFIG + Path to a YAML custom configuration file. + + --display-name=DISPLAY-NAME + The display name of the custom module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Security Health Analytics custom + module. Valid options are ENABLED, DISABLED, OR INHERITED. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules sha create + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/delete b/gcloud/alpha/scc/manage/custom-modules/sha/delete new file mode 100644 index 000000000..1ee3c51bf --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/delete @@ -0,0 +1,91 @@ +NAME + gcloud alpha scc manage custom-modules sha delete - delete a Security + Health Analytics custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha delete MODULE_ID_OR_NAME + [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Delete a Security Health Analytics custom module. User specifies + the custom module as well as the parent of the module to delete. A + validation_only flag is optional. When set to true only validations + (including IAM checks) will done for the request (module will not be + deleted). + +EXAMPLES + To delete an Security Health Analytics custom module with ID 123456 for + organization 123, run: + + $ gcloud alpha scc manage custom-modules sha delete 123456 \ + --organization=123 + + To delete a Security Health Analytics custom module with ID 123456 for + folder 456, run: + + $ gcloud alpha scc manage custom-modules sha delete 123456 \ + --folder=456 + + To delete a Security Health Analytics custom module with ID 123456 for + project 789, run: + + $ gcloud alpha scc manage custom-modules sha delete 123456 \ + --project=789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules sha delete 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules sha delete \ + organizations/123/locations/global/\ + securityHealthAnalyticsCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/securityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules sha delete + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/describe b/gcloud/alpha/scc/manage/custom-modules/sha/describe new file mode 100644 index 000000000..689f53630 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/describe @@ -0,0 +1,88 @@ +NAME + gcloud alpha scc manage custom-modules sha describe - get the details of a + Security Health Analytics custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha describe MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get the details of a Security Health Analytics custom module. It + does not resolve INHERITED enablement states to ENABLED or DISABLED for + modules created at ancestor levels. For example, if the module is enabled + at the ancestor level, modules for all child resources will have the + enablement state set to INHERITED. Use gcloud scc manage custom-modules sha + describe-effective to retrieve a custom module with its effective + enablement state. + +EXAMPLES + To get the details of a Security Health Analytics custom module with ID + 123456 for organization 123, run: + + $ gcloud alpha scc manage custom-modules sha describe 123456 \ + --organization=123 + + To get the details of a Security Health Analytics custom module with ID + 123456 for folder 456, run: + + $ gcloud alpha scc manage custom-modules sha describe 123456 \ + --folder=456 + + To get the details of a Security Health Analytics custom module with ID + 123456 for project 789, run: + + $ gcloud alpha scc manage custom-modules sha describe 123456 \ + --project=789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules sha describe 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules sha describe \ + organizations/123/locations/global/\ + securityHealthAnalyticsCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/securityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules sha describe + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/describe-effective b/gcloud/alpha/scc/manage/custom-modules/sha/describe-effective new file mode 100644 index 000000000..da0bb5185 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/describe-effective @@ -0,0 +1,86 @@ +NAME + gcloud alpha scc manage custom-modules sha describe-effective - get + effective the details of a Security Health Analytics effective custom + module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha describe-effective + MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Get the effective details of a Security Health Analytics effective + custom module. It retrieves a custom module with its effective enablement + state. + +EXAMPLES + To get the effective details of a Security Health Analytics custom module + with ID 123456 for organization 123, run: + + $ gcloud alpha scc manage custom-modules sha describe-effective \ + 123456 --organization=123 + + To get the effective details of a Security Health Analytics custom module + with ID 123456 for folder 456, run: + + $ gcloud alpha scc manage custom-modules sha describe-effective \ + 123456 --folder=456 + + To get the effective details of a Security Health Analytics custom module + with ID 123456 for project 789, run: + + $ gcloud alpha scc manage custom-modules sha describe-effective \ + 123456 --project=789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules sha describe-effective \ + 123456 --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules sha describe-effective \ + organizations/123/locations/global/\ + effectiveSecurityHealthAnalyticsCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/effectiveSecurityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules sha describe-effective + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/help b/gcloud/alpha/scc/manage/custom-modules/sha/help new file mode 100644 index 000000000..ec47e7dc2 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/help @@ -0,0 +1,56 @@ +NAME + gcloud alpha scc manage custom-modules sha - manage Security Health + Analytics custom modules + +SYNOPSIS + gcloud alpha scc manage custom-modules sha COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Security Health Analytics custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + (ALPHA) Create an Security Health Analytics custom module. + + delete + (ALPHA) Delete a Security Health Analytics custom module. + + describe + (ALPHA) Get the details of a Security Health Analytics custom module. + + describe-effective + (ALPHA) Get effective the details of a Security Health Analytics + effective custom module. + + list + (ALPHA) List the details of Security Health Analyics custom modules. + + list-descendant + (ALPHA) List the details of the resident and descendant Security Health + Analytics custom modules. + + list-effective + (ALPHA) List the details of an Security Health Analytics effective + custom module. + + simulate + (ALPHA) Command to simulate a SHA custom module. + + update + (ALPHA) Update a Security Health Analytics custom module. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 scc manage custom-modules sha + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/list b/gcloud/alpha/scc/manage/custom-modules/sha/list new file mode 100644 index 000000000..9c8fe01ea --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/list @@ -0,0 +1,108 @@ +NAME + gcloud alpha scc manage custom-modules sha list - list the details of + Security Health Analyics custom modules + +SYNOPSIS + gcloud alpha scc manage custom-modules sha list + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the details of the resident and inherited Security Health + Analytics custom modules for the specified folder or project. For an + organization, this command lists only the custom modules that are created + at the organization level. Custom modules created in child folders or + projects are not included in the list. To list the resident custom modules + and the modules that are created in child folders or projects, use gcloud + scc manage custom-modules sha list-descendant. + +EXAMPLES + To list resident and inherited Security Health Analytics custom modules for + organization 123, run: + + $ gcloud alpha scc manage custom-modules sha list \ + --organization=organizations/123 + + To list resident and inherited Security Health Analytics custom modules for + folder 456, run: + + $ gcloud alpha scc manage custom-modules sha list \ + --folder=folders/456 + + To list resident and inherited Security Health Analytics custom modules for + project 789, run: + + $ gcloud alpha scc manage custom-modules sha list \ + --project=projects/789 + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules sha list 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules sha list \ + organizations/123/locations/global/\ + securityHealthAnalyticsCustomModules/123456 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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. This variant is also available: + + $ gcloud scc manage custom-modules sha list + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/list-descendant b/gcloud/alpha/scc/manage/custom-modules/sha/list-descendant new file mode 100644 index 000000000..fa1342fce --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/list-descendant @@ -0,0 +1,98 @@ +NAME + gcloud alpha scc manage custom-modules sha list-descendant - list the + details of the resident and descendant Security Health Analytics custom + modules + +SYNOPSIS + gcloud alpha scc manage custom-modules sha list-descendant + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the details of the resident and descendant Security Health + Analytics custom modules for a specified organization or folder. For a + project, this command lists only the custom modules that are created in the + project. Modules created in a parent organization or folder are excluded + from the list. To list the resident custom modules and the modules that are + inherited from a parent organization and folder, use gcloud scc manage + custom-modules sha list. + +EXAMPLES + To list resident and inherited Security Health Analytics custom modules for + organization 123, run: + + $ gcloud alpha scc manage custom-modules sha list-descendant \ + --organization=organizations/123 + + To list resident and inherited Security Health Analytics custom modules for + folder 456, run: + + $ gcloud alpha scc manage custom-modules sha list-descendant \ + --folder=folders/456 + + To list resident and inherited Security Health Analytics custom modules for + project 789, run: + + $ gcloud alpha scc manage custom-modules sha list-descendant \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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. This variant is also available: + + $ gcloud scc manage custom-modules sha list-descendant + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/list-effective b/gcloud/alpha/scc/manage/custom-modules/sha/list-effective new file mode 100644 index 000000000..c2c4e0245 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/list-effective @@ -0,0 +1,95 @@ +NAME + gcloud alpha scc manage custom-modules sha list-effective - list the + details of an Security Health Analytics effective custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha list-effective + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) List the details of resident and inherited Security Health + Analytics custom modules for the specified folder or project with their + effective enablement states. For an organization, this command lists only + the custom modules that are created at the organization level. Custom + modules created in child folders or projects are not included in the list. + +EXAMPLES + To list resident and inherited Security Health Analytics custom modules + with effective enablement states for organization 123, run: + + $ gcloud alpha scc manage custom-modules sha list-effective \ + --organization=organizations/123 + + To list resident and inherited effective Security Health Analytics custom + modules with effective enablement states for folder 456, run: + + $ gcloud alpha scc manage custom-modules sha list-effective \ + --folder=folders/456 + + To list resident and inherited effective Security Health Analytics custom + modules with effective enablement states for project 789, run: + + $ gcloud alpha scc manage custom-modules sha list-effective \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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. This variant is also available: + + $ gcloud scc manage custom-modules sha list-effective + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/simulate b/gcloud/alpha/scc/manage/custom-modules/sha/simulate new file mode 100644 index 000000000..70527b7fb --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/simulate @@ -0,0 +1,87 @@ +NAME + gcloud alpha scc manage custom-modules sha simulate - command to simulate a + SHA custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha simulate + --custom-config-from-file=CUSTOM_CONFIG --resource-from-file=TEST_DATA + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To simulate a Security Health Analytics custom module with ID 123456 for + organization 123, run: + + $ gcloud alpha scc manage custom-modules sha simulate 123456 \ + --organization=123 \ + --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + To simulate a Security Health Analytics custom module with ID 123456 for + folder 456, run: + + $ gcloud alpha scc manage custom-modules sha simulate 123456 \ + --folder=456 --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + To simulate a Security Health Analytics custom module with ID 123456 for + project 789, run: + + $ gcloud alpha scc manage custom-modules sha simulate 123456 \ + --project=789 --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + You can also specify the parent more generally: + + $ gcloud alpha scc manage custom-modules sha simulate 123456 \ + --parent=organizations/123 \ + --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + Or just specify the fully qualified module name: + + $ gcloud alpha scc manage custom-modules sha simulate \ + organizations/123/locations/global/\ + effectiveSecurityHealthAnalyticsCustomModules/123456 \ + --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + +REQUIRED FLAGS + --custom-config-from-file=CUSTOM_CONFIG + Path to a YAML custom configuration file. + + --resource-from-file=TEST_DATA + Path to a YAML file that contains the resource data to validate the + Security Health Analytics custom module against. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules sha simulate + diff --git a/gcloud/alpha/scc/manage/custom-modules/sha/update b/gcloud/alpha/scc/manage/custom-modules/sha/update new file mode 100644 index 000000000..1fc676c69 --- /dev/null +++ b/gcloud/alpha/scc/manage/custom-modules/sha/update @@ -0,0 +1,74 @@ +NAME + gcloud alpha scc manage custom-modules sha update - update a Security + Health Analytics custom module + +SYNOPSIS + gcloud alpha scc manage custom-modules sha update MODULE_ID_OR_NAME + (--custom-config-file=CUSTOM_CONFIG_FILE + --enablement-state=ENABLEMENT_STATE) [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To update an Security Health Analytics custom module with ID 123456 for + organization 123, run: + + $ gcloud alpha scc manage custom-modules sha update 123456 \ + --organization=organizations/123 --enablement-state="ENABLED" \ + --custom-config-file=custom_config.yaml + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/securityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +REQUIRED FLAGS + At least one of these must be specified: + + --custom-config-file=CUSTOM_CONFIG_FILE + Path to a YAML file that contains the custom config to set for the + module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Security Health Analytics custom + module. Valid options are ENABLED, DISABLED, OR INHERITED. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails with API permission errors despite specifying the correct + project, you might be trying to access an API with an invitation-only early + access allowlist. This variant is also available: + + $ gcloud scc manage custom-modules sha update + diff --git a/gcloud/alpha/scc/manage/help b/gcloud/alpha/scc/manage/help new file mode 100644 index 000000000..6620ca28b --- /dev/null +++ b/gcloud/alpha/scc/manage/help @@ -0,0 +1,29 @@ +NAME + gcloud alpha scc manage - manage Cloud SCC (Security Command Center) + settings + +SYNOPSIS + gcloud alpha scc manage GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (ALPHA) Manage Cloud SCC (Security Command Center) settings. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + custom-modules + (ALPHA) Manage Cloud SCC (Security Command Center) custom modules. + +NOTES + This command is currently in alpha and might change without notice. If this + command fails 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 scc manage + diff --git a/gcloud/alpha/service-extensions/help b/gcloud/alpha/service-extensions/help index 057b83e95..7b4cfbb22 100644 --- a/gcloud/alpha/service-extensions/help +++ b/gcloud/alpha/service-extensions/help @@ -34,7 +34,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions $ gcloud beta service-extensions diff --git a/gcloud/alpha/service-extensions/lb-route-extensions/delete b/gcloud/alpha/service-extensions/lb-route-extensions/delete index f85749bd3..e3280228c 100644 --- a/gcloud/alpha/service-extensions/lb-route-extensions/delete +++ b/gcloud/alpha/service-extensions/lb-route-extensions/delete @@ -70,7 +70,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-route-extensions delete $ gcloud beta service-extensions lb-route-extensions delete diff --git a/gcloud/alpha/service-extensions/lb-route-extensions/describe b/gcloud/alpha/service-extensions/lb-route-extensions/describe index 0f61aa3ba..76158b86d 100644 --- a/gcloud/alpha/service-extensions/lb-route-extensions/describe +++ b/gcloud/alpha/service-extensions/lb-route-extensions/describe @@ -64,7 +64,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-route-extensions describe $ gcloud beta service-extensions lb-route-extensions describe diff --git a/gcloud/alpha/service-extensions/lb-route-extensions/help b/gcloud/alpha/service-extensions/lb-route-extensions/help index cd172d92f..4fec42eb2 100644 --- a/gcloud/alpha/service-extensions/lb-route-extensions/help +++ b/gcloud/alpha/service-extensions/lb-route-extensions/help @@ -33,7 +33,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-route-extensions $ gcloud beta service-extensions lb-route-extensions diff --git a/gcloud/alpha/service-extensions/lb-route-extensions/import b/gcloud/alpha/service-extensions/lb-route-extensions/import index f004446b1..811728179 100644 --- a/gcloud/alpha/service-extensions/lb-route-extensions/import +++ b/gcloud/alpha/service-extensions/lb-route-extensions/import @@ -81,7 +81,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-route-extensions import $ gcloud beta service-extensions lb-route-extensions import diff --git a/gcloud/alpha/service-extensions/lb-route-extensions/list b/gcloud/alpha/service-extensions/lb-route-extensions/list index 4a5334023..aed5a7c8d 100644 --- a/gcloud/alpha/service-extensions/lb-route-extensions/list +++ b/gcloud/alpha/service-extensions/lb-route-extensions/list @@ -86,7 +86,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-route-extensions list $ gcloud beta service-extensions lb-route-extensions list diff --git a/gcloud/alpha/service-extensions/lb-traffic-extensions/delete b/gcloud/alpha/service-extensions/lb-traffic-extensions/delete index 2fe383211..d21a991a5 100644 --- a/gcloud/alpha/service-extensions/lb-traffic-extensions/delete +++ b/gcloud/alpha/service-extensions/lb-traffic-extensions/delete @@ -70,7 +70,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-traffic-extensions delete $ gcloud beta service-extensions lb-traffic-extensions delete diff --git a/gcloud/alpha/service-extensions/lb-traffic-extensions/describe b/gcloud/alpha/service-extensions/lb-traffic-extensions/describe index e05c317d0..0027f8f45 100644 --- a/gcloud/alpha/service-extensions/lb-traffic-extensions/describe +++ b/gcloud/alpha/service-extensions/lb-traffic-extensions/describe @@ -64,7 +64,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-traffic-extensions describe $ gcloud beta service-extensions lb-traffic-extensions describe diff --git a/gcloud/alpha/service-extensions/lb-traffic-extensions/help b/gcloud/alpha/service-extensions/lb-traffic-extensions/help index 6ffdc55a0..4f800359a 100644 --- a/gcloud/alpha/service-extensions/lb-traffic-extensions/help +++ b/gcloud/alpha/service-extensions/lb-traffic-extensions/help @@ -33,7 +33,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-traffic-extensions $ gcloud beta service-extensions lb-traffic-extensions diff --git a/gcloud/alpha/service-extensions/lb-traffic-extensions/import b/gcloud/alpha/service-extensions/lb-traffic-extensions/import index c3ae5b5e2..8fcd27766 100644 --- a/gcloud/alpha/service-extensions/lb-traffic-extensions/import +++ b/gcloud/alpha/service-extensions/lb-traffic-extensions/import @@ -81,7 +81,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-traffic-extensions import $ gcloud beta service-extensions lb-traffic-extensions import diff --git a/gcloud/alpha/service-extensions/lb-traffic-extensions/list b/gcloud/alpha/service-extensions/lb-traffic-extensions/list index 6ee3321cd..98e15afaa 100644 --- a/gcloud/alpha/service-extensions/lb-traffic-extensions/list +++ b/gcloud/alpha/service-extensions/lb-traffic-extensions/list @@ -86,7 +86,9 @@ NOTES This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early - access allowlist. This variant is also available: + access allowlist. These variants are also available: + + $ gcloud service-extensions lb-traffic-extensions list $ gcloud beta service-extensions lb-traffic-extensions list diff --git a/gcloud/alpha/sql/operations/list b/gcloud/alpha/sql/operations/list index 2265584a7..e88f20ce6 100644 --- a/gcloud/alpha/sql/operations/list +++ b/gcloud/alpha/sql/operations/list @@ -3,7 +3,7 @@ NAME given Cloud SQL instance SYNOPSIS - gcloud alpha sql operations list --instance=INSTANCE, -i INSTANCE + gcloud alpha sql operations list [--instance=INSTANCE, -i INSTANCE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -27,7 +27,7 @@ EXAMPLES $ gcloud alpha sql operations list --instance=prod-instance \ --page-size=10 -REQUIRED FLAGS +FLAGS --instance=INSTANCE, -i INSTANCE Cloud SQL instance ID. diff --git a/gcloud/alpha/storage/restore b/gcloud/alpha/storage/restore index 40268278a..115efbebd 100644 --- a/gcloud/alpha/storage/restore +++ b/gcloud/alpha/storage/restore @@ -15,21 +15,29 @@ DESCRIPTION $ gcloud alpha storage restore url... EXAMPLES - Restore specific version of object in a bucket. Note: Generation number is - required. + Restore latest soft-deleted version of object in a bucket. + + $ gcloud alpha storage restore gs://bucket/file1.txt + + Restore a specific soft-deleted version of object in a bucket by specifying + the generation. $ gcloud alpha storage restore gs://bucket/file1.txt#123 - Restore two objects in a bucket: + Restore all soft-deleted versions of object in a bucket. - $ gcloud alpha storage restore gs://bucket/file1.txt#123 \ + $ gcloud alpha storage restore gs://bucket/file1.txt --all-versions + + Restore several objects in a bucket (with or without generation): + + $ gcloud alpha storage restore gs://bucket/file1.txt \ gs://bucket/file2.txt#456 - Restore all text objects in a bucket: + Restore the latest soft-deleted version of all text objects in a bucket: $ gcloud alpha storage restore gs://bucket/**.txt - Read list of files to restore from stdin: + Restore a list of objects read from stdin (with or without generation): $ cat list-of-files.txt | gcloud alpha storage restore \ --read-paths-from-stdin diff --git a/gcloud/beta/ai/indexes/upsert-datapoints b/gcloud/beta/ai/indexes/upsert-datapoints index 251f9446c..df2ac8145 100644 --- a/gcloud/beta/ai/indexes/upsert-datapoints +++ b/gcloud/beta/ai/indexes/upsert-datapoints @@ -4,7 +4,8 @@ NAME SYNOPSIS gcloud beta ai indexes upsert-datapoints (INDEX : --region=REGION) - --datapoints-from-file=DATAPOINTS_FROM_FILE [GCLOUD_WIDE_FLAG ...] + --datapoints-from-file=DATAPOINTS_FROM_FILE + [--update-mask=[UPDATE_MASK_PATH,...]] [GCLOUD_WIDE_FLAG ...] EXAMPLES To upsert datapoints into an index 123, run: @@ -51,6 +52,17 @@ REQUIRED FLAGS Path to a local JSON file that contains the data points that need to be added to the index. +OPTIONAL FLAGS + --update-mask=[UPDATE_MASK_PATH,...] + Update mask is used to specify the fields to be overwritten in the + datapoints by the update. The fields specified in the update_mask are + relative to each IndexDatapoint inside datapoints, not the full + request. + + Updatable fields: + ◆ Use --update-mask=all_restricts to update both restricts and + numeric_restricts. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/builds/connections/create/bitbucket-cloud b/gcloud/beta/builds/connections/create/bitbucket-cloud new file mode 100644 index 000000000..a5c141590 --- /dev/null +++ b/gcloud/beta/builds/connections/create/bitbucket-cloud @@ -0,0 +1,109 @@ +NAME + gcloud beta builds connections create bitbucket-cloud - create a Cloud + Build Connection for Bitbucket Cloud + +SYNOPSIS + gcloud beta builds connections create bitbucket-cloud + (CONNECTION : --region=REGION) + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + --workspace=WORKSPACE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Build Connection for Bitbucket Cloud. + + A Bitbucket Cloud Connection can be created by using a + repository/project/workspace access token with + repository_read,repository_admin, pullrequest_read, webhook scope + permission and a repository/project/workspace access token with + repository_read scope permission. + +EXAMPLES + To create a Bitbucket Cloud connection, provide all the required + parameters: + + $ gcloud beta builds connections create bitbucket-cloud \ + my-bitbucket-conn --project=myproj --region=us-central1 \ + --workspace=my-workspace \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection to create. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read,repository_admin, + pullrequest_read, webhook repository/project/workspace access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read repository/project/workspace + access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Cloud. + + --workspace=WORKSPACE + Workspace of the Bitbucket Cloud instance. + +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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds connections create bitbucket-cloud + + $ gcloud alpha builds connections create bitbucket-cloud + diff --git a/gcloud/beta/builds/connections/create/bitbucket-data-center b/gcloud/beta/builds/connections/create/bitbucket-data-center new file mode 100644 index 000000000..9033c4083 --- /dev/null +++ b/gcloud/beta/builds/connections/create/bitbucket-data-center @@ -0,0 +1,140 @@ +NAME + gcloud beta builds connections create bitbucket-data-center - create a + Cloud Build Connection for Bitbucket Data Center + +SYNOPSIS + gcloud beta builds connections create bitbucket-data-center + (CONNECTION : --region=REGION) + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION [--async] + [--host-uri=HOST_URI] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE + : --ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a Cloud Build Connection for Bitbucket Data Center. + + A Bitbucket Data Center Connection can be created by using a personal + access token with REPO_ADMIN scope permission. A REPO_READ scoped personal + access token will also be required. + + If the Bitbucket Data Center can only be accessed within a VPC, a Service + Directory service resource can be provided for connecting to it. + +EXAMPLES + To create a Bitbucket Data Center connection, provide all the required + parameters: + + $ gcloud beta builds connections create bitbucket-data-center \ + my-bitbucket-conn --project=myproj --region=us-central1 \ + --host-uri=https://bitbucket-server.net \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + + To create a Bitbucket Data Center connection for a private Bitbucket Data + Center server. Provide the service-directory-service and ssl-ca-file as + well: + + $ gcloud beta builds connections create bitbucket-data-center \ + my-private-bitbucket-conn \ + --host-uri=https://my.private-bitbucket-server.net \ + --project=myproj --region=us-central1 \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds --ssl-ca-file=mycertificate.crt \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection to create. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_ADMIN personal access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_READ personal access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Data Center. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --host-uri=HOST_URI + URI of the Bitbucket Data Center instance. + + Group of arguments for configuring access through Service Directory. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the Bitbucket + Data Center. Necessary only if the server has no public access from + the internet. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --ssl-ca-file=SSL_CA_FILE + File containing the SSL_CA to be used. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds connections create bitbucket-data-center + + $ gcloud alpha builds connections create bitbucket-data-center + diff --git a/gcloud/beta/builds/connections/create/help b/gcloud/beta/builds/connections/create/help index 11317f047..6702b24dc 100644 --- a/gcloud/beta/builds/connections/create/help +++ b/gcloud/beta/builds/connections/create/help @@ -16,6 +16,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (BETA) Create a Cloud Build Connection for Bitbucket Cloud. + + bitbucket-data-center + (BETA) Create a Cloud Build Connection for Bitbucket Data Center. + github (BETA) Create a Cloud Build Connection of type GitHub. diff --git a/gcloud/beta/builds/connections/update/bitbucket-cloud b/gcloud/beta/builds/connections/update/bitbucket-cloud new file mode 100644 index 000000000..8950430b5 --- /dev/null +++ b/gcloud/beta/builds/connections/update/bitbucket-cloud @@ -0,0 +1,104 @@ +NAME + gcloud beta builds connections update bitbucket-cloud - update a Cloud + Build Connection of type Bitbucket Cloud + +SYNOPSIS + gcloud beta builds connections update bitbucket-cloud + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [--read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION] + [--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION] + [--workspace=WORKSPACE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Cloud Build Connection of type Bitbucket Cloud. + +EXAMPLES + To update the workspace, provide the connection name and the workspace + name: + + $ gcloud beta builds connections update bitbucket-cloud \ + my-bbc-conn --region=us-west1 --workspace=my-workspace + + To update the authorization token, provide the connection name and the new + authorization token secret version. + + $ gcloud beta builds connections update bitbucket-cloud \ + my-bbc-conn --region=us-west1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection 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 connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read,repository_admin, + pullrequest_read, webhook access token. It can be a repository, project + or workspace access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read access token. It can be a + repository, project or workspace access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Cloud. + + --workspace=WORKSPACE + Workspace of the Bitbucket Cloud instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds connections update bitbucket-cloud + + $ gcloud alpha builds connections update bitbucket-cloud + diff --git a/gcloud/beta/builds/connections/update/bitbucket-data-center b/gcloud/beta/builds/connections/update/bitbucket-data-center new file mode 100644 index 000000000..0266920a0 --- /dev/null +++ b/gcloud/beta/builds/connections/update/bitbucket-data-center @@ -0,0 +1,105 @@ +NAME + gcloud beta builds connections update bitbucket-data-center - update a + Cloud Build Connection of type Bitbucket Data Center + +SYNOPSIS + gcloud beta builds connections update bitbucket-data-center + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [--host-uri=HOST_URI] + [--read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE] + [--ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Update a Cloud Build Connection of type Bitbucket Data Center. + +EXAMPLES + To update the ssl_ca, provide the connection name and the ssl_ca file: + + $ gcloud beta builds connections update bitbucket-data-center \ + my-gle-conn --region=us-west1 --ssl-ca-file=mycertificate.crt + + To update the authorization token, provide the connection name and the new + authorization token secret version name. + + $ gcloud beta builds connections update bitbucket-data-center \ + my-gle-conn --region=us-west1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection 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 connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_ADMIN personal access token. + + --host-uri=HOST_URI + URI of the Bitbucket Data Center instance. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_READ personal access token. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the Bitbucket + Data Center. Necessary only if the server has no public access from the + internet. + + --ssl-ca-file=SSL_CA_FILE + File containing the SSL_CA to be used. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud builds connections update bitbucket-data-center + + $ gcloud alpha builds connections update bitbucket-data-center + diff --git a/gcloud/beta/builds/connections/update/help b/gcloud/beta/builds/connections/update/help index 26a5da5ef..3fbf7f023 100644 --- a/gcloud/beta/builds/connections/update/help +++ b/gcloud/beta/builds/connections/update/help @@ -16,6 +16,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (BETA) Update a Cloud Build Connection of type Bitbucket Cloud. + + bitbucket-data-center + (BETA) Update a Cloud Build Connection of type Bitbucket Data Center. + github (BETA) Update a Cloud Build Connection of type GitHub. diff --git a/gcloud/beta/builds/triggers/create/bitbucket-cloud b/gcloud/beta/builds/triggers/create/bitbucket-cloud new file mode 100644 index 000000000..f73756478 --- /dev/null +++ b/gcloud/beta/builds/triggers/create/bitbucket-cloud @@ -0,0 +1,223 @@ +NAME + gcloud beta builds triggers create bitbucket-cloud - create a build trigger + for a 2nd-gen Bitbucket Cloud repository + +SYNOPSIS + gcloud beta builds triggers create bitbucket-cloud + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR; default="/"]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a build trigger for a 2nd-gen Bitbucket Cloud repository. + +EXAMPLES + To create a push trigger with a 2nd-gen repository for all branches: + + $ gcloud beta builds triggers create bitbucket-cloud \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" --region=us-central1 + + To create a pull request trigger with a 2nd-gen repository for main: + + $ gcloud beta builds triggers create bitbucket-cloud \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --build-config="cloudbuild.yaml" \ + --pull-request-pattern="^main$" --region=us-central1 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. Note: Region must be specified in 2nd gen repo; global is + not supported. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. For + example: + + $ gcloud beta builds triggers create bitbucket-cloud ... \ + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Substitutions can be applied to user-defined variables (starting + with an underscore) and to the following built-in variables: + REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, + SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers create bitbucket-cloud + + $ gcloud alpha builds triggers create bitbucket-cloud + diff --git a/gcloud/beta/builds/triggers/create/bitbucket-data-center b/gcloud/beta/builds/triggers/create/bitbucket-data-center new file mode 100644 index 000000000..98dfbc81c --- /dev/null +++ b/gcloud/beta/builds/triggers/create/bitbucket-data-center @@ -0,0 +1,224 @@ +NAME + gcloud beta builds triggers create bitbucket-data-center - create a build + trigger for a 2nd-gen Bitbucket Data Center repository + +SYNOPSIS + gcloud beta builds triggers create bitbucket-data-center + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR; default="/"]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Create a build trigger for a 2nd-gen Bitbucket Data Center + repository. + +EXAMPLES + To create a push trigger with a 2nd-gen repository for all branches: + + $ gcloud beta builds triggers create bitbucket-data-center \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" --region=us-central1 + + To create a pull request trigger with a 2nd-gen repository for main: + + $ gcloud beta builds triggers create bitbucket-data-center \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --build-config="cloudbuild.yaml" \ + --pull-request-pattern="^main$" --region=us-central1 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. Note: Region must be specified in 2nd gen repo; global is + not supported. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. For + example: + + $ gcloud beta builds triggers create bitbucket-data-center ... \ + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Substitutions can be applied to user-defined variables (starting + with an underscore) and to the following built-in variables: + REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, + SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers create bitbucket-data-center + + $ gcloud alpha builds triggers create bitbucket-data-center + diff --git a/gcloud/beta/builds/triggers/create/help b/gcloud/beta/builds/triggers/create/help index cb1b5ebef..57db58fa3 100644 --- a/gcloud/beta/builds/triggers/create/help +++ b/gcloud/beta/builds/triggers/create/help @@ -16,6 +16,13 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (BETA) Create a build trigger for a 2nd-gen Bitbucket Cloud repository. + + bitbucket-data-center + (BETA) Create a build trigger for a 2nd-gen Bitbucket Data Center + repository. + bitbucketserver (BETA) Create a build trigger for a Bitbucket Server repository. diff --git a/gcloud/beta/builds/triggers/update/bitbucket-cloud b/gcloud/beta/builds/triggers/update/bitbucket-cloud new file mode 100644 index 000000000..17538e215 --- /dev/null +++ b/gcloud/beta/builds/triggers/update/bitbucket-cloud @@ -0,0 +1,253 @@ +NAME + gcloud beta builds triggers update bitbucket-cloud - updates Bitbucket + Cloud trigger used by Cloud Build + +SYNOPSIS + gcloud beta builds triggers update bitbucket-cloud + (TRIGGER : --region=REGION) + (--trigger-config=PATH | --description=DESCRIPTION + --ignored-files=[GLOB,...] --included-files=[GLOB,...] + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --branch-pattern=REGEX + | --tag-pattern=REGEX | --comment-control=COMMENT_CONTROL + --pull-request-pattern=REGEX --build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR] --clear-substitutions + | --remove-substitutions=[KEY,...] + | --update-substitutions=[KEY=VALUE,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Updates Bitbucket Cloud trigger used by Cloud Build. + +EXAMPLES + To update the branch pattern of the trigger: + + $ gcloud beta builds triggers update bitbucket-cloud my-trigger \ + --branch-pattern=".*" + + To update the build config of the trigger: + + $ gcloud beta builds triggers update bitbucket-cloud my-trigger \ + --build-config="cloudbuild.yaml" + + To update the substitutions of the trigger: + + $ gcloud beta builds triggers update bitbucket-cloud my-trigger \ + --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master + + To update the 2nd-gen repository resource of the trigger: + + $ gcloud beta builds triggers update bitbucket-cloud my-trigger \ + --repository=projects/my-project/locations/us-west1/\ + connections/my-conn/repositories/my-repo + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument TRIGGER on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. + + To set the trigger attribute: + ▸ provide the argument TRIGGER on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Cloud location for the trigger. + + To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + At most one of these can be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --comment-control=COMMENT_CONTROL + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regular expression search for the + base branch (the branch you are trying to merge into) for pull + request updates. For example, --pull-request-pattern=foo will + match "foo", "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + At most one of these can be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + At most one of these can be specified: + + --clear-substitutions + Clear existing substitutions. + + --remove-substitutions=[KEY,...] + Remove existing substitutions if present. + + --update-substitutions=[KEY=VALUE,...] + Update or add to existing substitutions. Substitutions are + parameters to be substituted or add in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers update ... + --update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will add the provided substitutions to the existing + substitutions and results in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/build-config-file-schema#substitutions + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers update bitbucket-cloud + + $ gcloud alpha builds triggers update bitbucket-cloud + diff --git a/gcloud/beta/builds/triggers/update/bitbucket-data-center b/gcloud/beta/builds/triggers/update/bitbucket-data-center new file mode 100644 index 000000000..feac36aaf --- /dev/null +++ b/gcloud/beta/builds/triggers/update/bitbucket-data-center @@ -0,0 +1,255 @@ +NAME + gcloud beta builds triggers update bitbucket-data-center - updates + Bitbucket Data Center trigger used by Cloud Build + +SYNOPSIS + gcloud beta builds triggers update bitbucket-data-center + (TRIGGER : --region=REGION) + (--trigger-config=PATH | --description=DESCRIPTION + --ignored-files=[GLOB,...] --included-files=[GLOB,...] + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --branch-pattern=REGEX + | --tag-pattern=REGEX | --comment-control=COMMENT_CONTROL + --pull-request-pattern=REGEX --build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR] --clear-substitutions + | --remove-substitutions=[KEY,...] + | --update-substitutions=[KEY=VALUE,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + (BETA) Updates Bitbucket Data Center trigger used by Cloud Build. + +EXAMPLES + To update the branch pattern of the trigger: + + $ gcloud beta builds triggers update bitbucket-data-center \ + my-trigger --branch-pattern=".*" + + To update the build config of the trigger: + + $ gcloud beta builds triggers update bitbucket-data-center \ + my-trigger --build-config="cloudbuild.yaml" + + To update the substitutions of the trigger: + + $ gcloud beta builds triggers update bitbucket-data-center \ + my-trigger \ + --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master + + To update the 2nd-gen repository resource of the trigger: + + $ gcloud beta builds triggers update bitbucket-data-center \ + my-trigger \ + --repository=projects/my-project/locations/us-west1/\ + connections/my-conn/repositories/my-repo + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument TRIGGER on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. + + To set the trigger attribute: + ▸ provide the argument TRIGGER on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Cloud location for the trigger. + + To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + At most one of these can be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --comment-control=COMMENT_CONTROL + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regular expression search for the + base branch (the branch you are trying to merge into) for pull + request updates. For example, --pull-request-pattern=foo will + match "foo", "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + At most one of these can be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + At most one of these can be specified: + + --clear-substitutions + Clear existing substitutions. + + --remove-substitutions=[KEY,...] + Remove existing substitutions if present. + + --update-substitutions=[KEY=VALUE,...] + Update or add to existing substitutions. Substitutions are + parameters to be substituted or add in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers update ... + --update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will add the provided substitutions to the existing + substitutions and results in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/build-config-file-schema#substitutions + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 builds triggers update bitbucket-data-center + + $ gcloud alpha builds triggers update bitbucket-data-center + diff --git a/gcloud/beta/builds/triggers/update/help b/gcloud/beta/builds/triggers/update/help index fbf2bf5db..ba0c8cba5 100644 --- a/gcloud/beta/builds/triggers/update/help +++ b/gcloud/beta/builds/triggers/update/help @@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + (BETA) Updates Bitbucket Cloud trigger used by Cloud Build. + + bitbucket-data-center + (BETA) Updates Bitbucket Data Center trigger used by Cloud Build. + bitbucketserver (BETA) Updates Bitbucket Server trigger used by Cloud Build. diff --git a/gcloud/beta/certificate-manager/dns-authorizations/create b/gcloud/beta/certificate-manager/dns-authorizations/create index 97cc08cd0..edbc6acb9 100644 --- a/gcloud/beta/certificate-manager/dns-authorizations/create +++ b/gcloud/beta/certificate-manager/dns-authorizations/create @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud beta certificate-manager dns-authorizations create (DNS_AUTHORIZATION : --location=LOCATION) --domain=DOMAIN [--async] - [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--type=TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -70,6 +70,10 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. + --type=TYPE + Type of the DNS authorization. TYPE must be one of: fixed-record, + per-project-record, type-unspecified. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/composer/environments/create b/gcloud/beta/composer/environments/create index 5831f4be5..42c065e29 100644 --- a/gcloud/beta/composer/environments/create +++ b/gcloud/beta/composer/environments/create @@ -388,10 +388,12 @@ FLAGS At most one of these can be specified: --disable-cloud-data-lineage-integration - Disable Cloud Data Lineage integration. + Disable Cloud Data Lineage integration, supported for Composer 2 + Environments. --enable-cloud-data-lineage-integration - Enable Cloud Data Lineage integration. + Enable Cloud Data Lineage integration, supported for Composer 2 + Environments. Master Authorized Networks configuration diff --git a/gcloud/beta/composer/environments/update b/gcloud/beta/composer/environments/update index c09954358..f166aa280 100644 --- a/gcloud/beta/composer/environments/update +++ b/gcloud/beta/composer/environments/update @@ -170,10 +170,12 @@ REQUIRED FLAGS At most one of these can be specified: --disable-cloud-data-lineage-integration - Disable Cloud Data Lineage integration. + Disable Cloud Data Lineage integration, supported for Composer 2 + Environments. --enable-cloud-data-lineage-integration - Enable Cloud Data Lineage integration. + Enable Cloud Data Lineage integration, supported for Composer 2 + Environments. Group of arguments for setting master authorized networks configuration. diff --git a/gcloud/beta/compute/commitments/create b/gcloud/beta/compute/commitments/create index fec2edb21..b14f5632e 100644 --- a/gcloud/beta/compute/commitments/create +++ b/gcloud/beta/compute/commitments/create @@ -104,7 +104,7 @@ OPTIONAL FLAGS compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, general-purpose-e2, general-purpose-n2, general-purpose-n2d, general-purpose-t2d, graphics-optimized, - memory-optimized, memory-optimized-m3. + memory-optimized, memory-optimized-m3, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/beta/compute/images/export b/gcloud/beta/compute/images/export index 8b21e6b99..b834ba200 100644 --- a/gcloud/beta/compute/images/export +++ b/gcloud/beta/compute/images/export @@ -53,22 +53,22 @@ OPTIONAL FLAGS complete. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/beta/compute/images/import b/gcloud/beta/compute/images/import index de9a1913b..904571b29 100644 --- a/gcloud/beta/compute/images/import +++ b/gcloud/beta/compute/images/import @@ -147,22 +147,22 @@ OPTIONAL FLAGS complete. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/beta/compute/instances/import b/gcloud/beta/compute/instances/import index 5c8f03e82..9d4263668 100644 --- a/gcloud/beta/compute/instances/import +++ b/gcloud/beta/compute/instances/import @@ -91,22 +91,22 @@ OPTIONAL FLAGS non-matching destination or source IP addresses. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/beta/compute/machine-images/import b/gcloud/beta/compute/machine-images/import index 3552b418f..4c41179d8 100644 --- a/gcloud/beta/compute/machine-images/import +++ b/gcloud/beta/compute/machine-images/import @@ -90,22 +90,22 @@ OPTIONAL FLAGS addresses. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/beta/container/binauthz/policy/evaluate b/gcloud/beta/container/binauthz/policy/evaluate new file mode 100644 index 000000000..f477baff5 --- /dev/null +++ b/gcloud/beta/container/binauthz/policy/evaluate @@ -0,0 +1,78 @@ +NAME + gcloud beta container binauthz policy evaluate - evaluate a Binary + Authorization platform policy + +SYNOPSIS + gcloud beta container binauthz policy evaluate + (POLICY_RESOURCE_NAME : --platform=PLATFORM) + (--image=IMAGE | --resource=RESOURCE) [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To evaluate a policy using its resource name: + + $ gcloud beta container binauthz policy evaluate \ + projects/my-proj/platforms/gke/policies/my-policy \ + --resource=$KUBERNETES_RESOURCE + + To evaluate the same policy using flags against an image: + + $ gcloud beta container binauthz policy evaluate my-policy \ + --platform=gke --project=my-proj --image=$IMAGE + +POSITIONAL ARGUMENTS + Policy resource - The resource name of the policy to evaluate. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument policy_resource_name on the command line with a + fully specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + POLICY_RESOURCE_NAME + ID of the policy or fully qualified identifier for the policy. + + To set the policy attribute: + ▸ provide the argument policy_resource_name on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --platform=PLATFORM + The platform that the policy belongs to. PLATFORM must be one of the + following: cloudRun, gke. + + To set the platform attribute: + ▸ provide the argument policy_resource_name on the command line + with a fully specified name; + ▸ provide the argument --platform on the command line. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --image=IMAGE + The image to evaluate. If the policy being evaluated has scoped + checksets, this mode of evaluation will always use the default + (unscoped) checkset. + + --resource=RESOURCE + The JSON or YAML file containing the Kubernetes resource to evaluate. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 binauthz policy evaluate + diff --git a/gcloud/beta/container/binauthz/policy/help b/gcloud/beta/container/binauthz/policy/help index c454c3602..3f8d8c961 100644 --- a/gcloud/beta/container/binauthz/policy/help +++ b/gcloud/beta/container/binauthz/policy/help @@ -28,6 +28,9 @@ COMMANDS describe (BETA) Describe a Binary Authorization platform policy. + evaluate + (BETA) Evaluate a Binary Authorization platform policy. + export (BETA) Export the Binary Authorization policy for the current project. diff --git a/gcloud/beta/container/clusters/create b/gcloud/beta/container/clusters/create index 124a09585..6aea94961 100644 --- a/gcloud/beta/container/clusters/create +++ b/gcloud/beta/container/clusters/create @@ -23,12 +23,12 @@ SYNOPSIS [--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE] [--disable-default-snat] [--disable-pod-cidr-overprovision] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autorepair] - [--no-enable-autoupgrade] [--enable-cloud-logging] - [--enable-cloud-monitoring] [--enable-cloud-run-alpha] - [--enable-confidential-nodes] [--enable-confidential-storage] - [--enable-cost-allocation] [--enable-dataplane-v2] [--enable-fleet] - [--enable-fqdn-network-policy] [--enable-gke-oidc] - [--enable-google-cloud-access] [--enable-gvnic] + [--no-enable-autoupgrade] [--enable-cilium-clusterwide-network-policy] + [--enable-cloud-logging] [--enable-cloud-monitoring] + [--enable-cloud-run-alpha] [--enable-confidential-nodes] + [--enable-confidential-storage] [--enable-cost-allocation] + [--enable-dataplane-v2] [--enable-fleet] [--enable-fqdn-network-policy] + [--enable-gke-oidc] [--enable-google-cloud-access] [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] @@ -297,8 +297,8 @@ FLAGS ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used with '--create-subnetwork' option. --cluster-version=CLUSTER_VERSION The Kubernetes version to use for the master and nodes. Defaults to @@ -343,8 +343,8 @@ FLAGS $ gcloud beta container clusters create \ --create-subnetwork name=my-subnet - Can not be specified unless '--enable-ip-alias' is also specified. Can - not be used in conjunction with the '--subnetwork' option. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used in conjunction with '--subnetwork' option. --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. @@ -423,6 +423,10 @@ FLAGS Enabled by default, use --no-enable-autoupgrade to disable. + --enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Disabled by + default. + --enable-cloud-logging (DEPRECATED) Automatically send logs from the cluster to the Google Cloud Logging API. @@ -1106,15 +1110,16 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Can not be specified unless '--enable-ip-alias' is also specified. + Cannot be specified unless '--enable-ip-alias' option is also + specified. --services-secondary-range-name=NAME Set the secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used with '--create-subnetwork' option. --shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the diff --git a/gcloud/beta/container/clusters/create-auto b/gcloud/beta/container/clusters/create-auto index d9e026533..528c06bcc 100644 --- a/gcloud/beta/container/clusters/create-auto +++ b/gcloud/beta/container/clusters/create-auto @@ -12,8 +12,8 @@ SYNOPSIS [--cluster-version=CLUSTER_VERSION] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] - [--enable-backup-restore] [--enable-fleet] - [--enable-google-cloud-access] + [--enable-backup-restore] [--enable-cilium-clusterwide-network-policy] + [--enable-fleet] [--enable-google-cloud-access] [--enable-kubernetes-unstable-apis=API,[API,...]] [--enable-master-global-access] [--enable-secret-manager] [--fleet-project=PROJECT_ID_OR_NUMBER] [--labels=[KEY=VALUE,...]] @@ -127,8 +127,7 @@ FLAGS ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be used with '--create-subnetwork' option. --cluster-version=CLUSTER_VERSION The Kubernetes version to use for the master and nodes. Defaults to @@ -173,8 +172,7 @@ FLAGS $ gcloud beta container clusters create-auto \ --create-subnetwork name=my-subnet - Can not be specified unless '--enable-ip-alias' is also specified. Can - not be used in conjunction with the '--subnetwork' option. + Cannot be used in conjunction with '--subnetwork' option. --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. @@ -191,6 +189,10 @@ FLAGS To learn more, see the Backup for GKE overview: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/concepts/backup-for-gke. + --enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Disabled by + default. + --enable-fleet Set cluster project as the fleet host project. This will register the cluster to the same project. To register the cluster to a fleet in a @@ -345,15 +347,12 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Can not be specified unless '--enable-ip-alias' is also specified. - --services-secondary-range-name=NAME Set the secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be used with '--create-subnetwork' option. --subnetwork=SUBNETWORK The Google Compute Engine subnetwork diff --git a/gcloud/beta/container/clusters/update b/gcloud/beta/container/clusters/update index 88012c48f..71009ebc1 100644 --- a/gcloud/beta/container/clusters/update +++ b/gcloud/beta/container/clusters/update @@ -11,6 +11,7 @@ SYNOPSIS | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling + | --[no-]enable-cilium-clusterwide-network-policy | --enable-cost-allocation | --enable-fleet | --enable-fqdn-network-policy | --enable-gke-oidc | --enable-google-cloud-access | --enable-identity-service @@ -245,6 +246,11 @@ REQUIRED FLAGS default node pool if --node-pool is not provided. If not already, --max-nodes or --total-max-nodes must also be set. + --[no-]enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Use + --enable-cilium-clusterwide-network-policy to enable and + --no-enable-cilium-clusterwide-network-policy to disable. + --enable-cost-allocation Enable the cost management feature. diff --git a/gcloud/beta/container/fleet/memberships/bindings/list b/gcloud/beta/container/fleet/memberships/bindings/list index 2d92ae751..9e749ea9a 100644 --- a/gcloud/beta/container/fleet/memberships/bindings/list +++ b/gcloud/beta/container/fleet/memberships/bindings/list @@ -26,8 +26,7 @@ EXAMPLES where the Binding belongs along with membership name. $ gcloud beta container fleet memberships bindings list \ - BINDING_NAME --membership=MEMBERSHIP_NAME \ - --location=LOCATION_NAME + --membership=MEMBERSHIP_NAME --location=LOCATION_NAME REQUIRED FLAGS --membership=MEMBERSHIP diff --git a/gcloud/beta/container/fleet/scopes/help b/gcloud/beta/container/fleet/scopes/help index 26af13ed4..a1c81edf7 100644 --- a/gcloud/beta/container/fleet/scopes/help +++ b/gcloud/beta/container/fleet/scopes/help @@ -41,7 +41,7 @@ COMMANDS (BETA) Get the IAM policy for a Fleet Scope. list - (BETA) List fleet scopes. + (BETA) List fleet scopes in a project. remove-iam-policy-binding (BETA) Remove IAM policy binding of a Fleet Scope. diff --git a/gcloud/beta/container/fleet/scopes/list b/gcloud/beta/container/fleet/scopes/list index a85b6264c..233f98d8e 100644 --- a/gcloud/beta/container/fleet/scopes/list +++ b/gcloud/beta/container/fleet/scopes/list @@ -1,5 +1,5 @@ NAME - gcloud beta container fleet scopes list - list fleet scopes + gcloud beta container fleet scopes list - list fleet scopes in a project SYNOPSIS gcloud beta container fleet scopes list [--filter=EXPRESSION] @@ -7,13 +7,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List scopes in a fleet. + (BETA) This command can fail for the following reasons: + ▪ The project specified does not exist. + ▪ The user does not have access to the project specified. EXAMPLES - List scopes in the active project's fleet: + The following command lists scopes in the active project: $ gcloud beta container fleet scopes list + The following command lists scopes in project PROJECT_ID: + + $ gcloud beta container fleet scopes list --project=PROJECT_ID + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. @@ -54,11 +60,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the gkehub/v1beta API. The full documentation for this - API can be found at: - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/container/hub/memberships/bindings/list b/gcloud/beta/container/hub/memberships/bindings/list index 38049d0e4..4eb6f5072 100644 --- a/gcloud/beta/container/hub/memberships/bindings/list +++ b/gcloud/beta/container/hub/memberships/bindings/list @@ -25,7 +25,7 @@ EXAMPLES MEMBERSHIP_NAME, provide the location LOCATION_NAME for the Membership where the Binding belongs along with membership name. - $ gcloud beta container hub memberships bindings list BINDING_NAME \ + $ gcloud beta container hub memberships bindings list \ --membership=MEMBERSHIP_NAME --location=LOCATION_NAME REQUIRED FLAGS diff --git a/gcloud/beta/container/hub/scopes/help b/gcloud/beta/container/hub/scopes/help index 4312533a2..b2ac287c1 100644 --- a/gcloud/beta/container/hub/scopes/help +++ b/gcloud/beta/container/hub/scopes/help @@ -41,7 +41,7 @@ COMMANDS (BETA) Get the IAM policy for a Fleet Scope. list - (BETA) List fleet scopes. + (BETA) List fleet scopes in a project. remove-iam-policy-binding (BETA) Remove IAM policy binding of a Fleet Scope. diff --git a/gcloud/beta/container/hub/scopes/list b/gcloud/beta/container/hub/scopes/list index 6337bc48f..fc3f527f8 100644 --- a/gcloud/beta/container/hub/scopes/list +++ b/gcloud/beta/container/hub/scopes/list @@ -1,5 +1,5 @@ NAME - gcloud beta container hub scopes list - list fleet scopes + gcloud beta container hub scopes list - list fleet scopes in a project SYNOPSIS gcloud beta container hub scopes list [--filter=EXPRESSION] [--limit=LIMIT] @@ -7,13 +7,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) List scopes in a fleet. + (BETA) This command can fail for the following reasons: + ▪ The project specified does not exist. + ▪ The user does not have access to the project specified. EXAMPLES - List scopes in the active project's fleet: + The following command lists scopes in the active project: $ gcloud beta container hub scopes list + The following command lists scopes in project PROJECT_ID: + + $ gcloud beta container hub scopes list --project=PROJECT_ID + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. @@ -54,11 +60,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the gkehub/v1beta API. The full documentation for this - API can be found at: - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES This command is currently in beta and might change without notice. These variants are also available: diff --git a/gcloud/beta/container/node-pools/create b/gcloud/beta/container/node-pools/create index 5ef4c2866..a7cb90d7e 100644 --- a/gcloud/beta/container/node-pools/create +++ b/gcloud/beta/container/node-pools/create @@ -254,12 +254,13 @@ FLAGS disabled. --enable-queued-provisioning - Mark the newly created nodepool as Queued only. This means that all new - nodes can be obtained only through queuing via Cluster Autoscaler - ProvisioningRequest API. + Mark the nodepool as Queued only. This means that all new nodes can be + obtained only through queuing via ProvisioningRequest API. $ gcloud beta container node-pools create node-pool-1 \ --cluster=example-cluster --enable-queued-provisioning + ... and other required parameters, for more details see: + https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest --enable-surge-upgrade Changes node pool upgrade strategy to surge upgrade. diff --git a/gcloud/beta/container/node-pools/update b/gcloud/beta/container/node-pools/update index 4f6e9dd21..20eb3aee0 100644 --- a/gcloud/beta/container/node-pools/update +++ b/gcloud/beta/container/node-pools/update @@ -6,7 +6,8 @@ SYNOPSIS gcloud beta container node-pools update NAME (--enable-confidential-nodes | --enable-gvnic | --enable-image-streaming | --enable-private-nodes - | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT + | --enable-queued-provisioning | --labels=[KEY=VALUE,...] + | --logging-variant=LOGGING_VARIANT | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] @@ -66,6 +67,15 @@ REQUIRED FLAGS IP addresses only, regardless of whether private nodes are enabled or disabled. + --enable-queued-provisioning + Mark the nodepool as Queued only. This means that all new nodes can + be obtained only through queuing via ProvisioningRequest API. + + $ gcloud beta container node-pools update node-pool-1 \ + --cluster=example-cluster --enable-queued-provisioning + ... and other required parameters, for more details see: + https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest + --labels=[KEY=VALUE,...] Labels to apply to the Google Cloud resources of node pools in the Kubernetes Engine cluster. These are unrelated to Kubernetes labels. diff --git a/gcloud/beta/deploy/delivery-pipelines/describe b/gcloud/beta/deploy/delivery-pipelines/describe index d65a3de70..d6117883b 100644 --- a/gcloud/beta/deploy/delivery-pipelines/describe +++ b/gcloud/beta/deploy/delivery-pipelines/describe @@ -1,6 +1,6 @@ NAME - gcloud beta deploy delivery-pipelines describe - describes details specific - to the individual target, delivery pipeline qualified + gcloud beta deploy delivery-pipelines describe - show details about a + delivery pipeline SYNOPSIS gcloud beta deploy delivery-pipelines describe diff --git a/gcloud/beta/deploy/delivery-pipelines/help b/gcloud/beta/deploy/delivery-pipelines/help index 2087ef46c..6b8d136f2 100644 --- a/gcloud/beta/deploy/delivery-pipelines/help +++ b/gcloud/beta/deploy/delivery-pipelines/help @@ -23,8 +23,7 @@ COMMANDS (BETA) Delete a delivery pipeline. describe - (BETA) Describes details specific to the individual target, delivery - pipeline qualified. + (BETA) Show details about a delivery pipeline. export (BETA) Returns the .yaml definition of the specified delivery pipeline. diff --git a/gcloud/beta/emulators/firestore/start b/gcloud/beta/emulators/firestore/start index 52bcd045b..edd710fd5 100644 --- a/gcloud/beta/emulators/firestore/start +++ b/gcloud/beta/emulators/firestore/start @@ -2,8 +2,8 @@ NAME gcloud beta emulators firestore start - start a local Firestore emulator SYNOPSIS - gcloud beta emulators firestore start [--host-port=HOST_PORT] - [--rules=RULES] [GCLOUD_WIDE_FLAG ...] + gcloud beta emulators firestore start [--database-mode=DATABASE_MODE] + [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION (BETA) This command starts a local Firestore emulator. @@ -21,7 +21,19 @@ EXAMPLES $ gcloud beta emulators firestore start --rules=firestore.rules + To run the local Firestore emulator in Datastore Mode, run: + + $ gcloud beta emulators firestore start \ + --database-mode=datastore-mode + FLAGS + --database-mode=DATABASE_MODE + The database mode to start the Firestore Emulator in. The valid options + are: + + `firestore-native` (default): start the emulator in Firestore Native + `datastore-mode`: start the emulator in Datastore Mode + --host-port=HOST_PORT The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port: diff --git a/gcloud/beta/functions/describe b/gcloud/beta/functions/describe index e7366e659..7ec9c0eca 100644 --- a/gcloud/beta/functions/describe +++ b/gcloud/beta/functions/describe @@ -2,7 +2,7 @@ NAME gcloud beta functions describe - display details of a Google Cloud Function SYNOPSIS - gcloud beta functions describe (NAME : --region=REGION) + gcloud beta functions describe (NAME : --region=REGION) [--v2] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -41,6 +41,18 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property functions/region. +FLAGS + --v2 + If specified, this command will use Cloud Functions v2 APIs and return + the result in the v2 format (See + https://cloud.google.com/functions/docs/reference/rest/v2/projects.locations.functions#Function). + If not specified, 1st gen and 2nd gen functions will use v1 and v2 APIs + respectively and return the result in the corresponding format (For v1 + format, see + https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions#resource:-cloudfunction). + This command conflicts with --no-gen2. If specified with this + combination, v2 APIs will be used. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/beta/functions/list b/gcloud/beta/functions/list index 61adba5fa..ff704ffd4 100644 --- a/gcloud/beta/functions/list +++ b/gcloud/beta/functions/list @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud beta functions list [--regions=REGION,[REGION,...]; default="-"] - [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--v2] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -14,6 +14,17 @@ FLAGS Regions containing functions to list. By default, functions from the region configured in [functions/region] property are listed. + --v2 + If specified, this command will use Cloud Functions v2 APIs and return + the result in the v2 format (See + https://cloud.google.com/functions/docs/reference/rest/v2/projects.locations.functions#Function). + If not specified, 1st gen and 2nd gen functions will use v1 and v2 APIs + respectively and return the result in the corresponding format (For v1 + format, see + https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions#resource:-cloudfunction). + This command conflicts with --no-gen2. If specified with this + combination, v2 APIs will be used. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/beta/netapp/volumes/create b/gcloud/beta/netapp/volumes/create index 32eb832d2..f2debb04b 100644 --- a/gcloud/beta/netapp/volumes/create +++ b/gcloud/beta/netapp/volumes/create @@ -18,6 +18,8 @@ SYNOPSIS [kerberos-5p-read-only=KERBEROS-5P-READ-ONLY], [kerberos-5p-read-write=KERBEROS-5P-READ-WRITE], [nfsv3=NFSV3],[nfsv4=NFSV4]] [--labels=[KEY=VALUE,...]] + [--large-capacity=LARGE_CAPACITY] + [--multiple-endpoints=MULTIPLE_ENDPOINTS] [--restricted-actions=RESTRICTED_ACTION,[...]] [--security-style=SECURITY_STYLE; default="SECURITY_STYLE_UNSPECIFIED"] [--smb-settings=SMB_SETTING,[SMB_SETTING,...]] @@ -169,6 +171,14 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. + --large-capacity=LARGE_CAPACITY + Boolean flag indicating whether Volume is a large capacity Volume or + not + + --multiple-endpoints=MULTIPLE_ENDPOINTS + Boolean flag indicating whether Volume is a multiple endpoints Volume + or not + --restricted-actions=RESTRICTED_ACTION,[...] Actions to be restricted for a volume. Valid restricted action options are: 'DELETE'. diff --git a/gcloud/beta/recommender/insights/help b/gcloud/beta/recommender/insights/help index 4115a6cca..fedde6342 100644 --- a/gcloud/beta/recommender/insights/help +++ b/gcloud/beta/recommender/insights/help @@ -19,7 +19,7 @@ COMMANDS (BETA) Describe an insight. list - (BETA) List insights for a cloud entity. + (BETA) List insights for a Google Cloud entity. mark-accepted (BETA) Mark an insight's state as ACCEPTED. diff --git a/gcloud/beta/recommender/insights/list b/gcloud/beta/recommender/insights/list index 069a6922b..cb4dbc30a 100644 --- a/gcloud/beta/recommender/insights/list +++ b/gcloud/beta/recommender/insights/list @@ -1,21 +1,23 @@ NAME - gcloud beta recommender insights list - list insights for a cloud entity + gcloud beta recommender insights list - list insights for a Google Cloud + entity SYNOPSIS - gcloud beta recommender insights list --location=LOCATION + gcloud beta recommender insights list (--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID | --organization=ORGANIZATION_ID | --project=PROJECT_ID) - [--insight-type=INSIGHT_TYPE] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + [--insight-type=INSIGHT_TYPE] [--location=LOCATION] + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) This command lists all insights for a given cloud entity, location - and insight type. If insight-type is not specified, insights for all - supported insight-types are listed. Supported insight-types can be found - here: https://cloud.google.com/recommender/docs/insights/insight-types. - Currently the following cloud_entity_types are supported: project, - billing_account, folder and organization. + (BETA) This command lists all insights for a given Google Cloud entity, + location, and insight type. If insight-type or location is not specified, + insights for all supported insight-types and locations are listed. + Supported insight-types can be found here: + https://cloud.google.com/recommender/docs/insights/insight-types. The + following Google Cloud entity types are supported: project, + billing_account, folder, and organization. EXAMPLES To list all insights for a billing account: @@ -24,9 +26,6 @@ EXAMPLES --location=global --insight-type=google.compute.firewall.Insight REQUIRED FLAGS - --location=LOCATION - Location to list insights for. - Resource that is associated with cloud entity type. Currently four mutually exclusive flags are supported, --project, --billing-account, --folder, --organization. @@ -52,6 +51,10 @@ FLAGS Insight type to list insights for. Supported insight-types can be found here: https://cloud.google.com/recommender/docs/insights/insight-types + --location=LOCATION + Location to list insights for. If no location is specified, insights + for all supported locations are listed. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/beta/recommender/recommendations/list b/gcloud/beta/recommender/recommendations/list index 485d7b96f..e42c18e4f 100644 --- a/gcloud/beta/recommender/recommendations/list +++ b/gcloud/beta/recommender/recommendations/list @@ -3,20 +3,21 @@ NAME recommendation SYNOPSIS - gcloud beta recommender recommendations list --location=LOCATION + gcloud beta recommender recommendations list (--billing-account=BILLING_ACCOUNT | --folder=FOLDER_ID | --organization=ORGANIZATION_ID | --project=PROJECT_ID) - [--recommender=RECOMMENDER] [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] + [--location=LOCATION] [--recommender=RECOMMENDER] [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (BETA) This command lists all recommendations for a given cloud_entity_id, - location, and recommender. If recommender is not specified, recommendations - for all supported recommenders are listed. Supported recommenders can be - found here: https://cloud.google.com/recommender/docs/recommenders. - Currently the following cloud_entity_types are supported: project, - billing_account, folder and organization. + (BETA) This command lists all recommendations for a given Google Cloud + entity ID, location, and recommender. If recommender or location is not + specified, recommendations for all supported recommenders and locations are + listed. Supported recommenders can be found here: + https://cloud.google.com/recommender/docs/recommenders. The following + Google Cloud entity types are supported: project, billing_account, folder + and organization. EXAMPLES Lists recommendations for a Cloud project. $ gcloud beta recommender recommendations list \ @@ -24,9 +25,6 @@ EXAMPLES --recommender=google.compute.instance.MachineTypeRecommender REQUIRED FLAGS - --location=LOCATION - Location to list recommendations for. - Resource that is associated with cloud entity type. Currently four mutually exclusive flags are supported, --project, --billing-account, --folder, --organization. @@ -48,6 +46,10 @@ REQUIRED FLAGS core/project property value for this command invocation. FLAGS + --location=LOCATION + Location to list recommendations for. If no location is specified, + recommendations for all supported locations are listed. + --recommender=RECOMMENDER Recommender to list recommendations for. If no recommender is specified, recommendations for all supported recommenders are listed. diff --git a/gcloud/beta/service-extensions/help b/gcloud/beta/service-extensions/help index 7af700921..7b7d149ab 100644 --- a/gcloud/beta/service-extensions/help +++ b/gcloud/beta/service-extensions/help @@ -22,8 +22,10 @@ GROUPS (BETA) Manage Service Extensions LbTrafficExtension resources. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions $ gcloud alpha service-extensions diff --git a/gcloud/beta/service-extensions/lb-route-extensions/delete b/gcloud/beta/service-extensions/lb-route-extensions/delete index dfbdad7bb..1b486625f 100644 --- a/gcloud/beta/service-extensions/lb-route-extensions/delete +++ b/gcloud/beta/service-extensions/lb-route-extensions/delete @@ -67,8 +67,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-route-extensions delete $ gcloud alpha service-extensions lb-route-extensions delete diff --git a/gcloud/beta/service-extensions/lb-route-extensions/describe b/gcloud/beta/service-extensions/lb-route-extensions/describe index 0c176d3ce..8f1788479 100644 --- a/gcloud/beta/service-extensions/lb-route-extensions/describe +++ b/gcloud/beta/service-extensions/lb-route-extensions/describe @@ -61,8 +61,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-route-extensions describe $ gcloud alpha service-extensions lb-route-extensions describe diff --git a/gcloud/beta/service-extensions/lb-route-extensions/help b/gcloud/beta/service-extensions/lb-route-extensions/help index 9aa6850bd..85632a006 100644 --- a/gcloud/beta/service-extensions/lb-route-extensions/help +++ b/gcloud/beta/service-extensions/lb-route-extensions/help @@ -30,8 +30,10 @@ COMMANDS (BETA) List LbRouteExtension resources. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-route-extensions $ gcloud alpha service-extensions lb-route-extensions diff --git a/gcloud/beta/service-extensions/lb-route-extensions/import b/gcloud/beta/service-extensions/lb-route-extensions/import index 31e9f445d..18373a69d 100644 --- a/gcloud/beta/service-extensions/lb-route-extensions/import +++ b/gcloud/beta/service-extensions/lb-route-extensions/import @@ -78,8 +78,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-route-extensions import $ gcloud alpha service-extensions lb-route-extensions import diff --git a/gcloud/beta/service-extensions/lb-route-extensions/list b/gcloud/beta/service-extensions/lb-route-extensions/list index dc0f75223..cd693282d 100644 --- a/gcloud/beta/service-extensions/lb-route-extensions/list +++ b/gcloud/beta/service-extensions/lb-route-extensions/list @@ -82,8 +82,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-route-extensions list $ gcloud alpha service-extensions lb-route-extensions list diff --git a/gcloud/beta/service-extensions/lb-traffic-extensions/delete b/gcloud/beta/service-extensions/lb-traffic-extensions/delete index 3dc251820..dd634622c 100644 --- a/gcloud/beta/service-extensions/lb-traffic-extensions/delete +++ b/gcloud/beta/service-extensions/lb-traffic-extensions/delete @@ -67,8 +67,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-traffic-extensions delete $ gcloud alpha service-extensions lb-traffic-extensions delete diff --git a/gcloud/beta/service-extensions/lb-traffic-extensions/describe b/gcloud/beta/service-extensions/lb-traffic-extensions/describe index 012477cbe..1f4d37450 100644 --- a/gcloud/beta/service-extensions/lb-traffic-extensions/describe +++ b/gcloud/beta/service-extensions/lb-traffic-extensions/describe @@ -61,8 +61,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-traffic-extensions describe $ gcloud alpha service-extensions lb-traffic-extensions describe diff --git a/gcloud/beta/service-extensions/lb-traffic-extensions/help b/gcloud/beta/service-extensions/lb-traffic-extensions/help index 857e6a9bb..0bce2dccf 100644 --- a/gcloud/beta/service-extensions/lb-traffic-extensions/help +++ b/gcloud/beta/service-extensions/lb-traffic-extensions/help @@ -30,8 +30,10 @@ COMMANDS (BETA) List LbTrafficExtension resources. NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-traffic-extensions $ gcloud alpha service-extensions lb-traffic-extensions diff --git a/gcloud/beta/service-extensions/lb-traffic-extensions/import b/gcloud/beta/service-extensions/lb-traffic-extensions/import index 87d3cabc1..52a689f7c 100644 --- a/gcloud/beta/service-extensions/lb-traffic-extensions/import +++ b/gcloud/beta/service-extensions/lb-traffic-extensions/import @@ -78,8 +78,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-traffic-extensions import $ gcloud alpha service-extensions lb-traffic-extensions import diff --git a/gcloud/beta/service-extensions/lb-traffic-extensions/list b/gcloud/beta/service-extensions/lb-traffic-extensions/list index 6a66dd5aa..40bed410b 100644 --- a/gcloud/beta/service-extensions/lb-traffic-extensions/list +++ b/gcloud/beta/service-extensions/lb-traffic-extensions/list @@ -83,8 +83,10 @@ API REFERENCE for this API can be found at: https://cloud.google.com/networking NOTES - This command is currently in beta and might change without notice. This - variant is also available: + This command is currently in beta and might change without notice. These + variants are also available: + + $ gcloud service-extensions lb-traffic-extensions list $ gcloud alpha service-extensions lb-traffic-extensions list diff --git a/gcloud/beta/sql/operations/list b/gcloud/beta/sql/operations/list index 91d231399..30763c115 100644 --- a/gcloud/beta/sql/operations/list +++ b/gcloud/beta/sql/operations/list @@ -3,7 +3,7 @@ NAME given Cloud SQL instance SYNOPSIS - gcloud beta sql operations list --instance=INSTANCE, -i INSTANCE + gcloud beta sql operations list [--instance=INSTANCE, -i INSTANCE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -26,7 +26,7 @@ EXAMPLES $ gcloud beta sql operations list --instance=prod-instance \ --page-size=10 -REQUIRED FLAGS +FLAGS --instance=INSTANCE, -i INSTANCE Cloud SQL instance ID. diff --git a/gcloud/builds/connections/create/bitbucket-cloud b/gcloud/builds/connections/create/bitbucket-cloud new file mode 100644 index 000000000..37eb9246a --- /dev/null +++ b/gcloud/builds/connections/create/bitbucket-cloud @@ -0,0 +1,108 @@ +NAME + gcloud builds connections create bitbucket-cloud - create a Cloud Build + Connection for Bitbucket Cloud + +SYNOPSIS + gcloud builds connections create bitbucket-cloud + (CONNECTION : --region=REGION) + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + --workspace=WORKSPACE [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Cloud Build Connection for Bitbucket Cloud. + + A Bitbucket Cloud Connection can be created by using a + repository/project/workspace access token with + repository_read,repository_admin, pullrequest_read, webhook scope + permission and a repository/project/workspace access token with + repository_read scope permission. + +EXAMPLES + To create a Bitbucket Cloud connection, provide all the required + parameters: + + $ gcloud builds connections create bitbucket-cloud \ + my-bitbucket-conn --project=myproj --region=us-central1 \ + --workspace=my-workspace \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection to create. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read,repository_admin, + pullrequest_read, webhook repository/project/workspace access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read repository/project/workspace + access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Cloud. + + --workspace=WORKSPACE + Workspace of the Bitbucket Cloud instance. + +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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + These variants are also available: + + $ gcloud alpha builds connections create bitbucket-cloud + + $ gcloud beta builds connections create bitbucket-cloud + diff --git a/gcloud/builds/connections/create/bitbucket-data-center b/gcloud/builds/connections/create/bitbucket-data-center new file mode 100644 index 000000000..5d104aeab --- /dev/null +++ b/gcloud/builds/connections/create/bitbucket-data-center @@ -0,0 +1,139 @@ +NAME + gcloud builds connections create bitbucket-data-center - create a Cloud + Build Connection for Bitbucket Data Center + +SYNOPSIS + gcloud builds connections create bitbucket-data-center + (CONNECTION : --region=REGION) + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION [--async] + [--host-uri=HOST_URI] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE + : --ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a Cloud Build Connection for Bitbucket Data Center. + + A Bitbucket Data Center Connection can be created by using a personal + access token with REPO_ADMIN scope permission. A REPO_READ scoped personal + access token will also be required. + + If the Bitbucket Data Center can only be accessed within a VPC, a Service + Directory service resource can be provided for connecting to it. + +EXAMPLES + To create a Bitbucket Data Center connection, provide all the required + parameters: + + $ gcloud builds connections create bitbucket-data-center \ + my-bitbucket-conn --project=myproj --region=us-central1 \ + --host-uri=https://bitbucket-server.net \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + + To create a Bitbucket Data Center connection for a private Bitbucket Data + Center server. Provide the service-directory-service and ssl-ca-file as + well: + + $ gcloud builds connections create bitbucket-data-center \ + my-private-bitbucket-conn \ + --host-uri=https://my.private-bitbucket-server.net \ + --project=myproj --region=us-central1 \ + --service-directory-service=projects/myproj/namespaces/x/\ + services/mysds --ssl-ca-file=mycertificate.crt \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 \ + --read-authorizer-token-secret-version=projects/myproj/secrets/\ + read-pat/versions/1 \ + --webhook-secret-secret-version=projects/myproj/secrets/\ + whsecret/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection to create. The arguments in this group + can be used to specify the attributes of this resource. (NOTE) Some + attributes are not given arguments in this group but can be set in other + ways. + + To set the project attribute: + ◆ provide the argument connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_ADMIN personal access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_READ personal access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Data Center. + +OPTIONAL FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --host-uri=HOST_URI + URI of the Bitbucket Data Center instance. + + Group of arguments for configuring access through Service Directory. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the Bitbucket + Data Center. Necessary only if the server has no public access from + the internet. + + This flag argument must be specified if any of the other arguments in + this group are specified. + + --ssl-ca-file=SSL_CA_FILE + File containing the SSL_CA to be used. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + These variants are also available: + + $ gcloud alpha builds connections create bitbucket-data-center + + $ gcloud beta builds connections create bitbucket-data-center + diff --git a/gcloud/builds/connections/create/help b/gcloud/builds/connections/create/help index d9ef19a9e..a4fc637eb 100644 --- a/gcloud/builds/connections/create/help +++ b/gcloud/builds/connections/create/help @@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + Create a Cloud Build Connection for Bitbucket Cloud. + + bitbucket-data-center + Create a Cloud Build Connection for Bitbucket Data Center. + github Create a Cloud Build Connection of type GitHub. diff --git a/gcloud/builds/connections/update/bitbucket-cloud b/gcloud/builds/connections/update/bitbucket-cloud new file mode 100644 index 000000000..9c888a26e --- /dev/null +++ b/gcloud/builds/connections/update/bitbucket-cloud @@ -0,0 +1,103 @@ +NAME + gcloud builds connections update bitbucket-cloud - update a Cloud Build + Connection of type Bitbucket Cloud + +SYNOPSIS + gcloud builds connections update bitbucket-cloud + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [--read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION] + [--webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION] + [--workspace=WORKSPACE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Cloud Build Connection of type Bitbucket Cloud. + +EXAMPLES + To update the workspace, provide the connection name and the workspace + name: + + $ gcloud builds connections update bitbucket-cloud my-bbc-conn \ + --region=us-west1 --workspace=my-workspace + + To update the authorization token, provide the connection name and the new + authorization token secret version. + + $ gcloud builds connections update bitbucket-cloud my-bbc-conn \ + --region=us-west1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection 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 connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read,repository_admin, + pullrequest_read, webhook access token. It can be a repository, project + or workspace access token. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the repository_read access token. It can be a + repository, project or workspace access token. + + --webhook-secret-secret-version=WEBHOOK_SECRET_SECRET_VERSION + Secret containing the webhook secret string for validating webhook + events sent by Bitbucket Cloud. + + --workspace=WORKSPACE + Workspace of the Bitbucket Cloud instance. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + These variants are also available: + + $ gcloud alpha builds connections update bitbucket-cloud + + $ gcloud beta builds connections update bitbucket-cloud + diff --git a/gcloud/builds/connections/update/bitbucket-data-center b/gcloud/builds/connections/update/bitbucket-data-center new file mode 100644 index 000000000..4ec0b3c69 --- /dev/null +++ b/gcloud/builds/connections/update/bitbucket-data-center @@ -0,0 +1,104 @@ +NAME + gcloud builds connections update bitbucket-data-center - update a Cloud + Build Connection of type Bitbucket Data Center + +SYNOPSIS + gcloud builds connections update bitbucket-data-center + (CONNECTION : --region=REGION) [--async] + [--authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION] + [--host-uri=HOST_URI] + [--read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION] + [--service-directory-service=SERVICE_DIRECTORY_SERVICE] + [--ssl-ca-file=SSL_CA_FILE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Update a Cloud Build Connection of type Bitbucket Data Center. + +EXAMPLES + To update the ssl_ca, provide the connection name and the ssl_ca file: + + $ gcloud builds connections update bitbucket-data-center \ + my-gle-conn --region=us-west1 --ssl-ca-file=mycertificate.crt + + To update the authorization token, provide the connection name and the new + authorization token secret version name. + + $ gcloud builds connections update bitbucket-data-center \ + my-gle-conn --region=us-west1 \ + --authorizer-token-secret-version=projects/myproj/secrets/\ + admin-pat/versions/1 + +POSITIONAL ARGUMENTS + Connection resource - Connection 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 connection 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. + + CONNECTION + ID of the connection or fully qualified identifier for the + connection. + + To set the connection attribute: + ▸ provide the argument connection on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Google Cloud region. + + To set the region attribute: + ▸ provide the argument connection on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --authorizer-token-secret-version=AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_ADMIN personal access token. + + --host-uri=HOST_URI + URI of the Bitbucket Data Center instance. + + --read-authorizer-token-secret-version=READ_AUTHORIZER_TOKEN_SECRET_VERSION + Secret containing the REPO_READ personal access token. + + --service-directory-service=SERVICE_DIRECTORY_SERVICE + Service Directory service resource to use for accessing the Bitbucket + Data Center. Necessary only if the server has no public access from the + internet. + + --ssl-ca-file=SSL_CA_FILE + File containing the SSL_CA to be used. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --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 cloudbuild/v2 API. The full documentation for this + API can be found at: https://cloud.google.com/cloud-build/docs/ + +NOTES + These variants are also available: + + $ gcloud alpha builds connections update bitbucket-data-center + + $ gcloud beta builds connections update bitbucket-data-center + diff --git a/gcloud/builds/connections/update/help b/gcloud/builds/connections/update/help index 07871e5ba..cb4141591 100644 --- a/gcloud/builds/connections/update/help +++ b/gcloud/builds/connections/update/help @@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + Update a Cloud Build Connection of type Bitbucket Cloud. + + bitbucket-data-center + Update a Cloud Build Connection of type Bitbucket Data Center. + github Update a Cloud Build Connection of type GitHub. diff --git a/gcloud/builds/triggers/create/bitbucket-cloud b/gcloud/builds/triggers/create/bitbucket-cloud new file mode 100644 index 000000000..8fb276812 --- /dev/null +++ b/gcloud/builds/triggers/create/bitbucket-cloud @@ -0,0 +1,222 @@ +NAME + gcloud builds triggers create bitbucket-cloud - create a build trigger for + a 2nd-gen Bitbucket Cloud repository + +SYNOPSIS + gcloud builds triggers create bitbucket-cloud + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR; default="/"]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger for a 2nd-gen Bitbucket Cloud repository. + +EXAMPLES + To create a push trigger with a 2nd-gen repository for all branches: + + $ gcloud builds triggers create bitbucket-cloud \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" --region=us-central1 + + To create a pull request trigger with a 2nd-gen repository for main: + + $ gcloud builds triggers create bitbucket-cloud \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --build-config="cloudbuild.yaml" \ + --pull-request-pattern="^main$" --region=us-central1 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. Note: Region must be specified in 2nd gen repo; global is + not supported. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. For + example: + + $ gcloud builds triggers create bitbucket-cloud ... \ + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Substitutions can be applied to user-defined variables (starting + with an underscore) and to the following built-in variables: + REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, + SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha builds triggers create bitbucket-cloud + + $ gcloud beta builds triggers create bitbucket-cloud + diff --git a/gcloud/builds/triggers/create/bitbucket-data-center b/gcloud/builds/triggers/create/bitbucket-data-center new file mode 100644 index 000000000..db76e3dea --- /dev/null +++ b/gcloud/builds/triggers/create/bitbucket-data-center @@ -0,0 +1,222 @@ +NAME + gcloud builds triggers create bitbucket-data-center - create a build + trigger for a 2nd-gen Bitbucket Data Center repository + +SYNOPSIS + gcloud builds triggers create bitbucket-data-center + (--trigger-config=PATH | [(--branch-pattern=REGEX | --tag-pattern=REGEX + | [--pull-request-pattern=REGEX : --comment-control=COMMENT_CONTROL; + default="COMMENTS_ENABLED"]) (--build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR; default="/"]) + : --description=DESCRIPTION --ignored-files=[GLOB,...] + --included-files=[GLOB,...] --name=NAME --region=REGION + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --substitutions=[KEY=VALUE,...]]) + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Create a build trigger for a 2nd-gen Bitbucket Data Center repository. + +EXAMPLES + To create a push trigger with a 2nd-gen repository for all branches: + + $ gcloud builds triggers create bitbucket-data-center \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --branch-pattern=".*" \ + --build-config="cloudbuild.yaml" --region=us-central1 + + To create a pull request trigger with a 2nd-gen repository for main: + + $ gcloud builds triggers create bitbucket-data-center \ + --name="my-trigger" \ + --service-account="projects/my-project/serviceAccounts/my-byosa@\ + my-project.iam.gserviceaccount.com" \ + --repository="projects/1234/locations/us-central1/connections/my\ + conn/repositories/myrepo" --build-config="cloudbuild.yaml" \ + --pull-request-pattern="^main$" --region=us-central1 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --name=NAME + Build trigger name. + + --region=REGION + The region of the Cloud Build Service to use. Must be set to a + supported region name (e.g. us-central1). If unset, builds/region, + which is the default region to use when working with Cloud Build + resources, is used. If builds/region is unset, region is set to + global. Note: Region must be specified in 2nd gen repo; global is + not supported. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + --substitutions=[KEY=VALUE,...] + Parameters to be substituted in the build specification. For + example: + + $ gcloud builds triggers create bitbucket-data-center ... \ + --substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will result in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Substitutions can be applied to user-defined variables (starting + with an underscore) and to the following built-in variables: + REPO_NAME, BRANCH_NAME, TAG_NAME, REVISION_ID, COMMIT_SHA, + SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values + + Exactly one of these must be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --pull-request-pattern=REGEX + Regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regex search for the base branch (the + branch you are trying to merge into) for pull request updates. + For example, --pull-request-pattern=foo will match "foo", + "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --comment-control=COMMENT_CONTROL; default="COMMENTS_ENABLED" + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + Exactly one of these must be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR; default="/" + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha builds triggers create bitbucket-data-center + + $ gcloud beta builds triggers create bitbucket-data-center + diff --git a/gcloud/builds/triggers/create/help b/gcloud/builds/triggers/create/help index 892daf30b..889bfb238 100644 --- a/gcloud/builds/triggers/create/help +++ b/gcloud/builds/triggers/create/help @@ -16,6 +16,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + Create a build trigger for a 2nd-gen Bitbucket Cloud repository. + + bitbucket-data-center + Create a build trigger for a 2nd-gen Bitbucket Data Center repository. + bitbucketserver Create a build trigger for a Bitbucket Server repository. diff --git a/gcloud/builds/triggers/update/bitbucket-cloud b/gcloud/builds/triggers/update/bitbucket-cloud new file mode 100644 index 000000000..558a3609d --- /dev/null +++ b/gcloud/builds/triggers/update/bitbucket-cloud @@ -0,0 +1,251 @@ +NAME + gcloud builds triggers update bitbucket-cloud - updates Bitbucket Cloud + trigger used by Cloud Build + +SYNOPSIS + gcloud builds triggers update bitbucket-cloud (TRIGGER : --region=REGION) + (--trigger-config=PATH | --description=DESCRIPTION + --ignored-files=[GLOB,...] --included-files=[GLOB,...] + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --branch-pattern=REGEX + | --tag-pattern=REGEX | --comment-control=COMMENT_CONTROL + --pull-request-pattern=REGEX --build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR] --clear-substitutions + | --remove-substitutions=[KEY,...] + | --update-substitutions=[KEY=VALUE,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Updates Bitbucket Cloud trigger used by Cloud Build. + +EXAMPLES + To update the branch pattern of the trigger: + + $ gcloud builds triggers update bitbucket-cloud my-trigger \ + --branch-pattern=".*" + + To update the build config of the trigger: + + $ gcloud builds triggers update bitbucket-cloud my-trigger \ + --build-config="cloudbuild.yaml" + + To update the substitutions of the trigger: + + $ gcloud builds triggers update bitbucket-cloud my-trigger \ + --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master + + To update the 2nd-gen repository resource of the trigger: + + $ gcloud builds triggers update bitbucket-cloud my-trigger \ + --repository=projects/my-project/locations/us-west1/\ + connections/my-conn/repositories/my-repo + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument TRIGGER on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. + + To set the trigger attribute: + ▸ provide the argument TRIGGER on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Cloud location for the trigger. + + To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + At most one of these can be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --comment-control=COMMENT_CONTROL + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regular expression search for the + base branch (the branch you are trying to merge into) for pull + request updates. For example, --pull-request-pattern=foo will + match "foo", "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + At most one of these can be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + At most one of these can be specified: + + --clear-substitutions + Clear existing substitutions. + + --remove-substitutions=[KEY,...] + Remove existing substitutions if present. + + --update-substitutions=[KEY=VALUE,...] + Update or add to existing substitutions. Substitutions are + parameters to be substituted or add in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers update ... + --update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will add the provided substitutions to the existing + substitutions and results in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/build-config-file-schema#substitutions + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha builds triggers update bitbucket-cloud + + $ gcloud beta builds triggers update bitbucket-cloud + diff --git a/gcloud/builds/triggers/update/bitbucket-data-center b/gcloud/builds/triggers/update/bitbucket-data-center new file mode 100644 index 000000000..401c53961 --- /dev/null +++ b/gcloud/builds/triggers/update/bitbucket-data-center @@ -0,0 +1,252 @@ +NAME + gcloud builds triggers update bitbucket-data-center - updates Bitbucket + Data Center trigger used by Cloud Build + +SYNOPSIS + gcloud builds triggers update bitbucket-data-center + (TRIGGER : --region=REGION) + (--trigger-config=PATH | --description=DESCRIPTION + --ignored-files=[GLOB,...] --included-files=[GLOB,...] + --repository=REPOSITORY --[no-]require-approval + --service-account=SERVICE_ACCOUNT --branch-pattern=REGEX + | --tag-pattern=REGEX | --comment-control=COMMENT_CONTROL + --pull-request-pattern=REGEX --build-config=PATH + | --inline-config=PATH + | [--dockerfile=DOCKERFILE --dockerfile-image=DOCKERFILE_IMAGE + : --dockerfile-dir=DOCKERFILE_DIR] --clear-substitutions + | --remove-substitutions=[KEY,...] + | --update-substitutions=[KEY=VALUE,...]) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Updates Bitbucket Data Center trigger used by Cloud Build. + +EXAMPLES + To update the branch pattern of the trigger: + + $ gcloud builds triggers update bitbucket-data-center my-trigger \ + --branch-pattern=".*" + + To update the build config of the trigger: + + $ gcloud builds triggers update bitbucket-data-center my-trigger \ + --build-config="cloudbuild.yaml" + + To update the substitutions of the trigger: + + $ gcloud builds triggers update bitbucket-data-center my-trigger \ + --update-substitutions=_REPO_NAME=my-repo,_BRANCH_NAME=master + + To update the 2nd-gen repository resource of the trigger: + + $ gcloud builds triggers update bitbucket-data-center my-trigger \ + --repository=projects/my-project/locations/us-west1/\ + connections/my-conn/repositories/my-repo + +POSITIONAL ARGUMENTS + Trigger resource - Build Trigger. The arguments in this group can be used + to specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument TRIGGER on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + TRIGGER + ID of the trigger or fully qualified identifier for the trigger. + + To set the trigger attribute: + ▸ provide the argument TRIGGER on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --region=REGION + The Cloud location for the trigger. + + To set the region attribute: + ▸ provide the argument TRIGGER on the command line with a fully + specified name; + ▸ provide the argument --region on the command line; + ▸ set the property builds/region. + +REQUIRED FLAGS + Exactly one of these must be specified: + + --trigger-config=PATH + Path to Build Trigger config file (JSON or YAML format). For more + details, see + https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.triggers#BuildTrigger + + Flag based trigger configuration + + --description=DESCRIPTION + Build trigger description. + + --ignored-files=[GLOB,...] + Glob filter. Changes only affecting ignored files won't trigger + builds. + + --included-files=[GLOB,...] + Glob filter. Changes affecting at least one included file will + trigger builds. + + --repository=REPOSITORY + Repository resource (2nd gen) to use, in the format + "projects/*/locations/*/connections/*/repositories/". + + --[no-]require-approval + Require manual approval for triggered builds. Use + --require-approval to enable and --no-require-approval to disable. + + --service-account=SERVICE_ACCOUNT + The service account used for all user-controlled operations + including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and + CancelBuild. If no service account is set, then the standard Cloud + Build service account ([PROJECT_NUM]@system.gserviceaccount.com) is + used instead. Format: + projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}. + + At most one of these can be specified: + + --branch-pattern=REGEX + A regular expression specifying which git branches to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --branch-pattern=foo will match + "foo", "foobar", and "barfoo". Events on a branch that does not + match will be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + --tag-pattern=REGEX + A regular expression specifying which git tags to match. + + This pattern is used as a regular expression search for any + incoming pushes. For example, --tag-pattern=foo will match "foo", + "foobar", and "barfoo". Events on a tag that does not match will + be ignored. + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + Pull Request settings + + --comment-control=COMMENT_CONTROL + Require a repository collaborator or owner to comment '/gcbrun' + on a pull request before running the build. COMMENT_CONTROL + must be one of: + + COMMENTS_DISABLED + Do not require comments on Pull Requests before builds are + triggered. + COMMENTS_ENABLED + Enforce that repository owners or collaborators must + comment on Pull Requests before builds are triggered. + COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY + Enforce that repository owners or collaborators must + comment on external contributors' Pull Requests before + builds are triggered. + + --pull-request-pattern=REGEX + A regular expression specifying which base git branch to match + for pull request events. + + This pattern is used as a regular expression search for the + base branch (the branch you are trying to merge into) for pull + request updates. For example, --pull-request-pattern=foo will + match "foo", "foobar", and "barfoo". + + The syntax of the regular expressions accepted is the syntax + accepted by RE2 and described at + https://github.com/google/re2/wiki/Syntax. + + At most one of these can be specified: + + --build-config=PATH + Path to a YAML or JSON file containing the build configuration in + the repository. + + For more details, see: + https://cloud.google.com/cloud-build/docs/build-config + + --inline-config=PATH + Local path to a YAML or JSON file containing a build + configuration. + + Dockerfile build configuration flags + + --dockerfile=DOCKERFILE + Path of Dockerfile to use for builds in the repository. + + If specified, a build config will be generated to run docker + build using the specified file. + + The filename is relative to the Dockerfile directory. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-image=DOCKERFILE_IMAGE + Docker image name to build. + + This flag argument must be specified if any of the other + arguments in this group are specified. + + --dockerfile-dir=DOCKERFILE_DIR + Location of the directory containing the Dockerfile in the + repository. + + The directory will also be used as the Docker build context. + + At most one of these can be specified: + + --clear-substitutions + Clear existing substitutions. + + --remove-substitutions=[KEY,...] + Remove existing substitutions if present. + + --update-substitutions=[KEY=VALUE,...] + Update or add to existing substitutions. Substitutions are + parameters to be substituted or add in the build specification. + + For example (using some nonsensical substitution keys; all keys + must begin with an underscore): + + $ gcloud builds triggers update ... + --update-substitutions _FAVORITE_COLOR=blue,_NUM_CANDIES=10 + + This will add the provided substitutions to the existing + substitutions and results in a build where every occurrence of + ${_FAVORITE_COLOR} in certain fields is replaced by "blue", and + similarly for ${_NUM_CANDIES} and "10". + + Only the following built-in variables can be specified with the + --substitutions flag: REPO_NAME, BRANCH_NAME, TAG_NAME, + REVISION_ID, COMMIT_SHA, SHORT_SHA. + + For more details, see: + https://cloud.google.com/build/docs/build-config-file-schema#substitutions + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + These variants are also available: + + $ gcloud alpha builds triggers update bitbucket-data-center + + $ gcloud beta builds triggers update bitbucket-data-center + diff --git a/gcloud/builds/triggers/update/help b/gcloud/builds/triggers/update/help index a5529e459..30a4b34d7 100644 --- a/gcloud/builds/triggers/update/help +++ b/gcloud/builds/triggers/update/help @@ -15,6 +15,12 @@ GCLOUD WIDE FLAGS COMMANDS COMMAND is one of the following: + bitbucket-cloud + Updates Bitbucket Cloud trigger used by Cloud Build. + + bitbucket-data-center + Updates Bitbucket Data Center trigger used by Cloud Build. + bitbucketserver Updates Bitbucket Server trigger used by Cloud Build. diff --git a/gcloud/certificate-manager/dns-authorizations/create b/gcloud/certificate-manager/dns-authorizations/create index f4b92c778..1e6c6c850 100644 --- a/gcloud/certificate-manager/dns-authorizations/create +++ b/gcloud/certificate-manager/dns-authorizations/create @@ -5,7 +5,7 @@ NAME SYNOPSIS gcloud certificate-manager dns-authorizations create (DNS_AUTHORIZATION : --location=LOCATION) --domain=DOMAIN [--async] - [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] + [--description=DESCRIPTION] [--labels=[KEY=VALUE,...]] [--type=TYPE] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -70,6 +70,10 @@ OPTIONAL FLAGS contain only hyphens (-), underscores (_), lowercase characters, and numbers. + --type=TYPE + Type of the DNS authorization. TYPE must be one of: fixed-record, + per-project-record, type-unspecified. + 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/composer/environments/create b/gcloud/composer/environments/create index 7a502d2ef..09f9acd8c 100644 --- a/gcloud/composer/environments/create +++ b/gcloud/composer/environments/create @@ -29,6 +29,8 @@ SYNOPSIS --enable-ip-alias --enable-ip-masq-agent --services-ipv4-cidr=SERVICES_IPV4_CIDR --services-secondary-range-name=SERVICES_SECONDARY_RANGE_NAME] + [--disable-cloud-data-lineage-integration + | --enable-cloud-data-lineage-integration] [--enable-master-authorized-networks --master-authorized-networks=[NETWORK,...]] [--enable-scheduled-snapshot-creation @@ -374,6 +376,16 @@ FLAGS When used with Composer 1.x, cannot be specified unless --enable-ip-alias is also specified. + At most one of these can be specified: + + --disable-cloud-data-lineage-integration + Disable Cloud Data Lineage integration, supported for Composer 2 + Environments. + + --enable-cloud-data-lineage-integration + Enable Cloud Data Lineage integration, supported for Composer 2 + Environments. + Master Authorized Networks configuration --enable-master-authorized-networks diff --git a/gcloud/composer/environments/update b/gcloud/composer/environments/update index 875ceadbc..aab47c6e0 100644 --- a/gcloud/composer/environments/update +++ b/gcloud/composer/environments/update @@ -9,6 +9,8 @@ SYNOPSIS | --enable-high-resilience | --enable-logs-in-cloud-logging-only | --environment-size=ENVIRONMENT_SIZE | --node-count=NODE_COUNT | --web-server-machine-type=WEB_SERVER_MACHINE_TYPE + | --disable-cloud-data-lineage-integration + | --enable-cloud-data-lineage-integration | --disable-master-authorized-networks --enable-master-authorized-networks --master-authorized-networks=[NETWORK,...] @@ -124,6 +126,19 @@ REQUIRED FLAGS machine types is available here: https://cloud.google.com/composer/pricing. + Group of arguments for setting Cloud Data Lineage integration + configuration in Composer 2. + + At most one of these can be specified: + + --disable-cloud-data-lineage-integration + Disable Cloud Data Lineage integration, supported for Composer 2 + Environments. + + --enable-cloud-data-lineage-integration + Enable Cloud Data Lineage integration, supported for Composer 2 + Environments. + Group of arguments for setting master authorized networks configuration. --disable-master-authorized-networks diff --git a/gcloud/compute/commitments/create b/gcloud/compute/commitments/create index 99a932dce..038baa07f 100644 --- a/gcloud/compute/commitments/create +++ b/gcloud/compute/commitments/create @@ -101,7 +101,7 @@ OPTIONAL FLAGS compute-optimized-c3, compute-optimized-c3d, compute-optimized-h3, general-purpose, general-purpose-e2, general-purpose-n2, general-purpose-n2d, general-purpose-t2d, graphics-optimized, - memory-optimized, memory-optimized-m3. + memory-optimized, memory-optimized-m3, storage-optimized-z3. Manage the reservations to be created with the commitment. diff --git a/gcloud/compute/firewall-policies/rules/create b/gcloud/compute/firewall-policies/rules/create index 1709bd70a..0d94e8563 100644 --- a/gcloud/compute/firewall-policies/rules/create +++ b/gcloud/compute/firewall-policies/rules/create @@ -11,13 +11,14 @@ SYNOPSIS [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] [--direction=DIRECTION] [--[no-]disabled] [--[no-]enable-logging] [--layer4-configs=[LAYER4_CONFIG,...]] [--organization=ORGANIZATION] + [--security-profile-group=SECURITY_PROFILE_GROUP] [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] [--src-region-codes=[SOURCE_REGION_CODES,...]] [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] [--target-resources=[TARGET_RESOURCES,...]] [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] - [GCLOUD_WIDE_FLAG ...] + [--[no-]tls-inspect] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute firewall-policies rules create is used to create @@ -38,7 +39,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --action=ACTION Action to take if the request matches the match condition. ACTION must - be one of: allow, deny, goto_next. + be one of: allow, deny, goto_next, apply_security_profile_group. --firewall-policy=FIREWALL_POLICY Short name of the firewall policy into which the rule should be @@ -90,6 +91,18 @@ OPTIONAL FLAGS Organization which the organization firewall policy belongs to. Must be set if FIREWALL_POLICY is short name. + --security-profile-group=SECURITY_PROFILE_GROUP + An org-based security profile group to be used with + apply_security_profile_group action. Allowed formats are: a) + http(s):////organizations//locations/global/securityProfileGroups/ + b) + (//)/organizations//locations/global/securityProfileGroups/ + c) . In case "c" gCloud CLI will create a reference matching + format "a", but to make it work + CLOUDSDK_API_ENDPOINT_OVERRIDES_NETWORKSECURITY property must be set. + In order to set this property, please run the command gcloud config set + api_endpoint_overrides/networksecurity https:///. + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] Source address groups to match for this rule. Can only be specified if DIRECTION is ingress. @@ -117,6 +130,12 @@ OPTIONAL FLAGS --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] List of target service accounts for the rule. + --[no-]tls-inspect + Use this flag to indicate whether TLS traffic should be inspected using + the TLS inspection policy when the security profile group is applied. + Default: no TLS inspection. Use --tls-inspect to enable and + --no-tls-inspect to disable. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/compute/firewall-policies/rules/update b/gcloud/compute/firewall-policies/rules/update index 15953cd65..c0adcff61 100644 --- a/gcloud/compute/firewall-policies/rules/update +++ b/gcloud/compute/firewall-policies/rules/update @@ -13,13 +13,14 @@ SYNOPSIS [--direction=DIRECTION] [--[no-]disabled] [--[no-]enable-logging] [--layer4-configs=[LAYER4_CONFIG,...]] [--new-priority=NEW_PRIORITY] [--organization=ORGANIZATION] + [--security-profile-group=SECURITY_PROFILE_GROUP] [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] [--src-region-codes=[SOURCE_REGION_CODES,...]] [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] [--target-resources=[TARGET_RESOURCES,...]] [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] - [GCLOUD_WIDE_FLAG ...] + [--[no-]tls-inspect] [GCLOUD_WIDE_FLAG ...] DESCRIPTION gcloud compute firewall-policies rules update is used to update @@ -46,7 +47,7 @@ REQUIRED FLAGS OPTIONAL FLAGS --action=ACTION Action to take if the request matches the match condition. ACTION must - be one of: allow, deny, goto_next. + be one of: allow, deny, goto_next, apply_security_profile_group. --description=DESCRIPTION An optional, textual description for the rule. @@ -96,6 +97,18 @@ OPTIONAL FLAGS Organization which the organization firewall policy belongs to. Must be set if FIREWALL_POLICY is short name. + --security-profile-group=SECURITY_PROFILE_GROUP + An org-based security profile group to be used with + apply_security_profile_group action. Allowed formats are: a) + http(s):////organizations//locations/global/securityProfileGroups/ + b) + (//)/organizations//locations/global/securityProfileGroups/ + c) . In case "c" gCloud CLI will create a reference matching + format "a", but to make it work + CLOUDSDK_API_ENDPOINT_OVERRIDES_NETWORKSECURITY property must be set. + In order to set this property, please run the command gcloud config set + api_endpoint_overrides/networksecurity https:///. + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] Source address groups to match for this rule. Can only be specified if DIRECTION is ingress. @@ -123,6 +136,12 @@ OPTIONAL FLAGS --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] List of target service accounts for the rule. + --[no-]tls-inspect + Use this flag to indicate whether TLS traffic should be inspected using + the TLS inspection policy when the security profile group is applied. + Default: no TLS inspection. Use --tls-inspect to enable and + --no-tls-inspect to disable. + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/compute/images/export b/gcloud/compute/images/export index edd42fe50..72ea2b46f 100644 --- a/gcloud/compute/images/export +++ b/gcloud/compute/images/export @@ -53,22 +53,22 @@ OPTIONAL FLAGS complete. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/compute/images/import b/gcloud/compute/images/import index 42f49a922..986b8bde6 100644 --- a/gcloud/compute/images/import +++ b/gcloud/compute/images/import @@ -147,22 +147,22 @@ OPTIONAL FLAGS complete. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/compute/instances/import b/gcloud/compute/instances/import index 2357caf09..8453632b5 100644 --- a/gcloud/compute/instances/import +++ b/gcloud/compute/instances/import @@ -91,22 +91,22 @@ OPTIONAL FLAGS non-matching destination or source IP addresses. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/compute/machine-images/import b/gcloud/compute/machine-images/import index e15a98219..2bfc565c3 100644 --- a/gcloud/compute/machine-images/import +++ b/gcloud/compute/machine-images/import @@ -90,22 +90,22 @@ OPTIONAL FLAGS addresses. --cloudbuild-service-account=CLOUDBUILD_SERVICE_ACCOUNT - Image import amd export tools use Cloud Build to import and export + Image import and export tools use Cloud Build to import and export images to and from your project. Cloud Build uses a specific service account to execute builds on your behalf. The Cloud Build service - account generates access token for other service accounts and it is + account generates an access token for other service accounts and it is also used for authentication when building the artifacts for the image import tool. - Use this flag to to specify a custom Cloud Build service account for - image import and export. If you don't specify this flag, Cloud Build - runs using your project's default Cloud Build service account. To set - this option, specify the email address corresponding to the required - Cloud Build service account. Note: You must specify the --logs-location - flag when you set the custom Cloud Build service account. + Use this flag to to specify a user-managed service account for image + import and export. If you don't specify this flag, Cloud Build runs + using your project's default Cloud Build service account. To set this + option, specify the email address of the desired user-managed service + account. Note: You must specify the --logs-location flag when you set a + user-managed service account. - At minimum, the specified Cloud Build service account needs to have the - following roles assigned: + At minimum, the specified user-managed service account needs to have + the following roles assigned: ◆ roles/compute.admin ◆ roles/iam.serviceAccountTokenCreator diff --git a/gcloud/compute/network-firewall-policies/rules/create b/gcloud/compute/network-firewall-policies/rules/create index 6d7e81277..c64f3b1d0 100644 --- a/gcloud/compute/network-firewall-policies/rules/create +++ b/gcloud/compute/network-firewall-policies/rules/create @@ -12,6 +12,7 @@ SYNOPSIS [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] [--direction=DIRECTION] [--[no-]disabled] [--[no-]enable-logging] [--layer4-configs=[LAYER4_CONFIG,...]] + [--security-profile-group=SECURITY_PROFILE_GROUP] [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] [--src-region-codes=[SOURCE_REGION_CODES,...]] @@ -19,6 +20,7 @@ SYNOPSIS [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] [--target-secure-tags=[TARGET_SECURE_TAGS,...]] [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] + [--[no-]tls-inspect] [--firewall-policy-region=FIREWALL_POLICY_REGION | --global-firewall-policy] [GCLOUD_WIDE_FLAG ...] @@ -49,7 +51,7 @@ POSITIONAL ARGUMENTS REQUIRED FLAGS --action=ACTION Action to take if the request matches the match condition. ACTION must - be one of: allow, deny, goto_next. + be one of: allow, deny, goto_next, apply_security_profile_group. --firewall-policy=FIREWALL_POLICY Firewall policy ID with which to create rule. @@ -96,6 +98,10 @@ OPTIONAL FLAGS A list of destination protocols and ports to which the firewall rule will apply. + --security-profile-group=SECURITY_PROFILE_GROUP + A security profile group to be used with apply_security_profile_group + action. + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] Source address groups to match for this rule. Can only be specified if DIRECTION is ingress. @@ -143,6 +149,12 @@ OPTIONAL FLAGS --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] List of target service accounts for the rule. + --[no-]tls-inspect + Use this flag to indicate whether TLS traffic should be inspected using + the TLS inspection policy when the security profile group is applied. + Default: no TLS inspection. Use --tls-inspect to enable and + --no-tls-inspect to disable. + At most one of these can be specified: --firewall-policy-region=FIREWALL_POLICY_REGION diff --git a/gcloud/compute/network-firewall-policies/rules/update b/gcloud/compute/network-firewall-policies/rules/update index b0ddc8748..88501a3ce 100644 --- a/gcloud/compute/network-firewall-policies/rules/update +++ b/gcloud/compute/network-firewall-policies/rules/update @@ -12,6 +12,7 @@ SYNOPSIS [--dest-threat-intelligence=[DEST_THREAT_INTELLIGENCE_LISTS,...]] [--direction=DIRECTION] [--[no-]disabled] [--[no-]enable-logging] [--layer4-configs=[LAYER4_CONFIG,...]] [--new-priority=NEW_PRIORITY] + [--security-profile-group=SECURITY_PROFILE_GROUP] [--src-address-groups=[SOURCE_ADDRESS_GROUPS,...]] [--src-fqdns=[SOURCE_FQDNS,...]] [--src-ip-ranges=[SRC_IP_RANGE,...]] [--src-region-codes=[SOURCE_REGION_CODES,...]] @@ -19,6 +20,7 @@ SYNOPSIS [--src-threat-intelligence=[SOURCE_THREAT_INTELLIGENCE_LISTS,...]] [--target-secure-tags=[TARGET_SECURE_TAGS,...]] [--target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...]] + [--[no-]tls-inspect] [--firewall-policy-region=FIREWALL_POLICY_REGION | --global-firewall-policy] [GCLOUD_WIDE_FLAG ...] @@ -46,7 +48,7 @@ REQUIRED FLAGS OPTIONAL FLAGS --action=ACTION Action to take if the request matches the match condition. ACTION must - be one of: allow, deny, goto_next. + be one of: allow, deny, goto_next, apply_security_profile_group. --description=DESCRIPTION An optional, textual description for the rule. @@ -92,6 +94,10 @@ OPTIONAL FLAGS --new-priority=NEW_PRIORITY New priority for the rule to update. Valid in [0, 65535]. + --security-profile-group=SECURITY_PROFILE_GROUP + A security profile group to be used with apply_security_profile_group + action. + --src-address-groups=[SOURCE_ADDRESS_GROUPS,...] Source address groups to match for this rule. Can only be specified if DIRECTION is ingress. @@ -139,6 +145,12 @@ OPTIONAL FLAGS --target-service-accounts=[TARGET_SERVICE_ACCOUNTS,...] List of target service accounts for the rule. + --[no-]tls-inspect + Use this flag to indicate whether TLS traffic should be inspected using + the TLS inspection policy when the security profile group is applied. + Default: no TLS inspection. Use --tls-inspect to enable and + --no-tls-inspect to disable. + At most one of these can be specified: --firewall-policy-region=FIREWALL_POLICY_REGION diff --git a/gcloud/container/clusters/create b/gcloud/container/clusters/create index a3ae5a1cb..41d581029 100644 --- a/gcloud/container/clusters/create +++ b/gcloud/container/clusters/create @@ -22,11 +22,12 @@ SYNOPSIS [--default-max-pods-per-node=DEFAULT_MAX_PODS_PER_NODE] [--disable-default-snat] [--disk-size=DISK_SIZE] [--disk-type=DISK_TYPE] [--enable-autorepair] [--no-enable-autoupgrade] - [--enable-cloud-logging] [--enable-cloud-monitoring] - [--enable-cloud-run-alpha] [--enable-confidential-nodes] - [--enable-cost-allocation] [--enable-dataplane-v2] [--enable-fleet] - [--enable-fqdn-network-policy] [--enable-google-cloud-access] - [--enable-gvnic] [--enable-identity-service] [--enable-image-streaming] + [--enable-cilium-clusterwide-network-policy] [--enable-cloud-logging] + [--enable-cloud-monitoring] [--enable-cloud-run-alpha] + [--enable-confidential-nodes] [--enable-cost-allocation] + [--enable-dataplane-v2] [--enable-fleet] [--enable-fqdn-network-policy] + [--enable-google-cloud-access] [--enable-gvnic] + [--enable-identity-service] [--enable-image-streaming] [--enable-intra-node-visibility] [--enable-ip-alias] [--enable-kubernetes-alpha] [--enable-kubernetes-unstable-apis=API,[API,...]] @@ -296,8 +297,8 @@ FLAGS ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used with '--create-subnetwork' option. --cluster-version=CLUSTER_VERSION The Kubernetes version to use for the master and nodes. Defaults to @@ -341,8 +342,8 @@ FLAGS $ gcloud container clusters create --create-subnetwork name=my-subnet - Can not be specified unless '--enable-ip-alias' is also specified. Can - not be used in conjunction with the '--subnetwork' option. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used in conjunction with '--subnetwork' option. --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. @@ -417,6 +418,10 @@ FLAGS Enabled by default, use --no-enable-autoupgrade to disable. + --enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Disabled by + default. + --enable-cloud-logging (DEPRECATED) Automatically send logs from the cluster to the Google Cloud Logging API. @@ -1054,15 +1059,16 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Can not be specified unless '--enable-ip-alias' is also specified. + Cannot be specified unless '--enable-ip-alias' option is also + specified. --services-secondary-range-name=NAME Set the secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be specified unless '--enable-ip-alias' option is also + specified. Cannot be used with '--create-subnetwork' option. --shielded-integrity-monitoring Enables monitoring and attestation of the boot integrity of the diff --git a/gcloud/container/clusters/create-auto b/gcloud/container/clusters/create-auto index 497638308..9959143e9 100644 --- a/gcloud/container/clusters/create-auto +++ b/gcloud/container/clusters/create-auto @@ -13,8 +13,8 @@ SYNOPSIS [--cluster-version=CLUSTER_VERSION] [--create-subnetwork=[KEY=VALUE,...]] [--database-encryption-key=DATABASE_ENCRYPTION_KEY] - [--enable-backup-restore] [--enable-fleet] - [--enable-google-cloud-access] + [--enable-backup-restore] [--enable-cilium-clusterwide-network-policy] + [--enable-fleet] [--enable-google-cloud-access] [--enable-kubernetes-unstable-apis=API,[API,...]] [--enable-master-global-access] [--fleet-project=PROJECT_ID_OR_NUMBER] [--labels=[KEY=VALUE,...]] [--logging=[COMPONENT,...]] @@ -132,8 +132,7 @@ FLAGS ranges will be allocated from this secondary range. NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be used with '--create-subnetwork' option. --cluster-version=CLUSTER_VERSION The Kubernetes version to use for the master and nodes. Defaults to @@ -178,8 +177,7 @@ FLAGS $ gcloud container clusters create-auto \ --create-subnetwork name=my-subnet - Can not be specified unless '--enable-ip-alias' is also specified. Can - not be used in conjunction with the '--subnetwork' option. + Cannot be used in conjunction with '--subnetwork' option. --database-encryption-key=DATABASE_ENCRYPTION_KEY Enable Database Encryption. @@ -196,6 +194,10 @@ FLAGS To learn more, see the Backup for GKE overview: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/concepts/backup-for-gke. + --enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Disabled by + default. + --enable-fleet Set cluster project as the fleet host project. This will register the cluster to the same project. To register the cluster to a fleet in a @@ -341,15 +343,12 @@ FLAGS If unspecified, the services CIDR range will be chosen with a default mask size. - Can not be specified unless '--enable-ip-alias' is also specified. - --services-secondary-range-name=NAME Set the secondary range to be used for services (e.g. ClusterIPs). NAME must be the name of an existing secondary range in the cluster subnetwork. - Must be used in conjunction with '--enable-ip-alias'. Cannot be used - with --create-subnetwork. + Cannot be used with '--create-subnetwork' option. --subnetwork=SUBNETWORK The Google Compute Engine subnetwork diff --git a/gcloud/container/clusters/update b/gcloud/container/clusters/update index 235e2d562..bff9148dc 100644 --- a/gcloud/container/clusters/update +++ b/gcloud/container/clusters/update @@ -11,6 +11,7 @@ SYNOPSIS | --database-encryption-key=DATABASE_ENCRYPTION_KEY | --disable-database-encryption | --disable-default-snat | --disable-workload-identity | --enable-autoscaling + | --[no-]enable-cilium-clusterwide-network-policy | --enable-cost-allocation | --enable-fleet | --enable-fqdn-network-policy | --enable-google-cloud-access | --enable-identity-service | --enable-image-streaming @@ -239,6 +240,11 @@ REQUIRED FLAGS default node pool if --node-pool is not provided. If not already, --max-nodes or --total-max-nodes must also be set. + --[no-]enable-cilium-clusterwide-network-policy + Enable Cilium Clusterwide Network Policies on the cluster. Use + --enable-cilium-clusterwide-network-policy to enable and + --no-enable-cilium-clusterwide-network-policy to disable. + --enable-cost-allocation Enable the cost management feature. diff --git a/gcloud/container/fleet/memberships/bindings/list b/gcloud/container/fleet/memberships/bindings/list index 4e9a24663..be4958487 100644 --- a/gcloud/container/fleet/memberships/bindings/list +++ b/gcloud/container/fleet/memberships/bindings/list @@ -25,7 +25,7 @@ EXAMPLES MEMBERSHIP_NAME, provide the location LOCATION_NAME for the Membership where the Binding belongs along with membership name. - $ gcloud container fleet memberships bindings list BINDING_NAME \ + $ gcloud container fleet memberships bindings list \ --membership=MEMBERSHIP_NAME --location=LOCATION_NAME REQUIRED FLAGS diff --git a/gcloud/container/fleet/scopes/help b/gcloud/container/fleet/scopes/help index d8fa491be..a0ecf3ea5 100644 --- a/gcloud/container/fleet/scopes/help +++ b/gcloud/container/fleet/scopes/help @@ -40,7 +40,7 @@ COMMANDS Get the IAM policy for a Fleet Scope. list - List fleet scopes. + List fleet scopes in a project. remove-iam-policy-binding Remove IAM policy binding of a Fleet Scope. diff --git a/gcloud/container/fleet/scopes/list b/gcloud/container/fleet/scopes/list index bd885e6ac..201f1c4e0 100644 --- a/gcloud/container/fleet/scopes/list +++ b/gcloud/container/fleet/scopes/list @@ -1,5 +1,5 @@ NAME - gcloud container fleet scopes list - list fleet scopes + gcloud container fleet scopes list - list fleet scopes in a project SYNOPSIS gcloud container fleet scopes list [--filter=EXPRESSION] [--limit=LIMIT] @@ -7,13 +7,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List scopes in a fleet. + This command can fail for the following reasons: + ▪ The project specified does not exist. + ▪ The user does not have access to the project specified. EXAMPLES - List scopes in the active project's fleet: + The following command lists scopes in the active project: $ gcloud container fleet scopes list + The following command lists scopes in project PROJECT_ID: + + $ gcloud container fleet scopes list --project=PROJECT_ID + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. @@ -54,11 +60,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the gkehub/v1 API. The full documentation for this API - can be found at: - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES These variants are also available: diff --git a/gcloud/container/hub/memberships/bindings/list b/gcloud/container/hub/memberships/bindings/list index af32d0eb7..37c4df1d4 100644 --- a/gcloud/container/hub/memberships/bindings/list +++ b/gcloud/container/hub/memberships/bindings/list @@ -25,7 +25,7 @@ EXAMPLES MEMBERSHIP_NAME, provide the location LOCATION_NAME for the Membership where the Binding belongs along with membership name. - $ gcloud container hub memberships bindings list BINDING_NAME \ + $ gcloud container hub memberships bindings list \ --membership=MEMBERSHIP_NAME --location=LOCATION_NAME REQUIRED FLAGS diff --git a/gcloud/container/hub/scopes/help b/gcloud/container/hub/scopes/help index 5849456ce..51513ad81 100644 --- a/gcloud/container/hub/scopes/help +++ b/gcloud/container/hub/scopes/help @@ -40,7 +40,7 @@ COMMANDS Get the IAM policy for a Fleet Scope. list - List fleet scopes. + List fleet scopes in a project. remove-iam-policy-binding Remove IAM policy binding of a Fleet Scope. diff --git a/gcloud/container/hub/scopes/list b/gcloud/container/hub/scopes/list index 7e3dd99cb..4de3ff9ee 100644 --- a/gcloud/container/hub/scopes/list +++ b/gcloud/container/hub/scopes/list @@ -1,5 +1,5 @@ NAME - gcloud container hub scopes list - list fleet scopes + gcloud container hub scopes list - list fleet scopes in a project SYNOPSIS gcloud container hub scopes list [--filter=EXPRESSION] [--limit=LIMIT] @@ -7,13 +7,19 @@ SYNOPSIS [GCLOUD_WIDE_FLAG ...] DESCRIPTION - List scopes in a fleet. + This command can fail for the following reasons: + ▪ The project specified does not exist. + ▪ The user does not have access to the project specified. EXAMPLES - List scopes in the active project's fleet: + The following command lists scopes in the active project: $ gcloud container hub scopes list + The following command lists scopes in project PROJECT_ID: + + $ gcloud container hub scopes list --project=PROJECT_ID + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. @@ -54,11 +60,6 @@ GCLOUD WIDE FLAGS Run $ gcloud help for details. -API REFERENCE - This command uses the gkehub/v1 API. The full documentation for this API - can be found at: - https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES These variants are also available: diff --git a/gcloud/container/node-pools/create b/gcloud/container/node-pools/create index cf1ddf8c6..e61f5f107 100644 --- a/gcloud/container/node-pools/create +++ b/gcloud/container/node-pools/create @@ -20,8 +20,9 @@ SYNOPSIS [--no-enable-autoupgrade] [--enable-blue-green-upgrade] [--enable-confidential-nodes] [--enable-gvnic] [--enable-image-streaming] [--enable-private-nodes] - [--enable-surge-upgrade] [--image-type=IMAGE_TYPE] - [--labels=[KEY=VALUE,...]] [--logging-variant=LOGGING_VARIANT] + [--enable-queued-provisioning] [--enable-surge-upgrade] + [--image-type=IMAGE_TYPE] [--labels=[KEY=VALUE,...]] + [--logging-variant=LOGGING_VARIANT] [--machine-type=MACHINE_TYPE, -m MACHINE_TYPE] [--max-pods-per-node=MAX_PODS_PER_NODE] [--max-surge-upgrade=MAX_SURGE_UPGRADE; default=1] @@ -242,6 +243,15 @@ FLAGS addresses only, regardless of whether private nodes are enabled or disabled. + --enable-queued-provisioning + Mark the nodepool as Queued only. This means that all new nodes can be + obtained only through queuing via ProvisioningRequest API. + + $ gcloud container node-pools create node-pool-1 \ + --cluster=example-cluster --enable-queued-provisioning + ... and other required parameters, for more details see: + https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest + --enable-surge-upgrade Changes node pool upgrade strategy to surge upgrade. diff --git a/gcloud/container/node-pools/update b/gcloud/container/node-pools/update index a22d1a9cc..294a66326 100644 --- a/gcloud/container/node-pools/update +++ b/gcloud/container/node-pools/update @@ -6,7 +6,8 @@ SYNOPSIS gcloud container node-pools update NAME (--enable-confidential-nodes | --enable-gvnic | --enable-image-streaming | --enable-private-nodes - | --labels=[KEY=VALUE,...] | --logging-variant=LOGGING_VARIANT + | --enable-queued-provisioning | --labels=[KEY=VALUE,...] + | --logging-variant=LOGGING_VARIANT | --network-performance-configs=[PROPERTY=VALUE,...] | --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...] | --node-taints=[NODE_TAINT,...] @@ -67,6 +68,15 @@ REQUIRED FLAGS IP addresses only, regardless of whether private nodes are enabled or disabled. + --enable-queued-provisioning + Mark the nodepool as Queued only. This means that all new nodes can + be obtained only through queuing via ProvisioningRequest API. + + $ gcloud container node-pools update node-pool-1 \ + --cluster=example-cluster --enable-queued-provisioning + ... and other required parameters, for more details see: + https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest + --labels=[KEY=VALUE,...] Labels to apply to the Google Cloud resources of node pools in the Kubernetes Engine cluster. These are unrelated to Kubernetes labels. diff --git a/gcloud/database-migration/migration-jobs/update b/gcloud/database-migration/migration-jobs/update index 6cbcc0d70..f2b364b65 100644 --- a/gcloud/database-migration/migration-jobs/update +++ b/gcloud/database-migration/migration-jobs/update @@ -4,10 +4,11 @@ NAME SYNOPSIS gcloud database-migration migration-jobs update - (MIGRATION_JOB : --region=REGION) [--no-async] + (MIGRATION_JOB : --region=REGION) [--no-async] [--commit-id=COMMIT_ID] [--destination=DESTINATION] [--display-name=DISPLAY_NAME] [--dump-parallel-level=DUMP_PARALLEL_LEVEL] [--dump-path=DUMP_PATH] - [--source=SOURCE] [--type=TYPE] [--update-labels=[KEY=VALUE,...]] + [--filter=FILTER] [--source=SOURCE] [--type=TYPE] + [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [--peer-vpc=PEER_VPC | --static-ip | --vm=VM --vm-ip=VM_IP --vm-port=VM_PORT --vpc=VPC] @@ -67,6 +68,11 @@ FLAGS --no-async Waits for the operation in progress to complete before returning. + --commit-id=COMMIT_ID + Commit id for the conversion workspace to use for creating the + migration job. If not specified, the latest commit id will be used by + default. + Connection profile resource - ID of the destination connection profile, representing the destination database. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be @@ -104,6 +110,12 @@ FLAGS Path to the dump file in Google Cloud Storage, in the format: gs://[BUCKET_NAME]/[OBJECT_NAME]. + --filter=FILTER + Filter the entities based on AIP-160 (https://google.aip.dev/160) + standard. Example: to filter all tables whose name start with + "Employee" and are present under schema "Company", use filter as + "Company.Employee* AND type=TABLE" + 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 diff --git a/gcloud/deploy/delivery-pipelines/describe b/gcloud/deploy/delivery-pipelines/describe index 473dac3c2..072aa82a6 100644 --- a/gcloud/deploy/delivery-pipelines/describe +++ b/gcloud/deploy/delivery-pipelines/describe @@ -1,6 +1,6 @@ NAME - gcloud deploy delivery-pipelines describe - describes details specific to - the individual target, delivery pipeline qualified + gcloud deploy delivery-pipelines describe - show details about a delivery + pipeline SYNOPSIS gcloud deploy delivery-pipelines describe diff --git a/gcloud/deploy/delivery-pipelines/help b/gcloud/deploy/delivery-pipelines/help index a00bc5266..cf5074482 100644 --- a/gcloud/deploy/delivery-pipelines/help +++ b/gcloud/deploy/delivery-pipelines/help @@ -23,8 +23,7 @@ COMMANDS Delete a delivery pipeline. describe - Describes details specific to the individual target, delivery pipeline - qualified. + Show details about a delivery pipeline. export Returns the .yaml definition of the specified delivery pipeline. diff --git a/gcloud/emulators/firestore/start b/gcloud/emulators/firestore/start index 5c40ed439..90fa859a1 100644 --- a/gcloud/emulators/firestore/start +++ b/gcloud/emulators/firestore/start @@ -2,8 +2,8 @@ NAME gcloud emulators firestore start - start a local Firestore emulator SYNOPSIS - gcloud emulators firestore start [--host-port=HOST_PORT] [--rules=RULES] - [GCLOUD_WIDE_FLAG ...] + gcloud emulators firestore start [--database-mode=DATABASE_MODE] + [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command starts a local Firestore emulator. @@ -21,7 +21,18 @@ EXAMPLES $ gcloud emulators firestore start --rules=firestore.rules + To run the local Firestore emulator in Datastore Mode, run: + + $ gcloud emulators firestore start --database-mode=datastore-mode + FLAGS + --database-mode=DATABASE_MODE + The database mode to start the Firestore Emulator in. The valid options + are: + + `firestore-native` (default): start the emulator in Firestore Native + `datastore-mode`: start the emulator in Datastore Mode + --host-port=HOST_PORT The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port: diff --git a/gcloud/functions/describe b/gcloud/functions/describe index cded362c3..30aed37da 100644 --- a/gcloud/functions/describe +++ b/gcloud/functions/describe @@ -2,7 +2,8 @@ NAME gcloud functions describe - display details of a Google Cloud Function SYNOPSIS - gcloud functions describe (NAME : --region=REGION) [GCLOUD_WIDE_FLAG ...] + gcloud functions describe (NAME : --region=REGION) [--v2] + [GCLOUD_WIDE_FLAG ...] DESCRIPTION Display details of a Google Cloud Function. @@ -40,6 +41,18 @@ POSITIONAL ARGUMENTS ▸ provide the argument --region on the command line; ▸ set the property functions/region. +FLAGS + --v2 + If specified, this command will use Cloud Functions v2 APIs and return + the result in the v2 format (See + https://cloud.google.com/functions/docs/reference/rest/v2/projects.locations.functions#Function). + If not specified, 1st gen and 2nd gen functions will use v1 and v2 APIs + respectively and return the result in the corresponding format (For v1 + format, see + https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions#resource:-cloudfunction). + This command conflicts with --no-gen2. If specified with this + combination, v2 APIs will be used. + 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/functions/list b/gcloud/functions/list index d51eb717a..39e1c94a4 100644 --- a/gcloud/functions/list +++ b/gcloud/functions/list @@ -2,7 +2,7 @@ NAME gcloud functions list - list Google Cloud Functions SYNOPSIS - gcloud functions list [--regions=REGION,[REGION,...]; default="-"] + gcloud functions list [--regions=REGION,[REGION,...]; default="-"] [--v2] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...] @@ -14,6 +14,17 @@ FLAGS Regions containing functions to list. By default, functions from the region configured in [functions/region] property are listed. + --v2 + If specified, this command will use Cloud Functions v2 APIs and return + the result in the v2 format (See + https://cloud.google.com/functions/docs/reference/rest/v2/projects.locations.functions#Function). + If not specified, 1st gen and 2nd gen functions will use v1 and v2 APIs + respectively and return the result in the corresponding format (For v1 + format, see + https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions#resource:-cloudfunction). + This command conflicts with --no-gen2. If specified with this + combination, v2 APIs will be used. + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/infra-manager/previews/export b/gcloud/infra-manager/previews/export index 52163aadd..6b69433d2 100644 --- a/gcloud/infra-manager/previews/export +++ b/gcloud/infra-manager/previews/export @@ -3,7 +3,7 @@ NAME SYNOPSIS gcloud infra-manager previews export (PREVIEW : --location=LOCATION) - [GCLOUD_WIDE_FLAG ...] + [--file=FILE; default="preview"] [GCLOUD_WIDE_FLAG ...] DESCRIPTION This command generates a signed url to download a preview results. @@ -46,6 +46,13 @@ POSITIONAL ARGUMENTS ▸ provide the argument --location on the command line; ▸ set the property infra-manager/location. +FLAGS + --file=FILE; default="preview" + File name for preview export artifacts. It is optional and if --file is + specified with a name or complete path, the artifacts will be + downloaded to either the current directory with files named as the name + provided or to the complete path. + 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/recommender/insights/help b/gcloud/recommender/insights/help index d5040bf86..db001319a 100644 --- a/gcloud/recommender/insights/help +++ b/gcloud/recommender/insights/help @@ -19,7 +19,7 @@ COMMANDS Describe an insight. list - List insights for a cloud entity. + List insights for a Google Cloud entity. mark-accepted Mark an insight's state as ACCEPTED. diff --git a/gcloud/recommender/insights/list b/gcloud/recommender/insights/list index 130e76d04..65ef7843e 100644 --- a/gcloud/recommender/insights/list +++ b/gcloud/recommender/insights/list @@ -1,5 +1,5 @@ NAME - gcloud recommender insights list - list insights for a cloud entity + gcloud recommender insights list - list insights for a Google Cloud entity SYNOPSIS gcloud recommender insights list --insight-type=INSIGHT_TYPE @@ -10,11 +10,11 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - This command lists all insights for a given cloud entity, location and - insight type. Supported insight-types can be found here: + This command lists all insights for a given Google Cloud entity, location, + and insight type. Supported insight-types can be found here: https://cloud.google.com/recommender/docs/insights/insight-types. Currently - the following cloud_entity_types are supported: project, billing_account, - folder and organization. + the following Google Cloud entity types are supported: project, + billing_account, folder, and organization. EXAMPLES To list all insights for a billing account: diff --git a/gcloud/recommender/recommendations/list b/gcloud/recommender/recommendations/list index 7a8ecd3ae..c0b98d449 100644 --- a/gcloud/recommender/recommendations/list +++ b/gcloud/recommender/recommendations/list @@ -11,11 +11,11 @@ SYNOPSIS [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - This command lists all recommendations for a given cloud_entity_id, + This command lists all recommendations for a given Google Cloud entity ID, location, and recommender. Supported recommenders can be found here: - https://cloud.google.com/recommender/docs/recommenders. Currently the - following cloud_entity_types are supported: project, billing_account, - folder and organization. + https://cloud.google.com/recommender/docs/recommenders. The following + Google Cloud entity types are supported: project, billing_account, folder + and organization. EXAMPLES Lists recommendations for a Cloud project. $ gcloud recommender recommendations list --project=project-id \ diff --git a/gcloud/scc/help b/gcloud/scc/help index d7c441304..82316eb3e 100644 --- a/gcloud/scc/help +++ b/gcloud/scc/help @@ -27,6 +27,9 @@ GROUPS findings Manage Cloud SCC (Security Command Center) findings. + manage + Manage Cloud SCC (Security Command Center) settings. + muteconfigs Manage Cloud SCC (Security Command Center) mute configs. diff --git a/gcloud/scc/manage/custom-modules/etd/create b/gcloud/scc/manage/custom-modules/etd/create new file mode 100644 index 000000000..018619bc3 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/create @@ -0,0 +1,71 @@ +NAME + gcloud scc manage custom-modules etd create - create an Event Threat + Detection custom module + +SYNOPSIS + gcloud scc manage custom-modules etd create + --custom-config-file=CUSTOM_CONFIG --display-name=DISPLAY-NAME + --enablement-state=ENABLEMENT_STATE --module-type=MODULE_TYPE + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To create an Event Threat Detection custom module for organization 123, + run: + + $ gcloud scc manage custom-modules etd create \ + --organization=organizations/123 \ + --display-name="test_display_name" \ + --module-type="CONFIGURABLE_BAD_IP" \ + --enablement-state="ENABLED" --custom-config-file=config.json + +REQUIRED FLAGS + --custom-config-file=CUSTOM_CONFIG + Path to a JSON custom configuration file of the ETD custom module. + + --display-name=DISPLAY-NAME + The display name of the custom module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Event Threat Detection custom module. + Valid options are ENABLED, DISABLED, OR INHERITED. + + --module-type=MODULE_TYPE + Type of the custom module. For a list of valid module types please + visit + https://cloud.google.com/security-command-center/docs/custom-modules-etd-overview#custom_modules_and_templates. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd create + diff --git a/gcloud/scc/manage/custom-modules/etd/delete b/gcloud/scc/manage/custom-modules/etd/delete new file mode 100644 index 000000000..b3ef5cde6 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/delete @@ -0,0 +1,85 @@ +NAME + gcloud scc manage custom-modules etd delete - delete an Event Threat + Detection custom module + +SYNOPSIS + gcloud scc manage custom-modules etd delete MODULE_ID_OR_NAME + [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Event Threat Detection custom module. User specifies the custom + module as well as the parent of the module to delete. A validation_only + flag is optional. When set to true only validations (including IAM checks) + will done for the request (module will not be deleted). + +EXAMPLES + To delete an Event Threat Detection custom module with ID 123456 for + organization 123, run: + + $ gcloud scc manage custom-modules etd delete 123456 \ + --organization=123 + + To delete a Event Threat Detection custom module with ID 123456 for folder + 456, run: + + $ gcloud scc manage custom-modules etd delete 123456 --folder=456 + + To delete a Event Threat Detection custom module with ID 123456 for project + 789, run: + + $ gcloud scc manage custom-modules etd delete 123456 --project=789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules etd delete 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules etd delete \ + organizations/123/locations/global/\ + eventThreatDetectionCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/eventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd delete + diff --git a/gcloud/scc/manage/custom-modules/etd/describe b/gcloud/scc/manage/custom-modules/etd/describe new file mode 100644 index 000000000..93b001c7b --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/describe @@ -0,0 +1,83 @@ +NAME + gcloud scc manage custom-modules etd describe - get the details of a Event + Threat Detection custom module + +SYNOPSIS + gcloud scc manage custom-modules etd describe MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get the details of a Event Threat Detection custom module. It does not + resolve INHERITED enablement states to ENABLED or DISABLED for modules + created at ancestor levels. For example, if the module is enabled at the + ancestor level, modules for all child resources will have the enablement + state set to INHERITED. Use gcloud scc manage custom-modules etd + get-effective to retrieve a custom module with its effective enablement + state. + +EXAMPLES + To get the details of a Event Threat Detection custom module with ID 123456 + for organization 123, run: + + $ gcloud scc manage custom-modules etd describe 123456 \ + --organization=123 + + To get the details of a Event Threat Detection custom module with ID 123456 + for folder 456, run: + + $ gcloud scc manage custom-modules etd describe 123456 --folder=456 + + To get the details of a Event Threat Detection custom module with ID 123456 + for project 789, run: + + $ gcloud scc manage custom-modules etd describe 123456 --project=789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules etd describe 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules etd describe \ + organizations/123/locations/global/\ + eventThreatDetectionCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/eventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd describe + diff --git a/gcloud/scc/manage/custom-modules/etd/describe-effective b/gcloud/scc/manage/custom-modules/etd/describe-effective new file mode 100644 index 000000000..a641a88cb --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/describe-effective @@ -0,0 +1,80 @@ +NAME + gcloud scc manage custom-modules etd describe-effective - get the effective + details of a Event Threat Detection effective custom module + +SYNOPSIS + gcloud scc manage custom-modules etd describe-effective MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get the effective details of a Event Threat Detection effective custom + module. It retrieves a custom module with its effective enablement state. + +EXAMPLES + To get the effective details of a Event Threat Detection custom module with + ID 123456 for organization 123, run: + + $ gcloud scc manage custom-modules etd describe-effective 123456 \ + --organization=123 + + To get the effective details of a Event Threat Detection custom module with + ID 123456 for folder 456, run: + + $ gcloud scc manage custom-modules etd describe-effective 123456 \ + --folder=456 + + To get the effective details of a Event Threat Detection custom module with + ID 123456 for project 789, run: + + $ gcloud scc manage custom-modules etd describe-effective 123456 \ + --project=789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules etd describe-effective 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules etd describe-effective \ + organizations/123/locations/global/\ + effectiveEventThreatDetectionCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/effectiveEventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd describe-effective + diff --git a/gcloud/scc/manage/custom-modules/etd/help b/gcloud/scc/manage/custom-modules/etd/help new file mode 100644 index 000000000..5dc4aa6bd --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/help @@ -0,0 +1,52 @@ +NAME + gcloud scc manage custom-modules etd - manage custom modules + +SYNOPSIS + gcloud scc manage custom-modules etd COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create an Event Threat Detection custom module. + + delete + Delete an Event Threat Detection custom module. + + describe + Get the details of a Event Threat Detection custom module. + + describe-effective + Get the effective details of a Event Threat Detection effective custom + module. + + list + List details of resident and inherited Event Threat Detection Custom + Modules. + + list-descendant + List the details of the resident and descendant Event Threat Detection + custom modules. + + list-effective + List the details of an Event Threat Detection effective custom module. + + update + Update an Event Threat Detection custom module. + + validate + Command to validate an ETD custom module. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd + diff --git a/gcloud/scc/manage/custom-modules/etd/list b/gcloud/scc/manage/custom-modules/etd/list new file mode 100644 index 000000000..f66431b57 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/list @@ -0,0 +1,92 @@ +NAME + gcloud scc manage custom-modules etd list - list details of resident and + inherited Event Threat Detection Custom Modules + +SYNOPSIS + gcloud scc manage custom-modules etd list + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the details of the resident and inherited Event Threat Detection + custom modules for the specified folder or project. For an organization, + this command lists only the custom modules that are created at the + organization level. Custom modules created in child folders or projects are + not included in the list. To list the resident custom modules and the + modules that are created in child folders or projects, use gcloud scc + manage custom-modules etd list-descendant. + +EXAMPLES + To list resident and inherited Event Threat Detection custom modules for + organization 123, run: + + $ gcloud scc manage custom-modules etd list \ + --organization=organizations/123 + + To list resident and inherited Event Threat Detection custom modules for + folder 456, run: + + $ gcloud scc manage custom-modules etd list --folder=folders/456 + + To list resident and inherited Event Threat Detection custom modules for + project 789, run: + + $ gcloud scc manage custom-modules etd list --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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 variant is also available: + + $ gcloud alpha scc manage custom-modules etd list + diff --git a/gcloud/scc/manage/custom-modules/etd/list-descendant b/gcloud/scc/manage/custom-modules/etd/list-descendant new file mode 100644 index 000000000..bf8762034 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/list-descendant @@ -0,0 +1,94 @@ +NAME + gcloud scc manage custom-modules etd list-descendant - list the details of + the resident and descendant Event Threat Detection custom modules + +SYNOPSIS + gcloud scc manage custom-modules etd list-descendant + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the details of the resident and descendant Event Threat Detection + custom modules for a specified organization or folder. For a project, this + command lists only the custom modules that are created in the project. + Modules created in a parent organization or folder are excluded from the + list. To list the resident custom modules and the modules that are + inherited from a parent organization and folder, use gcloud scc manage + custom-modules etd list. + +EXAMPLES + To list resident and descendant Event Threat Detection custom modules for + organization 123, run: + + $ gcloud scc manage custom-modules etd list-descendant \ + --organization=organizations/123 + + To list resident and descendant Event Threat Detection custom modules for + folder 456, run: + + $ gcloud scc manage custom-modules etd list-descendant \ + --folder=folders/456 + + To list resident and descendant Event Threat Detection custom modules for + project 789, run: + + $ gcloud scc manage custom-modules etd list-descendant \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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 variant is also available: + + $ gcloud alpha scc manage custom-modules etd list-descendant + diff --git a/gcloud/scc/manage/custom-modules/etd/list-effective b/gcloud/scc/manage/custom-modules/etd/list-effective new file mode 100644 index 000000000..bc2e20902 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/list-effective @@ -0,0 +1,92 @@ +NAME + gcloud scc manage custom-modules etd list-effective - list the details of + an Event Threat Detection effective custom module + +SYNOPSIS + gcloud scc manage custom-modules etd list-effective + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the details of resident and inherited Event Threat Detection custom + modules for the specified folder or project with their effective enablement + states. For an organization, this command lists only the custom modules + that are created at the organization level. Custom modules created in child + folders or projects are not included in the list. + +EXAMPLES + To list resident and inherited Event Threat Detection custom modules with + effective enablement states for organization 123, run: + + $ gcloud scc manage custom-modules etd list-effective \ + --organization=organizations/123 + + To list resident and inherited effective Event Threat Detection custom + modules with effective enablement states for folder 456, run: + + $ gcloud scc manage custom-modules etd list-effective \ + --folder=folders/456 + + To list resident and inherited effective Event Threat Detection custom + modules with effective enablement states for project 789, run: + + $ gcloud scc manage custom-modules etd list-effective \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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 variant is also available: + + $ gcloud alpha scc manage custom-modules etd list-effective + diff --git a/gcloud/scc/manage/custom-modules/etd/update b/gcloud/scc/manage/custom-modules/etd/update new file mode 100644 index 000000000..81adeec8a --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/update @@ -0,0 +1,71 @@ +NAME + gcloud scc manage custom-modules etd update - update an Event Threat + Detection custom module + +SYNOPSIS + gcloud scc manage custom-modules etd update MODULE_ID_OR_NAME + (--custom-config-file=CUSTOM_CONFIG_FILE + --enablement-state=ENABLEMENT_STATE) [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To update an Event Threat Detection custom module with ID 123456 for + organization 123, run: + + $ gcloud scc manage custom-modules etd update 123456 \ + --organization=organizations/123 --enablement-state="ENABLED" \ + --custom-config-file=custom_config.json + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/eventThreatDetectionCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +REQUIRED FLAGS + At least one of these must be specified: + + --custom-config-file=CUSTOM_CONFIG_FILE + Path to a JSON file that contains the custom config to set for the + module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Event Threat Detection custom + module. Valid options are ENABLED, DISABLED, OR INHERITED. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd update + diff --git a/gcloud/scc/manage/custom-modules/etd/validate b/gcloud/scc/manage/custom-modules/etd/validate new file mode 100644 index 000000000..fe911560d --- /dev/null +++ b/gcloud/scc/manage/custom-modules/etd/validate @@ -0,0 +1,63 @@ +NAME + gcloud scc manage custom-modules etd validate - command to validate an ETD + custom module + +SYNOPSIS + gcloud scc manage custom-modules etd validate + --custom-config-file=CUSTOM_CONFIG --module-type=MODULE_TYPE + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To validate an Event Threat Detection custom module 'config.json' with a + module type 'CONFIGURABLE_BAD_IP', run: + + $ gcloud scc manage custom-modules etd validate \ + --organization=organizations/252600681248 \ + --custom-config-file=config.json \ + --module-type=CONFIGURABLE_BAD_IP + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules etd validate \ + --parent=organizations/252600681248 \ + --custom-config-file=config.json \ + --module-type=CONFIGURABLE_BAD_IP + +REQUIRED FLAGS + --custom-config-file=CUSTOM_CONFIG + Path to a JSON custom configuration file of the ETD custom module. + + --module-type=MODULE_TYPE + Type of the custom module. For a list of valid module types please + visit + https://cloud.google.com/security-command-center/docs/custom-modules-etd-overview#custom_modules_and_templates. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules etd validate + diff --git a/gcloud/scc/manage/custom-modules/help b/gcloud/scc/manage/custom-modules/help new file mode 100644 index 000000000..7d8208490 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/help @@ -0,0 +1,29 @@ +NAME + gcloud scc manage custom-modules - manage Cloud SCC + (Security Command Center) custom modules + +SYNOPSIS + gcloud scc manage custom-modules GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Cloud SCC (Security Command Center) custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + etd + Manage custom modules. + + sha + Manage Security Health Analytics custom modules. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules + diff --git a/gcloud/scc/manage/custom-modules/sha/create b/gcloud/scc/manage/custom-modules/sha/create new file mode 100644 index 000000000..c3a1e2634 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/create @@ -0,0 +1,66 @@ +NAME + gcloud scc manage custom-modules sha create - create an Security Health + Analytics custom module + +SYNOPSIS + gcloud scc manage custom-modules sha create + --custom-config-from-file=CUSTOM_CONFIG --display-name=DISPLAY-NAME + --enablement-state=ENABLEMENT_STATE + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--validate-only] + [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To create a Security Health Analytics custom module for organization 123, + run: + + $ gcloud scc manage custom-modules sha create \ + --organization=organizations/123 \ + --display-name="test_display_name" \ + --enablement-state="ENABLED" \ + --custom-config-from-file=custom_config.yaml + +REQUIRED FLAGS + --custom-config-from-file=CUSTOM_CONFIG + Path to a YAML custom configuration file. + + --display-name=DISPLAY-NAME + The display name of the custom module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Security Health Analytics custom + module. Valid options are ENABLED, DISABLED, OR INHERITED. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha create + diff --git a/gcloud/scc/manage/custom-modules/sha/delete b/gcloud/scc/manage/custom-modules/sha/delete new file mode 100644 index 000000000..bb89befe3 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/delete @@ -0,0 +1,85 @@ +NAME + gcloud scc manage custom-modules sha delete - delete a Security Health + Analytics custom module + +SYNOPSIS + gcloud scc manage custom-modules sha delete MODULE_ID_OR_NAME + [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete a Security Health Analytics custom module. User specifies the custom + module as well as the parent of the module to delete. A validation_only + flag is optional. When set to true only validations (including IAM checks) + will done for the request (module will not be deleted). + +EXAMPLES + To delete an Security Health Analytics custom module with ID 123456 for + organization 123, run: + + $ gcloud scc manage custom-modules sha delete 123456 \ + --organization=123 + + To delete a Security Health Analytics custom module with ID 123456 for + folder 456, run: + + $ gcloud scc manage custom-modules sha delete 123456 --folder=456 + + To delete a Security Health Analytics custom module with ID 123456 for + project 789, run: + + $ gcloud scc manage custom-modules sha delete 123456 --project=789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules sha delete 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules sha delete \ + organizations/123/locations/global/\ + securityHealthAnalyticsCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/securityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha delete + diff --git a/gcloud/scc/manage/custom-modules/sha/describe b/gcloud/scc/manage/custom-modules/sha/describe new file mode 100644 index 000000000..911ef01fc --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/describe @@ -0,0 +1,83 @@ +NAME + gcloud scc manage custom-modules sha describe - get the details of a + Security Health Analytics custom module + +SYNOPSIS + gcloud scc manage custom-modules sha describe MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get the details of a Security Health Analytics custom module. It does not + resolve INHERITED enablement states to ENABLED or DISABLED for modules + created at ancestor levels. For example, if the module is enabled at the + ancestor level, modules for all child resources will have the enablement + state set to INHERITED. Use gcloud scc manage custom-modules sha + describe-effective to retrieve a custom module with its effective + enablement state. + +EXAMPLES + To get the details of a Security Health Analytics custom module with ID + 123456 for organization 123, run: + + $ gcloud scc manage custom-modules sha describe 123456 \ + --organization=123 + + To get the details of a Security Health Analytics custom module with ID + 123456 for folder 456, run: + + $ gcloud scc manage custom-modules sha describe 123456 --folder=456 + + To get the details of a Security Health Analytics custom module with ID + 123456 for project 789, run: + + $ gcloud scc manage custom-modules sha describe 123456 --project=789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules sha describe 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules sha describe \ + organizations/123/locations/global/\ + securityHealthAnalyticsCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/securityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha describe + diff --git a/gcloud/scc/manage/custom-modules/sha/describe-effective b/gcloud/scc/manage/custom-modules/sha/describe-effective new file mode 100644 index 000000000..7fe596380 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/describe-effective @@ -0,0 +1,80 @@ +NAME + gcloud scc manage custom-modules sha describe-effective - get effective the + details of a Security Health Analytics effective custom module + +SYNOPSIS + gcloud scc manage custom-modules sha describe-effective MODULE_ID_OR_NAME + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Get the effective details of a Security Health Analytics effective custom + module. It retrieves a custom module with its effective enablement state. + +EXAMPLES + To get the effective details of a Security Health Analytics custom module + with ID 123456 for organization 123, run: + + $ gcloud scc manage custom-modules sha describe-effective 123456 \ + --organization=123 + + To get the effective details of a Security Health Analytics custom module + with ID 123456 for folder 456, run: + + $ gcloud scc manage custom-modules sha describe-effective 123456 \ + --folder=456 + + To get the effective details of a Security Health Analytics custom module + with ID 123456 for project 789, run: + + $ gcloud scc manage custom-modules sha describe-effective 123456 \ + --project=789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules sha describe-effective 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules sha describe-effective \ + organizations/123/locations/global/\ + effectiveSecurityHealthAnalyticsCustomModules/123456 + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/effectiveSecurityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +FLAGS + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha describe-effective + diff --git a/gcloud/scc/manage/custom-modules/sha/help b/gcloud/scc/manage/custom-modules/sha/help new file mode 100644 index 000000000..bdfab6785 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/help @@ -0,0 +1,53 @@ +NAME + gcloud scc manage custom-modules sha - manage Security Health Analytics + custom modules + +SYNOPSIS + gcloud scc manage custom-modules sha COMMAND [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Security Health Analytics custom modules. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + create + Create an Security Health Analytics custom module. + + delete + Delete a Security Health Analytics custom module. + + describe + Get the details of a Security Health Analytics custom module. + + describe-effective + Get effective the details of a Security Health Analytics effective + custom module. + + list + List the details of Security Health Analyics custom modules. + + list-descendant + List the details of the resident and descendant Security Health + Analytics custom modules. + + list-effective + List the details of an Security Health Analytics effective custom + module. + + simulate + Command to simulate a SHA custom module. + + update + Update a Security Health Analytics custom module. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha + diff --git a/gcloud/scc/manage/custom-modules/sha/list b/gcloud/scc/manage/custom-modules/sha/list new file mode 100644 index 000000000..e25775b87 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/list @@ -0,0 +1,103 @@ +NAME + gcloud scc manage custom-modules sha list - list the details of Security + Health Analyics custom modules + +SYNOPSIS + gcloud scc manage custom-modules sha list + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the details of the resident and inherited Security Health Analytics + custom modules for the specified folder or project. For an organization, + this command lists only the custom modules that are created at the + organization level. Custom modules created in child folders or projects are + not included in the list. To list the resident custom modules and the + modules that are created in child folders or projects, use gcloud scc + manage custom-modules sha list-descendant. + +EXAMPLES + To list resident and inherited Security Health Analytics custom modules for + organization 123, run: + + $ gcloud scc manage custom-modules sha list \ + --organization=organizations/123 + + To list resident and inherited Security Health Analytics custom modules for + folder 456, run: + + $ gcloud scc manage custom-modules sha list --folder=folders/456 + + To list resident and inherited Security Health Analytics custom modules for + project 789, run: + + $ gcloud scc manage custom-modules sha list --project=projects/789 + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules sha list 123456 \ + --parent=organizations/123 + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules sha list \ + organizations/123/locations/global/\ + securityHealthAnalyticsCustomModules/123456 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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 variant is also available: + + $ gcloud alpha scc manage custom-modules sha list + diff --git a/gcloud/scc/manage/custom-modules/sha/list-descendant b/gcloud/scc/manage/custom-modules/sha/list-descendant new file mode 100644 index 000000000..dee874f91 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/list-descendant @@ -0,0 +1,94 @@ +NAME + gcloud scc manage custom-modules sha list-descendant - list the details of + the resident and descendant Security Health Analytics custom modules + +SYNOPSIS + gcloud scc manage custom-modules sha list-descendant + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the details of the resident and descendant Security Health Analytics + custom modules for a specified organization or folder. For a project, this + command lists only the custom modules that are created in the project. + Modules created in a parent organization or folder are excluded from the + list. To list the resident custom modules and the modules that are + inherited from a parent organization and folder, use gcloud scc manage + custom-modules sha list. + +EXAMPLES + To list resident and inherited Security Health Analytics custom modules for + organization 123, run: + + $ gcloud scc manage custom-modules sha list-descendant \ + --organization=organizations/123 + + To list resident and inherited Security Health Analytics custom modules for + folder 456, run: + + $ gcloud scc manage custom-modules sha list-descendant \ + --folder=folders/456 + + To list resident and inherited Security Health Analytics custom modules for + project 789, run: + + $ gcloud scc manage custom-modules sha list-descendant \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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 variant is also available: + + $ gcloud alpha scc manage custom-modules sha list-descendant + diff --git a/gcloud/scc/manage/custom-modules/sha/list-effective b/gcloud/scc/manage/custom-modules/sha/list-effective new file mode 100644 index 000000000..8ce413a86 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/list-effective @@ -0,0 +1,92 @@ +NAME + gcloud scc manage custom-modules sha list-effective - list the details of + an Security Health Analytics effective custom module + +SYNOPSIS + gcloud scc manage custom-modules sha list-effective + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [--filter=EXPRESSION] + [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + List the details of resident and inherited Security Health Analytics custom + modules for the specified folder or project with their effective enablement + states. For an organization, this command lists only the custom modules + that are created at the organization level. Custom modules created in child + folders or projects are not included in the list. + +EXAMPLES + To list resident and inherited Security Health Analytics custom modules + with effective enablement states for organization 123, run: + + $ gcloud scc manage custom-modules sha list-effective \ + --organization=organizations/123 + + To list resident and inherited effective Security Health Analytics custom + modules with effective enablement states for folder 456, run: + + $ gcloud scc manage custom-modules sha list-effective \ + --folder=folders/456 + + To list resident and inherited effective Security Health Analytics custom + modules with effective enablement states for project 789, run: + + $ gcloud scc manage custom-modules sha list-effective \ + --project=projects/789 + +REQUIRED FLAGS + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +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 variant is also available: + + $ gcloud alpha scc manage custom-modules sha list-effective + diff --git a/gcloud/scc/manage/custom-modules/sha/simulate b/gcloud/scc/manage/custom-modules/sha/simulate new file mode 100644 index 000000000..d8c45c3fe --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/simulate @@ -0,0 +1,84 @@ +NAME + gcloud scc manage custom-modules sha simulate - command to simulate a SHA + custom module + +SYNOPSIS + gcloud scc manage custom-modules sha simulate + --custom-config-from-file=CUSTOM_CONFIG --resource-from-file=TEST_DATA + (--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER) [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To simulate a Security Health Analytics custom module with ID 123456 for + organization 123, run: + + $ gcloud scc manage custom-modules sha simulate 123456 \ + --organization=123 \ + --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + To simulate a Security Health Analytics custom module with ID 123456 for + folder 456, run: + + $ gcloud scc manage custom-modules sha simulate 123456 \ + --folder=456 --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + To simulate a Security Health Analytics custom module with ID 123456 for + project 789, run: + + $ gcloud scc manage custom-modules sha simulate 123456 \ + --project=789 --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + You can also specify the parent more generally: + + $ gcloud scc manage custom-modules sha simulate 123456 \ + --parent=organizations/123 \ + --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + + Or just specify the fully qualified module name: + + $ gcloud scc manage custom-modules sha simulate \ + organizations/123/locations/global/\ + effectiveSecurityHealthAnalyticsCustomModules/123456 \ + --custom-config-from-file=custom_config.yaml \ + --resource-from-file=test.yaml + +REQUIRED FLAGS + --custom-config-from-file=CUSTOM_CONFIG + Path to a YAML custom configuration file. + + --resource-from-file=TEST_DATA + Path to a YAML file that contains the resource data to validate the + Security Health Analytics custom module against. + + Exactly one of these must be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha simulate + diff --git a/gcloud/scc/manage/custom-modules/sha/update b/gcloud/scc/manage/custom-modules/sha/update new file mode 100644 index 000000000..0c2313222 --- /dev/null +++ b/gcloud/scc/manage/custom-modules/sha/update @@ -0,0 +1,71 @@ +NAME + gcloud scc manage custom-modules sha update - update a Security Health + Analytics custom module + +SYNOPSIS + gcloud scc manage custom-modules sha update MODULE_ID_OR_NAME + (--custom-config-file=CUSTOM_CONFIG_FILE + --enablement-state=ENABLEMENT_STATE) [--validate-only] + [--folder=FOLDER_ID | --organization=ORGANIZATION_ID | --parent=PARENT + | --project=PROJECT_ID_OR_NUMBER] [GCLOUD_WIDE_FLAG ...] + +EXAMPLES + To update an Security Health Analytics custom module with ID 123456 for + organization 123, run: + + $ gcloud scc manage custom-modules sha update 123456 \ + --organization=organizations/123 --enablement-state="ENABLED" \ + --custom-config-file=custom_config.yaml + +POSITIONAL ARGUMENTS + MODULE_ID_OR_NAME + The custom module ID or name. The expected format is + {parent}/[locations/global]/securityHealthAnalyticsCustomModules/{module_id} + or just {module_id}. Where module_id is a numeric identifier 1-20 + characters in length. Parent is of the form organizations/{id}, + projects/{id or name}, folders/{id}. + +REQUIRED FLAGS + At least one of these must be specified: + + --custom-config-file=CUSTOM_CONFIG_FILE + Path to a YAML file that contains the custom config to set for the + module. + + --enablement-state=ENABLEMENT_STATE + Sets the enablement state of the Security Health Analytics custom + module. Valid options are ENABLED, DISABLED, OR INHERITED. + +OPTIONAL FLAGS + --validate-only + If present, the request is validated (including IAM checks) but no + action is taken. + + At most one of these can be specified: + + --folder=FOLDER_ID + Folder associated with the custom module. + + --organization=ORGANIZATION_ID + Organization associated with the custom module. + + --parent=PARENT + Parent associated with the custom module. Can be one of + organizations/, projects/, folders/ + + --project=PROJECT_ID_OR_NUMBER + Project associated with the custom module. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage custom-modules sha update + diff --git a/gcloud/scc/manage/help b/gcloud/scc/manage/help new file mode 100644 index 000000000..416aff8d8 --- /dev/null +++ b/gcloud/scc/manage/help @@ -0,0 +1,25 @@ +NAME + gcloud scc manage - manage Cloud SCC (Security Command Center) settings + +SYNOPSIS + gcloud scc manage GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Cloud SCC (Security Command Center) settings. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + custom-modules + Manage Cloud SCC (Security Command Center) custom modules. + +NOTES + This variant is also available: + + $ gcloud alpha scc manage + diff --git a/gcloud/service-extensions/help b/gcloud/service-extensions/help new file mode 100644 index 000000000..0ccc59971 --- /dev/null +++ b/gcloud/service-extensions/help @@ -0,0 +1,30 @@ +NAME + gcloud service-extensions - manage Service Extensions resources + +SYNOPSIS + gcloud service-extensions GROUP [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Service Extensions resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +GROUPS + GROUP is one of the following: + + lb-route-extensions + Manage Service Extensions LbRouteExtension resources. + + lb-traffic-extensions + Manage Service Extensions LbTrafficExtension resources. + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions + + $ gcloud beta service-extensions + diff --git a/gcloud/service-extensions/lb-route-extensions/delete b/gcloud/service-extensions/lb-route-extensions/delete new file mode 100644 index 000000000..ead959cc6 --- /dev/null +++ b/gcloud/service-extensions/lb-route-extensions/delete @@ -0,0 +1,75 @@ +NAME + gcloud service-extensions lb-route-extensions delete - delete an + LbRouteExtension resource + +SYNOPSIS + gcloud service-extensions lb-route-extensions delete + (LB_ROUTE_EXTENSION : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified LbRouteExtension resource. + +EXAMPLES + To delete an LbRouteExtension resource named my-route-extension in + us-central1, run: + + $ gcloud service-extensions lb-route-extensions delete \ + my-route-extension --location=us-central1 + +POSITIONAL ARGUMENTS + LbRouteExtension resource - The ID of the deleted LbRouteExtension + resource. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument lb_route_extension 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. + + LB_ROUTE_EXTENSION + ID of the LbRouteExtension or fully qualified identifier for the + LbRouteExtension. + + To set the lb_route_extension attribute: + ▸ provide the argument lb_route_extension on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Cloud region in which the resource is located. + + To set the location attribute: + ▸ provide the argument lb_route_extension on the command line with + a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-route-extensions delete + + $ gcloud beta service-extensions lb-route-extensions delete + diff --git a/gcloud/service-extensions/lb-route-extensions/describe b/gcloud/service-extensions/lb-route-extensions/describe new file mode 100644 index 000000000..ac6c2c55a --- /dev/null +++ b/gcloud/service-extensions/lb-route-extensions/describe @@ -0,0 +1,69 @@ +NAME + gcloud service-extensions lb-route-extensions describe - describe an + LbRouteExtension resource + +SYNOPSIS + gcloud service-extensions lb-route-extensions describe + (LB_ROUTE_EXTENSION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details about an LbRouteExtension resource. + +EXAMPLES + To show details about the LbRouteExtension resource named + my-route-extension located in us-central1. + + $ gcloud service-extensions lb-route-extensions describe \ + my-route-extension --location=us-central1 + +POSITIONAL ARGUMENTS + LbRouteExtension resource - The ID of the LbRouteExtension resource. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument lb_route_extension 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. + + LB_ROUTE_EXTENSION + ID of the LbRouteExtension or fully qualified identifier for the + LbRouteExtension. + + To set the lb_route_extension attribute: + ▸ provide the argument lb_route_extension on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Cloud region in which the resource is located. + + To set the location attribute: + ▸ provide the argument lb_route_extension on the command line with + a fully specified name; + ▸ provide the argument --location on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-route-extensions describe + + $ gcloud beta service-extensions lb-route-extensions describe + diff --git a/gcloud/service-extensions/lb-route-extensions/help b/gcloud/service-extensions/lb-route-extensions/help new file mode 100644 index 000000000..d71714c00 --- /dev/null +++ b/gcloud/service-extensions/lb-route-extensions/help @@ -0,0 +1,38 @@ +NAME + gcloud service-extensions lb-route-extensions - manage Service Extensions + LbRouteExtension resources + +SYNOPSIS + gcloud service-extensions lb-route-extensions COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Service Extensions LbRouteExtension resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + delete + Delete an LbRouteExtension resource. + + describe + Describe an LbRouteExtension resource. + + import + Import an LbRouteExtension resource. + + list + List LbRouteExtension resources. + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-route-extensions + + $ gcloud beta service-extensions lb-route-extensions + diff --git a/gcloud/service-extensions/lb-route-extensions/import b/gcloud/service-extensions/lb-route-extensions/import new file mode 100644 index 000000000..e7a054517 --- /dev/null +++ b/gcloud/service-extensions/lb-route-extensions/import @@ -0,0 +1,86 @@ +NAME + gcloud service-extensions lb-route-extensions import - import an + LbRouteExtension resource + +SYNOPSIS + gcloud service-extensions lb-route-extensions import + (LB_ROUTE_EXTENSION : --location=LOCATION) [--async] [--source=SOURCE] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import an LbRouteExtension resource defined in a YAML file. + +EXAMPLES + To import an LbRouteExtension resource named my-route-extension from a YAML + file in us-central1, run: + + $ gcloud service-extensions lb-route-extensions import \ + my-route-extension --source=my-route-extension.yaml \ + --location=us-central1 + +POSITIONAL ARGUMENTS + LbRouteExtension resource - The ID of the new or updated LbRouteExtension + resource. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument lb_route_extension 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. + + LB_ROUTE_EXTENSION + ID of the LbRouteExtension or fully qualified identifier for the + LbRouteExtension. + + To set the lb_route_extension attribute: + ▸ provide the argument lb_route_extension on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Cloud region in which the resource is located. + + To set the location attribute: + ▸ provide the argument lb_route_extension on the command line with + a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-route-extensions import + + $ gcloud beta service-extensions lb-route-extensions import + diff --git a/gcloud/alpha/apphub/discovered-services/find b/gcloud/service-extensions/lb-route-extensions/list similarity index 70% rename from gcloud/alpha/apphub/discovered-services/find rename to gcloud/service-extensions/lb-route-extensions/list index 880489828..eccd36d66 100644 --- a/gcloud/alpha/apphub/discovered-services/find +++ b/gcloud/service-extensions/lb-route-extensions/list @@ -1,32 +1,33 @@ NAME - gcloud alpha apphub discovered-services find - find Apphub discovered - services that could be added to an application + gcloud service-extensions lb-route-extensions list - list LbRouteExtension + resources SYNOPSIS - gcloud alpha apphub discovered-services find --location=LOCATION + gcloud service-extensions lb-route-extensions list --location=LOCATION [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Find Apphub discovered services that could be added to an - application. + List all LbRouteExtension resources in the specified location of the + current project. EXAMPLES - To find DiscoveredServices that could be added to an application in - location us-east1, run: + To list all LbRouteExtension resources in the current project located in + us-central1 region run: - $ gcloud alpha apphub discovered-services find --location=us-east1 + $ gcloud service-extensions lb-route-extensions list \ + --location=us-central1 REQUIRED FLAGS - Location resource - Location. This represents a Cloud resource. (NOTE) - Some attributes are not given arguments in this group but can be set in - other ways. + Location resource - The parent 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; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. + ◆ set the property core/project; + ◆ provide the argument --project on the command line. This must be specified. @@ -76,9 +77,14 @@ GCLOUD WIDE FLAGS 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. +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-route-extensions list + + $ gcloud beta service-extensions lb-route-extensions list diff --git a/gcloud/service-extensions/lb-traffic-extensions/delete b/gcloud/service-extensions/lb-traffic-extensions/delete new file mode 100644 index 000000000..a1c901a4a --- /dev/null +++ b/gcloud/service-extensions/lb-traffic-extensions/delete @@ -0,0 +1,75 @@ +NAME + gcloud service-extensions lb-traffic-extensions delete - delete an + LbTrafficExtension resource + +SYNOPSIS + gcloud service-extensions lb-traffic-extensions delete + (LB_TRAFFIC_EXTENSION : --location=LOCATION) [--async] + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Delete the specified LbTrafficExtension resource. + +EXAMPLES + To delete an LbTrafficExtension resource named my-traffic-extension in + us-central1, run: + + $ gcloud service-extensions lb-traffic-extensions delete \ + my-traffic-extension --location=us-central1 + +POSITIONAL ARGUMENTS + LbTrafficExtension resource - The ID of the deleted LbTrafficExtension + resource. The arguments in this group can be used to specify the + attributes of this resource. (NOTE) Some attributes are not given + arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument lb_traffic_extension 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. + + LB_TRAFFIC_EXTENSION + ID of the LbTrafficExtension or fully qualified identifier for the + LbTrafficExtension. + + To set the lb_traffic_extension attribute: + ▸ provide the argument lb_traffic_extension on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Cloud region in which the resource is located. + + To set the location attribute: + ▸ provide the argument lb_traffic_extension on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-traffic-extensions delete + + $ gcloud beta service-extensions lb-traffic-extensions delete + diff --git a/gcloud/service-extensions/lb-traffic-extensions/describe b/gcloud/service-extensions/lb-traffic-extensions/describe new file mode 100644 index 000000000..ddfe8f8d4 --- /dev/null +++ b/gcloud/service-extensions/lb-traffic-extensions/describe @@ -0,0 +1,69 @@ +NAME + gcloud service-extensions lb-traffic-extensions describe - describe an + LbTrafficExtension resource + +SYNOPSIS + gcloud service-extensions lb-traffic-extensions describe + (LB_TRAFFIC_EXTENSION : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Show details of an LbTrafficExtension resource. + +EXAMPLES + To show details about the LbTrafficExtension resource named + my-traffic-extension located in us-central1. + + $ gcloud service-extensions lb-traffic-extensions describe \ + my-traffic-extension --location=us-central1 + +POSITIONAL ARGUMENTS + LbTrafficExtension resource - The ID of the LbTrafficExtension resource. + The arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. + + To set the project attribute: + ◆ provide the argument lb_traffic_extension 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. + + LB_TRAFFIC_EXTENSION + ID of the LbTrafficExtension or fully qualified identifier for the + LbTrafficExtension. + + To set the lb_traffic_extension attribute: + ▸ provide the argument lb_traffic_extension on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Cloud region in which the resource is located. + + To set the location attribute: + ▸ provide the argument lb_traffic_extension on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-traffic-extensions describe + + $ gcloud beta service-extensions lb-traffic-extensions describe + diff --git a/gcloud/service-extensions/lb-traffic-extensions/help b/gcloud/service-extensions/lb-traffic-extensions/help new file mode 100644 index 000000000..da348c1f8 --- /dev/null +++ b/gcloud/service-extensions/lb-traffic-extensions/help @@ -0,0 +1,38 @@ +NAME + gcloud service-extensions lb-traffic-extensions - manage Service Extensions + LbTrafficExtension resources + +SYNOPSIS + gcloud service-extensions lb-traffic-extensions COMMAND + [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Manage Service Extensions LbTrafficExtension resources. + +GCLOUD WIDE FLAGS + These flags are available to all commands: --help. + + Run $ gcloud help for details. + +COMMANDS + COMMAND is one of the following: + + delete + Delete an LbTrafficExtension resource. + + describe + Describe an LbTrafficExtension resource. + + import + Import an LbTrafficExtension resource. + + list + List LbTrafficExtension resources. + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-traffic-extensions + + $ gcloud beta service-extensions lb-traffic-extensions + diff --git a/gcloud/service-extensions/lb-traffic-extensions/import b/gcloud/service-extensions/lb-traffic-extensions/import new file mode 100644 index 000000000..52efb3630 --- /dev/null +++ b/gcloud/service-extensions/lb-traffic-extensions/import @@ -0,0 +1,86 @@ +NAME + gcloud service-extensions lb-traffic-extensions import - import an + LbTrafficExtension resource + +SYNOPSIS + gcloud service-extensions lb-traffic-extensions import + (LB_TRAFFIC_EXTENSION : --location=LOCATION) [--async] + [--source=SOURCE] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Import an LbTrafficExtension resource defined in a YAML file. + +EXAMPLES + To import an LbTrafficExtension resource named my-traffic-extension from a + YAML file in us-central1, run: + + $ gcloud service-extensions lb-traffic-extensions import \ + my-traffic-extension --source=my-traffic-extension.yaml \ + --location=us-central1 + +POSITIONAL ARGUMENTS + LbTrafficExtension resource - The ID of the new or updated + LbTrafficExtension resource. The arguments in this group can be used to + specify the attributes of this resource. (NOTE) Some attributes are not + given arguments in this group but can be set in other ways. + + To set the project attribute: + ◆ provide the argument lb_traffic_extension 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. + + LB_TRAFFIC_EXTENSION + ID of the LbTrafficExtension or fully qualified identifier for the + LbTrafficExtension. + + To set the lb_traffic_extension attribute: + ▸ provide the argument lb_traffic_extension on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Cloud region in which the resource is located. + + To set the location attribute: + ▸ provide the argument lb_traffic_extension on the command line + with a fully specified name; + ▸ provide the argument --location on the command line. + +FLAGS + --async + Return immediately, without waiting for the operation in progress to + complete. + + --source=SOURCE + Path to a YAML file containing the configuration export data. The YAML + file must not contain any output-only fields. Alternatively, you may + omit this flag to read from standard input. For a schema describing the + export/import format, see: $CLOUDSDKROOT/lib/googlecloudsdk/schemas/... + + $CLOUDSDKROOT is can be obtained with the following command: + + $ gcloud info --format='value(installation.sdk_root)' + +GCLOUD WIDE FLAGS + These flags are available to all commands: --access-token-file, --account, + --billing-project, --configuration, --flags-file, --flatten, --format, + --help, --impersonate-service-account, --log-http, --project, --quiet, + --trace-token, --user-output-enabled, --verbosity. + + Run $ gcloud help for details. + +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-traffic-extensions import + + $ gcloud beta service-extensions lb-traffic-extensions import + diff --git a/gcloud/alpha/apphub/discovered-workloads/find b/gcloud/service-extensions/lb-traffic-extensions/list similarity index 69% rename from gcloud/alpha/apphub/discovered-workloads/find rename to gcloud/service-extensions/lb-traffic-extensions/list index dee1262bb..7ec428139 100644 --- a/gcloud/alpha/apphub/discovered-workloads/find +++ b/gcloud/service-extensions/lb-traffic-extensions/list @@ -1,32 +1,33 @@ NAME - gcloud alpha apphub discovered-workloads find - find discovered Apphub - workloads that could be added to an application + gcloud service-extensions lb-traffic-extensions list - list + LbTrafficExtension resources SYNOPSIS - gcloud alpha apphub discovered-workloads find --location=LOCATION + gcloud service-extensions lb-traffic-extensions list --location=LOCATION [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION - (ALPHA) Find discovered Apphub workloads that could be added to an - application. + List all LbTrafficExtension resources in the specified location of the + current project. EXAMPLES - To find DiscoveredWorkloads that could be added to an application location - us-east1, run: + To list all LbTrafficExtension resources in the current project located in + us-central1 region, run: - $ gcloud alpha apphub discovered-workloads find --location=us-east1 + $ gcloud service-extensions lb-traffic-extensions list \ + --location=us-central1 REQUIRED FLAGS - Location resource - Location. This represents a Cloud resource. (NOTE) - Some attributes are not given arguments in this group but can be set in - other ways. + Location resource - The parent 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; - ◆ provide the argument --project on the command line; - ◆ set the property core/project. + ◆ set the property core/project; + ◆ provide the argument --project on the command line. This must be specified. @@ -76,9 +77,14 @@ GCLOUD WIDE FLAGS 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. +API REFERENCE + This command uses the networkservices/v1 API. The full documentation for + this API can be found at: https://cloud.google.com/networking + +NOTES + These variants are also available: + + $ gcloud alpha service-extensions lb-traffic-extensions list + + $ gcloud beta service-extensions lb-traffic-extensions list diff --git a/gcloud/sql/operations/list b/gcloud/sql/operations/list index 26c5fd28a..d31dab7b0 100644 --- a/gcloud/sql/operations/list +++ b/gcloud/sql/operations/list @@ -3,7 +3,7 @@ NAME Cloud SQL instance SYNOPSIS - gcloud sql operations list --instance=INSTANCE, -i INSTANCE + gcloud sql operations list [--instance=INSTANCE, -i INSTANCE] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] @@ -25,7 +25,7 @@ EXAMPLES $ gcloud sql operations list --instance=prod-instance --page-size=10 -REQUIRED FLAGS +FLAGS --instance=INSTANCE, -i INSTANCE Cloud SQL instance ID. diff --git a/gcloud/storage/restore b/gcloud/storage/restore index 894963b1d..abf8d8fec 100644 --- a/gcloud/storage/restore +++ b/gcloud/storage/restore @@ -15,21 +15,29 @@ DESCRIPTION $ gcloud storage restore url... EXAMPLES - Restore specific version of object in a bucket. Note: Generation number is - required. + Restore latest soft-deleted version of object in a bucket. + + $ gcloud storage restore gs://bucket/file1.txt + + Restore a specific soft-deleted version of object in a bucket by specifying + the generation. $ gcloud storage restore gs://bucket/file1.txt#123 - Restore two objects in a bucket: + Restore all soft-deleted versions of object in a bucket. - $ gcloud storage restore gs://bucket/file1.txt#123 \ + $ gcloud storage restore gs://bucket/file1.txt --all-versions + + Restore several objects in a bucket (with or without generation): + + $ gcloud storage restore gs://bucket/file1.txt \ gs://bucket/file2.txt#456 - Restore all text objects in a bucket: + Restore the latest soft-deleted version of all text objects in a bucket: $ gcloud storage restore gs://bucket/**.txt - Read list of files to restore from stdin: + Restore a list of objects read from stdin (with or without generation): $ cat list-of-files.txt | gcloud storage restore \ --read-paths-from-stdin diff --git a/gcloud/vmware/network-peerings/create b/gcloud/vmware/network-peerings/create index 1e6e7bfe4..4457c16b5 100644 --- a/gcloud/vmware/network-peerings/create +++ b/gcloud/vmware/network-peerings/create @@ -3,13 +3,15 @@ NAME peering SYNOPSIS - gcloud vmware network-peerings create NETWORK_PEERING - --peer-network=PEER_NETWORK --peer-network-type=PEER_NETWORK_TYPE + gcloud vmware network-peerings create + (NETWORK_PEERING : --location=LOCATION) --peer-network=PEER_NETWORK + --peer-network-type=PEER_NETWORK_TYPE --vmware-engine-network=VMWARE_ENGINE_NETWORK [--async] [--description=DESCRIPTION] [--no-exchange-subnet-routes] [--no-export-custom-routes] [--no-export-custom-routes-with-public-ip] [--no-import-custom-routes] [--no-import-custom-routes-with-public-ip] [--peer-mtu=PEER_MTU] [--peer-project=PEER_PROJECT] + [--vmware-engine-network-project=VMWARE_ENGINE_NETWORK_PROJECT] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -33,9 +35,10 @@ EXAMPLES and location is taken as global. POSITIONAL ARGUMENTS - VMware Engine VPC network peering resource - network_peering. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. + VMware Engine VPC network peering resource - network_peering. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: ◆ provide the argument network_peering on the command line with a fully @@ -52,6 +55,18 @@ POSITIONAL ARGUMENTS To set the network-peering attribute: ▸ provide the argument network_peering on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. + + To set the location attribute: + ▸ provide the argument network_peering on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default). + REQUIRED FLAGS --peer-network=PEER_NETWORK ID of the network to peer with the VMware Engine network. The peer @@ -126,6 +141,10 @@ OPTIONAL FLAGS Project ID or project number of the peer network. Use this flag when the peer network is in another project. + --vmware-engine-network-project=VMWARE_ENGINE_NETWORK_PROJECT + Project of the VMware Engine network to attach the new peering to. Use + this flag when the VMware Engine network is in another project. + 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/vmware/network-peerings/delete b/gcloud/vmware/network-peerings/delete index 53838c5b6..4f6561b18 100644 --- a/gcloud/vmware/network-peerings/delete +++ b/gcloud/vmware/network-peerings/delete @@ -3,7 +3,8 @@ NAME VPC network peering SYNOPSIS - gcloud vmware network-peerings delete NETWORK_PEERING [--async] + gcloud vmware network-peerings delete + (NETWORK_PEERING : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -20,9 +21,10 @@ EXAMPLES and location is taken as global. POSITIONAL ARGUMENTS - VMware Engine VPC network peering resource - network_peering. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. + VMware Engine VPC network peering resource - network_peering. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: ◆ provide the argument network_peering on the command line with a fully @@ -39,6 +41,18 @@ POSITIONAL ARGUMENTS To set the network-peering attribute: ▸ provide the argument network_peering on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. + + To set the location attribute: + ▸ provide the argument network_peering on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default). + FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/vmware/network-peerings/describe b/gcloud/vmware/network-peerings/describe index aa8cb7759..2c74fcc46 100644 --- a/gcloud/vmware/network-peerings/describe +++ b/gcloud/vmware/network-peerings/describe @@ -3,8 +3,8 @@ NAME Engine VPC network peering SYNOPSIS - gcloud vmware network-peerings describe NETWORK_PEERING - [GCLOUD_WIDE_FLAG ...] + gcloud vmware network-peerings describe + (NETWORK_PEERING : --location=LOCATION) [GCLOUD_WIDE_FLAG ...] DESCRIPTION Get information about a VPC network peering. @@ -18,9 +18,10 @@ EXAMPLES and location is taken as global. POSITIONAL ARGUMENTS - VMware Engine VPC network peering resource - network_peering. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. + VMware Engine VPC network peering resource - network_peering. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: ◆ provide the argument network_peering on the command line with a fully @@ -37,6 +38,18 @@ POSITIONAL ARGUMENTS To set the network-peering attribute: ▸ provide the argument network_peering on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. + + To set the location attribute: + ▸ provide the argument network_peering on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default). + GCLOUD WIDE FLAGS These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, diff --git a/gcloud/vmware/network-peerings/list b/gcloud/vmware/network-peerings/list index 876d3182f..e8cada610 100644 --- a/gcloud/vmware/network-peerings/list +++ b/gcloud/vmware/network-peerings/list @@ -28,8 +28,7 @@ FLAGS To set the project attribute: ◆ provide the argument --location on the command line with a fully specified name; - ◆ set location as 'global' (default) or a region with a fully specified - name; + ◆ set location as 'global' (default) with a fully specified name; ◆ set the property core/project; ◆ provide the argument --project on the command line. @@ -38,7 +37,7 @@ FLAGS To set the location attribute: ▸ provide the argument --location on the command line; - ▸ set location as 'global' (default) or a region. + ▸ set location as 'global' (default). LIST COMMAND FLAGS --filter=EXPRESSION diff --git a/gcloud/vmware/network-peerings/routes/list b/gcloud/vmware/network-peerings/routes/list index f63538bfa..82b51a545 100644 --- a/gcloud/vmware/network-peerings/routes/list +++ b/gcloud/vmware/network-peerings/routes/list @@ -4,9 +4,9 @@ NAME SYNOPSIS gcloud vmware network-peerings routes list - --network-peering=NETWORK_PEERING [--filter=EXPRESSION] [--limit=LIMIT] - [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri] - [GCLOUD_WIDE_FLAG ...] + (--network-peering=NETWORK_PEERING : --location=LOCATION) + [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] + [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...] DESCRIPTION List VPC network peering routes across all locations in your project. @@ -25,9 +25,10 @@ EXAMPLES In above examples, the location is taken as global. REQUIRED FLAGS - VMware Engine VPC network peering resource - network_peering. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. + VMware Engine VPC network peering resource - network_peering. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: ◆ provide the argument --network-peering on the command line with a @@ -44,6 +45,18 @@ REQUIRED FLAGS To set the network-peering attribute: ▸ provide the argument --network-peering on the command line. + This flag argument must be specified if any of the other arguments in + this group are specified. + + --location=LOCATION + The resource name of the location. + + To set the location attribute: + ▸ provide the argument --network-peering on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default). + LIST COMMAND FLAGS --filter=EXPRESSION Apply a Boolean filter EXPRESSION to each resource item to be listed. diff --git a/gcloud/vmware/network-peerings/update b/gcloud/vmware/network-peerings/update index 86553e94f..9e753f10c 100644 --- a/gcloud/vmware/network-peerings/update +++ b/gcloud/vmware/network-peerings/update @@ -3,7 +3,8 @@ NAME VPC network peering SYNOPSIS - gcloud vmware network-peerings update NETWORK_PEERING [--async] + gcloud vmware network-peerings update + (NETWORK_PEERING : --location=LOCATION) [--async] [--description=DESCRIPTION] [GCLOUD_WIDE_FLAG ...] DESCRIPTION @@ -20,9 +21,10 @@ EXAMPLES and location is taken as global. POSITIONAL ARGUMENTS - VMware Engine VPC network peering resource - network_peering. This - represents a Cloud resource. (NOTE) Some attributes are not given - arguments in this group but can be set in other ways. + VMware Engine VPC network peering resource - network_peering. The + arguments in this group can be used to specify the attributes of this + resource. (NOTE) Some attributes are not given arguments in this group but + can be set in other ways. To set the project attribute: ◆ provide the argument network_peering on the command line with a fully @@ -39,6 +41,18 @@ POSITIONAL ARGUMENTS To set the network-peering attribute: ▸ provide the argument network_peering on the command line. + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + The resource name of the location. + + To set the location attribute: + ▸ provide the argument network_peering on the command line with a + fully specified name; + ▸ provide the argument --location on the command line; + ▸ set location as 'global' (default). + FLAGS --async Return immediately, without waiting for the operation in progress to diff --git a/gcloud/vmware/private-clouds/logging-servers/create b/gcloud/vmware/private-clouds/logging-servers/create index c1293a6ea..25d84bd6f 100644 --- a/gcloud/vmware/private-clouds/logging-servers/create +++ b/gcloud/vmware/private-clouds/logging-servers/create @@ -80,7 +80,7 @@ REQUIRED FLAGS --protocol=PROTOCOL Defines possible protocols used to send logs to a logging server. - PROTOCOL must be one of: UDP, TCP. + PROTOCOL must be one of: UDP, TCP, TLS, SSL, RELP. --source-type=SOURCE_TYPE The type of component that produces logs that will be forwarded to this diff --git a/gcloud/vmware/private-clouds/logging-servers/update b/gcloud/vmware/private-clouds/logging-servers/update index 708a38a00..ceacab494 100644 --- a/gcloud/vmware/private-clouds/logging-servers/update +++ b/gcloud/vmware/private-clouds/logging-servers/update @@ -85,7 +85,7 @@ FLAGS --protocol=PROTOCOL Defines possible protocols used to send logs to a logging server. - PROTOCOL must be one of: UDP, TCP. + PROTOCOL must be one of: UDP, TCP, TLS, RELP, SSL. --source-type=SOURCE_TYPE The type of component that produces logs that will be forwarded to this diff --git a/gcloud/workbench/instances/help b/gcloud/workbench/instances/help index eb94c3d39..82acc6eac 100644 --- a/gcloud/workbench/instances/help +++ b/gcloud/workbench/instances/help @@ -45,6 +45,9 @@ COMMANDS reset Request for resetting instances. + resize-disk + Request for updating instances. + rollback Request for rolling back instances. diff --git a/gcloud/workbench/instances/resize-disk b/gcloud/workbench/instances/resize-disk new file mode 100644 index 000000000..740fd29a3 --- /dev/null +++ b/gcloud/workbench/instances/resize-disk @@ -0,0 +1,84 @@ +NAME + gcloud workbench instances resize-disk - request for updating instances + +SYNOPSIS + gcloud workbench instances resize-disk (INSTANCE : --location=LOCATION) + (--boot-disk-size=BOOT_DISK_SIZE | --data-disk-size=DATA_DISK_SIZE) + [--async] [GCLOUD_WIDE_FLAG ...] + +DESCRIPTION + Request for resizing the workbench instances disk. + +EXAMPLES + To increase the boot disk size for an instance, run: + + $ gcloud workbench instances resize-disk example-instance \ + --boot-disk-size=200 --location=us-central1-a + + To increase the data disk size for an instance, run: + + $ gcloud workbench instances resize-disk example-instance \ + --data-disk-size=200 --location=us-central1-a + +POSITIONAL ARGUMENTS + Instance resource - User-defined unique name of this instance. The + instance name must be 1 to 63 characters long and contain only lowercase + letters, numeric characters, and dashes. The first character must be a + lowercase letter and the last character cannot be a dash. The arguments in + this group can be used to specify the attributes of this resource. (NOTE) + Some attributes are not given arguments in this group but can be set in + other ways. + + To set the project attribute: + ◆ provide the argument instance on the command line with a fully + specified name; + ◆ provide the argument --project on the command line; + ◆ set the property core/project. + + This must be specified. + + INSTANCE + ID of the instance or fully qualified identifier for the instance. + + To set the instance attribute: + ▸ provide the argument instance on the command line. + + This positional argument must be specified if any of the other + arguments in this group are specified. + + --location=LOCATION + Google Cloud location of this environment + https://cloud.google.com/compute/docs/regions-zones/#locations. + + To set the location attribute: + ▸ provide the argument instance on the command line with a fully + specified name; + ▸ provide the argument --location on the command line; + ▸ set the property notebooks/location. + +REQUIRED FLAGS + Disk resizing configurations Amount needs to be greater than the existing + size. + + Exactly one of these must be specified: + + --boot-disk-size=BOOT_DISK_SIZE + Size of boot disk in GB attached to this instance, up to a maximum of + 64000 GB (64 TB). + + --data-disk-size=DATA_DISK_SIZE + Size of data disk in GB attached to this instance, up to a maximum of + 64000 GB (64 TB). + +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.